Inter-region explicit porosity source. More...

Inheritance diagram for interRegionExplicitPorositySource:

Collaboration diagram for interRegionExplicitPorositySource:

Public Member Functions
	TypeName ("interRegionExplicitPorositySource")
	Runtime type information. More...

	interRegionExplicitPorositySource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

virtual	~interRegionExplicitPorositySource ()
	Destructor. More...

virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
	Vector. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Vector. More...

virtual bool	read (const dictionary &dict)
	Read dictionary. More...

Public Member Functions inherited from interRegionOption
	TypeName ("interRegionOption")
	Runtime type information. More...

	interRegionOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from dictionary. More...

virtual	~interRegionOption ()
	Destructor. More...

const word &	nbrRegionName () const
	Return const access to the neighbour region name. More...

const meshToMesh &	meshInterp () const
	Return const access to the mapToMap pointer. More...

Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

autoPtr< option >	clone () const
	Return clone. More...

virtual	~option ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

bool	active () const
	Return const access to the source active flag. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

Switch &	active ()
	Return access to the source active flag. More...

virtual bool	isActive ()
	Is the source active? More...

virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list. More...

virtual void	checkApplied () const
	Check that the source has been applied. More...

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	correct (volScalarField &field)

virtual void	correct (volVectorField &field)

virtual void	correct (volSphericalTensorField &field)

virtual void	correct (volSymmTensorField &field)

virtual void	correct (volTensorField &field)

virtual void	writeHeader (Ostream &) const
	Write the source header information. More...

virtual void	writeFooter (Ostream &) const
	Write the source footer information. More...

virtual void	writeData (Ostream &) const
	Write the source properties. More...

Protected Member Functions
void	initialise ()
	Initialise. More...

Protected Member Functions inherited from interRegionOption
void	setMapper ()
	Set the mesh to mesh interpolation object. More...

Protected Attributes
autoPtr< porosityModel >	porosityPtr_
	Run-time selectable porosity model. More...

bool	firstIter_
	First iteration. More...

word	UName_
	Velocity field name, default = U. More...

word	muName_
	Dynamic viscosity field name (compressible case only) More...

Protected Attributes inherited from interRegionOption
bool	master_
	Master or slave region. More...

word	nbrRegionName_
	Name of the neighbour region to map. More...

autoPtr< meshToMesh >	meshInterpPtr_
	Mesh to mesh interpolation object. More...

Protected Attributes inherited from option
const word	name_
	Source name. More...

const word	modelType_
	Model type. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. More...

Switch	active_
	Source active flag. More...

wordList	fieldNames_
	Field names to apply source to - populated by derived models. More...

List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry. More...

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model. More...

Detailed Description

Inter-region explicit porosity source.

Sources described by, for example using the DarcyForchheimer model:

interRegionExplicitPorositySourceCoeffs
{
    type            DarcyForchheimer;
    DarcyForchheimerCoeffs
    {
        d   d [0 -2 0 0 0 0 0] (5e7 -1000 -1000);
        f   f [0 -1 0 0 0 0 0] (0 0 0);

        coordinateSystem
        {
            e1  (0.70710678 0.70710678 0);
            e2  (0 0 1);
        }
    }
}

Note: The porous region must be selected as a cellZone.

Source files

Definition at line 77 of file interRegionExplicitPorositySource.H.

Constructor & Destructor Documentation

◆ interRegionExplicitPorositySource()

interRegionExplicitPorositySource	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from components.

Definition at line 111 of file interRegionExplicitPorositySource.C.

References interRegionExplicitPorositySource::addSup().

Here is the call graph for this function:

◆ ~interRegionExplicitPorositySource()

virtual ~interRegionExplicitPorositySource ( )

inlinevirtual

Destructor.

Definition at line 139 of file interRegionExplicitPorositySource.H.

References interRegionExplicitPorositySource::addSup(), dict, interRegionExplicitPorositySource::read(), and rho.

Here is the call graph for this function:

Member Function Documentation

◆ initialise()

void initialise ( )

protected

Initialise.

Definition at line 50 of file interRegionExplicitPorositySource.C.

References Foam::abort(), polyMesh::cellZones(), ZoneMesh< ZoneType, MeshType >::clearAddressing(), polyMesh::faceNeighbour(), Foam::FatalError, FatalErrorInFunction, ZoneMesh< ZoneType, MeshType >::findZoneID(), objectRegistry::lookupObject(), porosityModel::New(), PtrList< T >::set(), PtrList< T >::setSize(), UPtrList< T >::size(), and fvMesh::time().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "interRegionExplicitPorositySource" )

Runtime type information.

◆ addSup() [1/2]

void addSup	(	fvMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Vector.

Reimplemented from option.

Definition at line 135 of file interRegionExplicitPorositySource.C.

References lduMatrix::diag(), fvMatrix< Type >::dimensions(), objectRegistry::lookupObject(), IOobject::NO_READ, IOobject::NO_WRITE, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), fvMatrix< Type >::psi(), List< T >::setSize(), List< T >::size(), fvMatrix< Type >::source(), fvMesh::time(), Time::timeName(), U, and Foam::Zero.

Referenced by interRegionExplicitPorositySource::interRegionExplicitPorositySource(), and interRegionExplicitPorositySource::~interRegionExplicitPorositySource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSup() [2/2]

void addSup	(	const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const label	fieldi
	)

virtual

Vector.

Reimplemented from option.

Definition at line 188 of file interRegionExplicitPorositySource.C.

References lduMatrix::diag(), Foam::dimDensity, fvMatrix< Type >::dimensions(), Foam::dimViscosity, objectRegistry::lookupObject(), Foam::constant::physicoChemical::mu, IOobject::NO_READ, IOobject::NO_WRITE, GeometricField< Type, PatchField, GeoMesh >::primitiveField(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), fvMatrix< Type >::psi(), List< T >::setSize(), List< T >::size(), fvMatrix< Type >::source(), fvMesh::time(), Time::timeName(), U, and Foam::Zero.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from interRegionOption.

Definition at line 288 of file interRegionExplicitPorositySource.C.

References interRegionOption::read().

Referenced by interRegionExplicitPorositySource::~interRegionExplicitPorositySource().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ porosityPtr_

autoPtr<porosityModel> porosityPtr_

protected

Run-time selectable porosity model.

Definition at line 87 of file interRegionExplicitPorositySource.H.

◆ firstIter_

bool firstIter_

protected

First iteration.

Definition at line 90 of file interRegionExplicitPorositySource.H.

◆ UName_

word UName_

protected

Velocity field name, default = U.

Definition at line 93 of file interRegionExplicitPorositySource.H.

◆ muName_

word muName_

protected

Dynamic viscosity field name (compressible case only)

default = thermo:mu

Definition at line 97 of file interRegionExplicitPorositySource.H.

The documentation for this class was generated from the following files:

src/fvOptions/sources/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.H
src/fvOptions/sources/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ interRegionExplicitPorositySource()

◆ ~interRegionExplicitPorositySource()

Member Function Documentation

◆ initialise()

◆ TypeName()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ read()

Member Data Documentation

◆ porosityPtr_

◆ firstIter_

◆ UName_

◆ muName_