Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
interRegionExplicitPorositySource Class Reference

Inter-region explicit porosity source. More...

Inheritance diagram for interRegionExplicitPorositySource:
Inheritance graph
[legend]
Collaboration diagram for interRegionExplicitPorositySource:
Collaboration graph
[legend]

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 wordnbrRegionName () const
 Return const access to the neighbour region name. More...
 
const meshToMeshmeshInterp () 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< optionclone () const
 Return clone. More...
 
virtual ~option ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () 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...
 
Switchactive ()
 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< porosityModelporosityPtr_
 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< meshToMeshmeshInterpPtr_
 Mesh to mesh interpolation object. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMeshmesh_
 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< optionNew (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 75 of file interRegionExplicitPorositySource.H.

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 114 of file interRegionExplicitPorositySource.C.

References interRegionExplicitPorositySource::addSup().

Here is the call graph for this function:

virtual ~interRegionExplicitPorositySource ( )
inlinevirtual

Destructor.

Definition at line 137 of file interRegionExplicitPorositySource.H.

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

Here is the call graph for this function:

Member Function Documentation

void initialise ( )
protected
TypeName ( "interRegionExplicitPorositySource"  )

Runtime type information.

void addSup ( fvMatrix< vector > &  eqn,
const label  fieldI 
)
virtual
void addSup ( const volScalarField rho,
fvMatrix< vector > &  eqn,
const label  fieldI 
)
virtual
bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from interRegionOption.

Definition at line 291 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

autoPtr<porosityModel> porosityPtr_
protected

Run-time selectable porosity model.

Definition at line 85 of file interRegionExplicitPorositySource.H.

bool firstIter_
protected

First iteration.

Definition at line 88 of file interRegionExplicitPorositySource.H.

word UName_
protected

Velocity field name, default = U.

Definition at line 91 of file interRegionExplicitPorositySource.H.

word muName_
protected

Dynamic viscosity field name (compressible case only)

default = thermo:mu

Definition at line 95 of file interRegionExplicitPorositySource.H.


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