Applies inter-region explicit porosity source. More...
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... | |
interRegionExplicitPorositySource (const interRegionExplicitPorositySource &)=delete | |
No copy construct. More... | |
void | operator= (const interRegionExplicitPorositySource &)=delete |
No copy assignment. More... | |
virtual | ~interRegionExplicitPorositySource ()=default |
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... | |
interRegionOption (const interRegionOption &)=delete | |
No copy construct. More... | |
void | operator= (const interRegionOption &)=delete |
No copy assignment. More... | |
virtual | ~interRegionOption ()=default |
Destructor. More... | |
const word & | nbrRegionName () const |
Return const access to the neighbour region name. More... | |
const meshToMesh & | meshInterp () 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< option > | clone () const |
Return clone. More... | |
virtual | ~option ()=default |
Destructor. More... | |
const word & | name () const noexcept |
Return const access to the source name. More... | |
const fvMesh & | mesh () const noexcept |
Return const access to the mesh database. More... | |
const dictionary & | coeffs () const noexcept |
Return dictionary. More... | |
bool | active () const noexcept |
True if source is active. More... | |
void | setApplied (const label fieldi) |
Set the applied flag to true for field index fieldi. More... | |
bool | active (const bool on) noexcept |
Change source active flag, return previous value. 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 | 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. 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 Member Functions inherited from option | |
void | resetApplied () |
Resize/reset applied flag list for all fieldNames_ entries. More... | |
Protected Attributes | |
autoPtr< porosityModel > | porosityPtr_ |
Run-time selectable porosity model. More... | |
bool | firstIter_ |
First iteration. More... | |
word | UName_ |
Name of operand velocity field. More... | |
word | muName_ |
Name of operand dynamic viscosity field (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< meshToMesh > | meshInterpPtr_ |
Mesh to mesh interpolation object. More... | |
Protected Attributes inherited from option | |
const word | name_ |
Source name. More... | |
const word | modelType_ |
Model type. More... | |
const fvMesh & | mesh_ |
Reference to the mesh database. More... | |
dictionary | dict_ |
Top level source dictionary. More... | |
dictionary | coeffs_ |
Dictionary containing source coefficients. 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... | |
bool | active_ |
Source active flag. More... | |
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. More... | |
Public Attributes inherited from option | |
bool | log |
Switch write log to Info. More... | |
Applies inter-region explicit porosity source.
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:
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); } } }
Definition at line 145 of file interRegionExplicitPorositySource.H.
interRegionExplicitPorositySource | ( | const word & | name, |
const word & | modelType, | ||
const dictionary & | dict, | ||
const fvMesh & | mesh | ||
) |
Construct from components.
Definition at line 107 of file interRegionExplicitPorositySource.C.
References option::resetApplied().
|
delete |
No copy construct.
|
virtualdefault |
Destructor.
|
protected |
Initialise.
Definition at line 46 of file interRegionExplicitPorositySource.C.
References Foam::abort(), ZoneMesh< ZoneType, MeshType >::clearAddressing(), option::coeffs_, Foam::FatalError, FatalErrorInFunction, ZoneMesh< ZoneType, MeshType >::findZoneID(), interRegionExplicitPorositySource::firstIter_, objectRegistry::lookupObject(), option::mesh_, option::name_, interRegionOption::nbrRegionName_, porosityModel::New(), interRegionExplicitPorositySource::porosityPtr_, PtrList< T >::set(), PtrList< T >::setSize(), UPtrList< T >::size(), and fvMesh::time().
TypeName | ( | "interRegionExplicitPorositySource" | ) |
Runtime type information.
|
delete |
No copy assignment.
Reimplemented from option.
Definition at line 131 of file interRegionExplicitPorositySource.C.
References lduMatrix::diag(), fvMatrix< Type >::dimensions(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), fvMatrix< Type >::psi(), List< T >::setSize(), UList< T >::size(), fvMatrix< Type >::source(), U, and Foam::Zero.
|
virtual |
Reimplemented from option.
Definition at line 184 of file interRegionExplicitPorositySource.C.
References lduMatrix::diag(), Foam::dimDensity, fvMatrix< Type >::dimensions(), Foam::dimViscosity, Foam::constant::physicoChemical::mu, IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), fvMatrix< Type >::psi(), rho, List< T >::setSize(), UList< T >::size(), fvMatrix< Type >::source(), U, and Foam::Zero.
|
virtual |
Read dictionary.
Reimplemented from interRegionOption.
Definition at line 283 of file interRegionExplicitPorositySource.C.
References dict, and interRegionOption::read().
|
protected |
Run-time selectable porosity model.
Definition at line 156 of file interRegionExplicitPorositySource.H.
Referenced by interRegionExplicitPorositySource::initialise().
|
protected |
First iteration.
Definition at line 161 of file interRegionExplicitPorositySource.H.
Referenced by interRegionExplicitPorositySource::initialise().
|
protected |
Name of operand velocity field.
Definition at line 166 of file interRegionExplicitPorositySource.H.
|
protected |
Name of operand dynamic viscosity field (compressible case only)
Definition at line 171 of file interRegionExplicitPorositySource.H.