explicitPorositySource Class Reference

Applies an explicit porosity source to the momentum equation within a specified region. More...

#include <explicitPorositySource.H>

Inheritance diagram for explicitPorositySource:

Collaboration diagram for explicitPorositySource:

Public Member Functions
	TypeName ("explicitPorositySource")
	Runtime type information.
	explicitPorositySource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
	explicitPorositySource (const explicitPorositySource &)=delete
	No copy construct.
void	operator= (const explicitPorositySource &)=delete
	No copy assignment.
virtual	~explicitPorositySource ()=default
	Destructor.
const porosityModel &	model () const noexcept
	Access to the porosityModel.
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
	Add implicit contribution to momentum equation.
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Add implicit contribution to compressible momentum equation.
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Add implicit contribution to phase momentum equation.
virtual bool	read (const dictionary &dict)
	Read dictionary.
Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")
	Runtime type information.
	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
virtual	~cellSetOption ()=default
	Destructor.
scalar	timeStart () const noexcept
	Return const access to the time start.
scalar	duration () const noexcept
	Return const access to the duration.
bool	inTimeLimits (const scalar timeValue) const
	True if within time limits.
bool	useSubMesh () const noexcept
	True if sub-selection should be used.
selectionModeType	selectionMode () const noexcept
	Return the cell selection mode.
const wordRes &	selectionNames () const noexcept
	Return const access to the selection names (set or zone selection).
const wordRe &	zoneName () const
	Return const access to the first set/zone name.
scalar	V () const noexcept
	Return const access to the total cell volume.
const labelList &	cells () const noexcept
	Return const access to the cell selection.
bool	isSelectionUpdated () const noexcept
	Return flag for selection updates.
scalar	timeStart (scalar val) noexcept
	Adjust the time start, return the old value.
scalar	duration (scalar val) noexcept
	Adjust the duration, return the old value.
virtual bool	isActive ()
	Is the source active?
const word &	cellSetName () const
	The name of the cell set/zone [as a word] for "cellSet" / "cellZone" selection modes).
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	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.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
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< 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	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &field)
virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Protected Attributes
autoPtr< porosityModel >	porosityPtr_
	Run-time selectable porosity model.
Protected Attributes inherited from cellSetOption
selectionModeType	selectionMode_
	Cell selection mode.
bool	updateSelection_
	Flag to enable dictionary-based updates of selections.
scalar	timeStart_
	Start time of fvOption.
scalar	duration_
	Duration of fvOption execution starting from timeStart.
wordRes	selectionNames_
	Face selection names (for set or zone selections).
List< point >	points_
	List of points for "points" selectionMode.
PtrList< Function1< point > >	movingPoints_
	List of points for "movingPoints" selectionMode.
dictionary	geometricSelection_
	Dictionary entries for "geometric" (topoSetCellSource) selection.
labelList	cells_
	Set of cells to apply source to.
scalar	V_
	Sum of cell volumes.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType : char {   smAll , smCellSet , smCellZone , smPoints ,   smMovingPoints , smGeometric , smCellType }
	Enumeration for selection mode types. More...
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.
Public Attributes inherited from option
bool	log
	Switch write log to Info.
Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names.
Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set cell selection name or points selection from dictionary input.
void	setCellSelection ()
	Set the cell selection based on user input selection mode.
void	setVol ()
	Recalculate the volume.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.

Detailed Description

Applies an explicit porosity source to the momentum equation within a specified region.

Sources applied to:

  U         | Velocity                                   [m/s]

Required fields:

  U         | Velocity                                   [m/s]

Usage

Minimal example by using constant/fvOptions:

explicitPorositySource1
{
    // Mandatory entries (unmodifiable)
    type                 <porosityModelName>;

    <porosityModelName>Coeffs
    {
        // Optional entries (runtime modifiable)
        UNames          (<Uname1> <Uname2> ... <UnameN>);

        // Conditional optional entries (runtime modifiable)

            // when the entry "UNames" is not present
            U           U;

        // Mandatory/Optional (inherited) entries
        ...
    }

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
type	Type name: <porosityModelName>	word	yes	-
UNames	Names of operand velocity fields	wordList	no	-
U	Name of operand velocity field	word	no	U

The inherited entries are elaborated in:

• fvOption.H
• cellSetOption.H

Example usage, here employing the Darcy-Forchheimer model:

    explicitPorositySourceCoeffs
    {
        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
            {
                origin  (0 0 0);
                e1      (0.70710678 0.70710678 0);
                e2      (0 0 1);
            }
        }
    }

Note

• The porous region must be selected as a cellZone.

See also

• Foam::porosityModel

Source files

• explicitPorositySource.H
• explicitPorositySource.C

Definition at line 156 of file explicitPorositySource.H.

Constructor & Destructor Documentation

explicitPorositySource() [1/2]

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

Construct from components.

Definition at line 42 of file explicitPorositySource.C.

References cellSetOption::cellSetOption(), option::coeffs_, dict, option::mesh(), option::mesh_, option::name(), option::name_, porosityModel::New(), porosityPtr_, read(), and cellSetOption::zoneName().

Referenced by explicitPorositySource(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

explicitPorositySource() [2/2]

explicitPorositySource ( const explicitPorositySource & )

delete

No copy construct.

References explicitPorositySource().

Here is the call graph for this function:

~explicitPorositySource()

virtual ~explicitPorositySource ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"explicitPorositySource"

)

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

operator=()

void operator= ( const explicitPorositySource & )

delete

No copy assignment.

References explicitPorositySource().

Here is the call graph for this function:

model()

const porosityModel & model ( ) const

inlinenoexcept

Access to the porosityModel.

Definition at line 213 of file explicitPorositySource.H.

References Foam::noexcept, and porosityPtr_.

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

Here is the caller graph for this function:

addSup() [1/3]

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

virtual

Add implicit contribution to momentum equation.

Reimplemented from option.

Definition at line 61 of file explicitPorositySource.C.

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

Here is the call graph for this function:

addSup() [2/3]

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

virtual

Add implicit contribution to compressible momentum equation.

Reimplemented from option.

Definition at line 73 of file explicitPorositySource.C.

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

Here is the call graph for this function:

addSup() [3/3]

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

virtual

Add implicit contribution to phase momentum equation.

Reimplemented from option.

Definition at line 86 of file explicitPorositySource.C.

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

Here is the call graph for this function:

read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from cellSetOption.

Definition at line 100 of file explicitPorositySource.C.

References option::coeffs_, dict, option::fieldNames_, cellSetOption::read(), and option::resetApplied().

Referenced by explicitPorositySource().

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 167 of file explicitPorositySource.H.

Referenced by addSup(), addSup(), addSup(), explicitPorositySource(), and model().

---

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

• src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.H
• src/fvOptions/sources/derived/explicitPorositySource/explicitPorositySource.C