Applies inter-region explicit porosity source. More...

#include <interRegionExplicitPorositySource.H>

Inheritance diagram for interRegionExplicitPorositySource:

Collaboration diagram for interRegionExplicitPorositySource:

[legend]

Public Member Functions
	TypeName ("interRegionExplicitPorositySource")
	Runtime type information.
	interRegionExplicitPorositySource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
	interRegionExplicitPorositySource (const interRegionExplicitPorositySource &)=delete
	No copy construct.
void	operator= (const interRegionExplicitPorositySource &)=delete
	No copy assignment.
virtual	~interRegionExplicitPorositySource ()=default
	Destructor.
virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)
	Vector.
virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
	Vector.
virtual bool	read (const dictionary &dict)
	Read dictionary.
Public Member Functions inherited from interRegionOption
	TypeName ("interRegionOption")
	Runtime type information.
	interRegionOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from dictionary.
	interRegionOption (const interRegionOption &)=delete
	No copy construct.
void	operator= (const interRegionOption &)=delete
	No copy assignment.
virtual	~interRegionOption ()=default
	Destructor.
const word &	nbrRegionName () const
	Return const access to the neighbour region name.
const meshToMesh &	meshInterp () const
	Return const access to the mapToMap pointer.
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 bool	isActive ()
	Is the source active?
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< 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	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 Member Functions
void	initialise ()
	Initialise.
Protected Member Functions inherited from interRegionOption
void	setMapper ()
	Set the mesh to mesh interpolation object.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.

Protected Attributes
autoPtr< porosityModel >	porosityPtr_
	Run-time selectable porosity model.
bool	firstIter_
	First iteration.
word	UName_
	Name of operand velocity field.
word	muName_
	Name of operand dynamic viscosity field (compressible case only).
Protected Attributes inherited from interRegionOption
bool	master_
	Master or slave region.
word	nbrRegionName_
	Name of the neighbour region to map.
autoPtr< meshToMesh >	meshInterpPtr_
	Mesh to mesh interpolation object.
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
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.

Detailed Description

Applies inter-region explicit porosity source.

Usage

Minimal example by using constant/fvOptions:

interRegionExplicitPorositySource1
{
    // Mandatory entries (unmodifiable)
    type                 interRegionExplicitPorositySource;

    interRegionExplicitPorositySourceCoeffs
    {
        // Mandatory entries (unmodifiable)
        type     <porosityModel>;

        // Optional entries (runtime modifiable)
        U        U;
        mu       thermo:mu;
    }

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

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: interRegionExplicitPorositySource	word	yes	-
`type`	Name of porosity model	word	yes	-
`U`	Name of operand velocity field	word	no	U
`mu`	Name of operand dynamic viscosity field	word	no	thermo:mu

The inherited entries are elaborated in:

interRegionOption.H

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
            {
                origin  (0 0 0);
                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 145 of file interRegionExplicitPorositySource.H.

Constructor & Destructor Documentation

◆ interRegionExplicitPorositySource() [1/2]

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

Construct from components.

Definition at line 106 of file interRegionExplicitPorositySource.C.

References option::active_, option::coeffs_, dict, option::fieldNames_, firstIter_, interRegionOption::interRegionOption(), option::mesh(), muName_, option::name(), porosityPtr_, option::resetApplied(), and UName_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interRegionExplicitPorositySource() [2/2]

interRegionExplicitPorositySource ( const interRegionExplicitPorositySource & )

delete

No copy construct.

References interRegionExplicitPorositySource().

Here is the call graph for this function:

◆ ~interRegionExplicitPorositySource()

virtual ~interRegionExplicitPorositySource ( )

virtualdefault

Destructor.

References dict, and rho.

Member Function Documentation

◆ initialise()

void initialise ( )

protected

Initialise.

Definition at line 46 of file interRegionExplicitPorositySource.C.

References Foam::abort(), ZoneMesh< ZoneType, MeshType >::clearAddressing(), option::coeffs_, Foam::FatalError, FatalErrorInFunction, firstIter_, option::mesh_, option::name_, interRegionOption::nbrRegionName_, porosityModel::New(), porosityPtr_, PtrList< T >::set(), PtrList< T >::setSize(), and UPtrList< T >::size().

Referenced by addSup(), and addSup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "interRegionExplicitPorositySource" )

Runtime type information.

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

Here is the call graph for this function:

◆ operator=()

void operator= ( const interRegionExplicitPorositySource & )

delete

No copy assignment.

References interRegionExplicitPorositySource().

Here is the call graph for this function:

◆ addSup() [1/2]

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

virtual

Vector.

Reimplemented from option.

Definition at line 130 of file interRegionExplicitPorositySource.C.

References lduMatrix::diag(), fvMatrix< Type >::dimensions(), initialise(), option::mesh_, interRegionOption::meshInterp(), option::name_, interRegionOption::nbrRegionName_, GeometricField< vector, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, porosityPtr_, fvMatrix< Type >::psi(), IOobject::scopedName(), List< T >::setSize(), UList< T >::size(), fvMatrix< Type >::source(), U, and Foam::Zero.

Here is the call 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 178 of file interRegionExplicitPorositySource.C.

References lduMatrix::diag(), Foam::dimDensity, fvMatrix< Type >::dimensions(), Foam::dimViscosity, initialise(), option::mesh_, interRegionOption::meshInterp(), mu, muName_, option::name_, interRegionOption::nbrRegionName_, GeometricField< scalar, fvPatchField, volMesh >::New(), GeometricField< vector, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, porosityPtr_, fvMatrix< Type >::psi(), rho, IOobject::scopedName(), List< T >::setSize(), UList< T >::size(), fvMatrix< Type >::source(), 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 263 of file interRegionExplicitPorositySource.C.

References option::coeffs_, dict, muName_, interRegionOption::read(), and UName_.

Here is the call graph for this function:

Member Data Documentation

◆ porosityPtr_

autoPtr<porosityModel> porosityPtr_

protected

Run-time selectable porosity model.

Definition at line 156 of file interRegionExplicitPorositySource.H.

Referenced by addSup(), addSup(), initialise(), and interRegionExplicitPorositySource().

◆ firstIter_

bool firstIter_

protected

First iteration.

Definition at line 161 of file interRegionExplicitPorositySource.H.

Referenced by initialise(), and interRegionExplicitPorositySource().

◆ UName_

word UName_

protected

Name of operand velocity field.

Definition at line 166 of file interRegionExplicitPorositySource.H.

Referenced by interRegionExplicitPorositySource(), and read().

◆ muName_

word muName_

protected

Name of operand dynamic viscosity field (compressible case only).

Definition at line 171 of file interRegionExplicitPorositySource.H.

Referenced by addSup(), interRegionExplicitPorositySource(), and read().

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() [1/2]

◆ interRegionExplicitPorositySource() [2/2]

◆ ~interRegionExplicitPorositySource()

Member Function Documentation

◆ initialise()

◆ TypeName()

◆ operator=()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ read()

Member Data Documentation

◆ porosityPtr_

◆ firstIter_

◆ UName_

◆ muName_