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

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

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

Public Member Functions

 TypeName ("interRegionOption")
 
 interRegionOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 
 interRegionOption (const interRegionOption &)=delete
 
void operator= (const interRegionOption &)=delete
 
virtual ~interRegionOption ()=default
 
const word & nbrRegionName () const
 
const meshToMesh & meshInterp () const
 
virtual bool read (const dictionary &dict)
 
- Public Member Functions inherited from option
 TypeName ("option")
 
 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)
 
autoPtr< option > clone () const
 
virtual ~option ()=default
 
const word & name () const noexcept
 
const fvMesh & mesh () const noexcept
 
const dictionary & coeffs () const noexcept
 
bool active () const noexcept
 
void setApplied (const label fieldi)
 
bool active (const bool on) noexcept
 
virtual bool isActive ()
 
virtual label applyToField (const word &fieldName) const
 
virtual void checkApplied () const
 
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
 
virtual void writeFooter (Ostream &) const
 
virtual void writeData (Ostream &) const
 

Protected Member Functions

void setMapper ()
 
- Protected Member Functions inherited from option
void resetApplied ()
 

Protected Attributes

bool master_
 
word nbrRegionName_
 
autoPtr< meshToMesh > meshInterpPtr_
 
- Protected Attributes inherited from option
const word name_
 
const word modelType_
 
const fvMesh & mesh_
 
dictionary dict_
 
dictionary coeffs_
 
wordList fieldNames_
 
List< bool > applied_
 
bool active_
 

Additional Inherited Members

- Static Public Member Functions inherited from option
static autoPtr< option > New (const word &name, const dictionary &dict, const fvMesh &mesh)
 
- Public Attributes inherited from option
bool log
 

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 103 of file interRegionOption.H.

Constructor & Destructor Documentation

◆ interRegionOption() [1/2]

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

Definition at line 93 of file interRegionOption.C.

◆ interRegionOption() [2/2]

interRegionOption ( const interRegionOption &  )
delete

◆ ~interRegionOption()

virtual ~interRegionOption ( )
virtualdefault

Member Function Documentation

◆ setMapper()

void setMapper ( )
protected

Definition at line 37 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().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "interRegionOption"  )

◆ operator=()

void operator= ( const interRegionOption &  )
delete

◆ nbrRegionName()

const Foam::word & nbrRegionName ( ) const
inline

Definition at line 25 of file interRegionOptionI.H.

References interRegionOption::nbrRegionName_.

◆ meshInterp()

const Foam::meshToMesh & meshInterp ( ) const
inline

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

Reimplemented from option.

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

Definition at line 120 of file interRegionOption.C.

References dict, and option::read().

Referenced by interRegionExplicitPorositySource::read(), and interRegionHeatTransferModel::read().

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

Member Data Documentation

◆ master_

bool master_
protected

Definition at line 112 of file interRegionOption.H.

Referenced by interRegionOption::setMapper().

◆ nbrRegionName_

word nbrRegionName_
protected

Definition at line 115 of file interRegionOption.H.

Referenced by interRegionExplicitPorositySource::initialise(), interRegionOption::nbrRegionName(), interRegionHeatTransferModel::nbrRegionName(), interRegionOption::setMapper(), and interRegionHeatTransferModel::setNbrModel().

◆ meshInterpPtr_

autoPtr<meshToMesh> meshInterpPtr_
protected

Definition at line 118 of file interRegionOption.H.

Referenced by interRegionOption::setMapper().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17