This model applies the force exerted on the fluid by a porous media. More...

Inheritance diagram for porosityForce:

Collaboration diagram for porosityForce:

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

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

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

virtual	~porosityForce ()
	Destructor. More...

const porosityModel &	model () const
	Return the porosity model. More...

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

virtual void	addSup (const volVectorField &U, fvMatrix< vector > &eqn) const
	Add implicit contribution to momentum equation. More...

virtual void	addSup (const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Add implicit contribution to compressible momentum equation. More...

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, const volVectorField &U, fvMatrix< vector > &eqn) const
	Add implicit contribution to phase momentum equation. More...

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 porosityForce &)=delete
	Disallow default bitwise assignment. More...

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...

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an 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 > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. 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 > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. 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 > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. 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...

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

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

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

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

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) 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 > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) 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 > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) 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

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

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. 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 fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

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

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

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Detailed Description

This model applies the force exerted on the fluid by a porous media.

Usage

Example usage, here employing the Darcy-Forchheimer model:

porosityForceCoeffs
{
    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);
            }
        }
    }
}

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

Source files

Definition at line 83 of file porosityForce.H.

Constructor & Destructor Documentation

◆ porosityForce() [1/2]

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

Construct from components.

Definition at line 84 of file porosityForce.C.

◆ porosityForce() [2/2]

porosityForce ( const porosityForce & )

delete

Disallow default bitwise copy construction.

◆ ~porosityForce()

virtual ~porosityForce ( )

inlinevirtual

Destructor.

Definition at line 128 of file porosityForce.H.

Member Function Documentation

◆ TypeName()

TypeName ( "porosityForce" )

Runtime type information.

◆ model()

const porosityModel& model ( ) const

inline

Return the porosity model.

Definition at line 137 of file porosityForce.H.

Referenced by kEpsilonLopesdaCosta< BasicMomentumTransportModel >::setPorosityCoefficients().

Here is the caller graph for this function:

◆ 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 102 of file porosityForce.C.

◆ addSup() [1/3]

void addSup	(	const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Add implicit contribution to momentum equation.

Definition at line 108 of file porosityForce.C.

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

Here is the call graph for this function:

◆ addSup() [2/3]

void addSup	(	const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Add implicit contribution to compressible momentum equation.

Definition at line 120 of file porosityForce.C.

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

Here is the call graph for this function:

◆ addSup() [3/3]

void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		const volVectorField &	U,
		fvMatrix< vector > &	eqn
	)		const

virtual

Add implicit contribution to phase momentum equation.

Definition at line 133 of file porosityForce.C.

References alpha(), 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 147 of file porosityForce.C.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 154 of file porosityForce.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 160 of file porosityForce.C.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 166 of file porosityForce.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Definition at line 175 of file porosityForce.C.

References dict, and fvModel::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const porosityForce & )

delete

Disallow default bitwise assignment.

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

src/fvModels/general/porosityForce/porosityForce.H
src/fvModels/general/porosityForce/porosityForce.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ porosityForce() [1/2]

◆ porosityForce() [2/2]

◆ ~porosityForce()

Member Function Documentation

◆ TypeName()

◆ model()

◆ addSupFields()

◆ addSup() [1/3]

◆ addSup() [2/3]

◆ addSup() [3/3]

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()

◆ operator=()