interRegionOption Class Reference

Intermediate class for handling inter-region exchanges. More...

Inheritance diagram for interRegionOption:
[legend]
Collaboration diagram for interRegionOption:
[legend]

Public Member Functions

 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 wordnbrRegionName () const
 Return const access to the neighbour region name. More...
 
const meshToMeshmeshInterp () const
 Return const access to the mapToMap pointer. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. 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 ()=default
 Destructor. More...
 
const wordname () const noexcept
 Return const access to the source name. More...
 
const fvMeshmesh () const noexcept
 Return const access to the mesh database. More...
 
const dictionarycoeffs () 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< vector > &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< vector > &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 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 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...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 

Protected Member Functions

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

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...
 
wordList fieldNames_
 Field names to apply source to - populated by derived models. More...
 
List< boolapplied_
 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< optionNew (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...
 

Detailed Description

Intermediate class for handling inter-region exchanges.

Usage
Minimal example by using constant/fvOptions:
<userDefinedName1>
{
    // Mandatory/Optional (inherited) entries
    ...

    // Mandatory entries (unmodifiable)
    nbrRegion         <nbrRegionName>;

    // Optional entries (unmodifiable)
    master            true;

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

where the entries mean:

Property Description Type Reqd Dflt
nbrRegion Name of the neighbour region to map word yes -
master

Flag to determine whether master or

secondary region

bool no true

The inherited entries are elaborated in:

Source files

Definition at line 107 of file interRegionOption.H.

Constructor & Destructor Documentation

◆ interRegionOption() [1/2]

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

Construct from dictionary.

Definition at line 99 of file interRegionOption.C.

References option::active(), and interRegionOption::setMapper().

Here is the call graph for this function:

◆ interRegionOption() [2/2]

interRegionOption ( const interRegionOption )
delete

No copy construct.

◆ ~interRegionOption()

virtual ~interRegionOption ( )
virtualdefault

Destructor.

Member Function Documentation

◆ setMapper()

void setMapper ( )
protected

Set the mesh to mesh interpolation object.

Definition at line 44 of file interRegionOption.C.

References polyMesh::bounds(), option::coeffs_, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, meshToMesh::imCellVolumeWeight, Foam::indent(), Foam::Info, meshToMesh::interpolationMethodNames_, objectRegistry::lookupObject(), interRegionOption::master_, option::mesh_, interRegionOption::meshInterpPtr_, fvMesh::name(), interRegionOption::nbrRegionName_, Foam::nl, boundBox::overlaps(), meshToMesh::pmAABB, meshToMesh::procMapMethodNames_, and fvMesh::time().

Referenced by interRegionOption::interRegionOption().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "interRegionOption"  )

Runtime type information.

◆ operator=()

void operator= ( const interRegionOption )
delete

No copy assignment.

◆ nbrRegionName()

const Foam::word & nbrRegionName ( ) const
inline

Return const access to the neighbour region name.

Definition at line 32 of file interRegionOptionI.H.

References interRegionOption::nbrRegionName_.

◆ meshInterp()

const Foam::meshToMesh & meshInterp ( ) const
inline

Return const access to the mapToMap pointer.

Definition at line 39 of file interRegionOptionI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from option.

Reimplemented in interRegionExplicitPorositySource, constantHeatTransfer, interRegionHeatTransferModel, tabulatedHeatTransfer, tabulatedNTUHeatTransfer, and variableHeatTransfer.

Definition at line 127 of file interRegionOption.C.

References dict, and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Here is the call graph for this function:

Member Data Documentation

◆ master_

◆ nbrRegionName_

◆ meshInterpPtr_

autoPtr<meshToMesh> meshInterpPtr_
protected

Mesh to mesh interpolation object.

Definition at line 122 of file interRegionOption.H.

Referenced by interRegionOption::setMapper().


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