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 fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

	interRegionExplicitPorositySource (const interRegionExplicitPorositySource &)=delete
	Disallow default bitwise copy construction. More...

virtual	~interRegionExplicitPorositySource ()
	Destructor. More...

virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const word &fieldName) const

virtual bool	movePoints ()
	Update for mesh motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

void	operator= (const interRegionExplicitPorositySource &)=delete
	Disallow default bitwise assignment. More...

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

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

virtual	~interRegionModel ()
	Destructor. More...

bool	master () const
	Return whether the master region. More...

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

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

const cellsToCells &	interpolation () const
	Return const access to the interpolation engine. More...

template<class Type >
tmp< Field< Type > >	interpolate (const Field< Type > &field) const
	Interpolate field. More...

template<class Type >
void	interpolate (const Field< Type > &field, Field< Type > &result) const
	Interpolate field. More...

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const Field< Type > &field) const

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

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

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

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

virtual	~fvModel ()
	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...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP)
	Add a source term to an equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP)
	Add a source term to a compressible equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP)
	Add a source term to a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field, const word &fieldName) const
	Return source for an equation with a specified name. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field, const word &fieldName) const
	Return source for a compressible equation with a specified name. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const word &fieldName) const
	Return source for a phase equation with a specified name. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field, const word &fieldName) const
	Return source for an equation with a second time derivative. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual void	correct ()
	Correct the fvModel. More...

template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const VolField< Type > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)

template<class Type >
Foam::dimensionSet	sourceDims (const VolField< Type > &field, const dimensionSet &ds)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field, const word &fieldName) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field, const word &fieldName) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const word &fieldName) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field, const word &fieldName) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const VolField< Type > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
	Return the dimensions of the matrix of a source term. More...

template<class Type >
static dimensionSet	sourceDims (const VolField< Type > &field, const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Protected Member Functions inherited from interRegionModel
const interRegionModel &	nbrModel () const
	Get the neighbour interRegionModel. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const word &fieldName) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	source (const VolField< Type > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
	Return source for equation with specified name and dimensions. More...

Detailed Description

Inter-region explicit porosity source.

Usage

Example usage, here employing the Darcy-Forchheimer 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
        {
            type    cartesian;
            origin  (0 0 0);
            coordinateRotation
            {
                type    axesRotation;
                e1  (0.70710678 0.70710678 0);
                e2  (0 0 1);
            }
        }
    }
}

Source files

Definition at line 81 of file interRegionExplicitPorositySource.H.

Constructor & Destructor Documentation

◆ interRegionExplicitPorositySource() [1/2]

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

Construct from components.

Definition at line 59 of file interRegionExplicitPorositySource.C.

References Foam::abort(), polyMesh::cellZones(), MeshZones< ZoneType, MeshType >::clearAddressing(), fvModel::coeffs(), Foam::FatalError, FatalErrorInFunction, MeshZones< ZoneType, MeshType >::findZoneID(), forAll, interRegionModel::interpolate(), objectRegistry::lookupObject(), fvModel::mesh(), fvModel::name(), interRegionModel::nbrMesh(), interRegionModel::nbrRegionName(), primitiveMesh::nCells(), porosityModel::New(), PtrList< T >::set(), List< T >::setSize(), PtrList< T >::setSize(), UPtrList< T >::size(), and fvMesh::time().

Here is the call graph for this function:

◆ interRegionExplicitPorositySource() [2/2]

interRegionExplicitPorositySource ( const interRegionExplicitPorositySource & )

delete

Disallow default bitwise copy construction.

◆ ~interRegionExplicitPorositySource()

virtual ~interRegionExplicitPorositySource ( )

inlinevirtual

Destructor.

Definition at line 128 of file interRegionExplicitPorositySource.H.

Member Function Documentation

◆ TypeName()

TypeName ( "interRegionExplicitPorositySource" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the fvModel adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 147 of file interRegionExplicitPorositySource.C.

◆ addSup()

void addSup	(	const volScalarField &	rho,
		fvMatrix< vector > &	eqn,
		const word &	fieldName
	)		const

virtual

Definition at line 153 of file interRegionExplicitPorositySource.C.

References fvMatrix< Type >::dimensions(), and fvMatrix< Type >::psi().

Here is the call graph for this function:

◆ movePoints()

bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

Definition at line 166 of file interRegionExplicitPorositySource.C.

References NotImplemented.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 173 of file interRegionExplicitPorositySource.C.

References NotImplemented.

◆ mapMesh()

void mapMesh ( const polyMeshMap & )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 182 of file interRegionExplicitPorositySource.C.

References NotImplemented.

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 191 of file interRegionExplicitPorositySource.C.

References NotImplemented.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from interRegionModel.

Definition at line 200 of file interRegionExplicitPorositySource.C.

References dict, and interRegionModel::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const interRegionExplicitPorositySource & )

delete

Disallow default bitwise assignment.

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

src/fvModels/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.H
src/fvModels/interRegion/interRegionExplicitPorositySource/interRegionExplicitPorositySource.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ interRegionExplicitPorositySource() [1/2]

◆ interRegionExplicitPorositySource() [2/2]

◆ ~interRegionExplicitPorositySource()

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ addSup()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()

◆ operator=()