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

Base class for inter-region exchange. More...

Inheritance diagram for interRegionOption:
Inheritance graph
[legend]
Collaboration diagram for interRegionOption:
Collaboration graph
[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...
 
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...
 
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 ()
 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< 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 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 setMapper ()
 Set the mesh to mesh interpolation object. 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...
 
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

Base class for inter-region exchange.

Definition at line 51 of file interRegionOption.H.

Constructor & Destructor Documentation

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

Construct from dictionary.

Definition at line 90 of file interRegionOption.C.

Referenced by interRegionOption::setMapper().

Here is the caller graph for this function:

~interRegionOption ( )
virtual

Destructor.

Definition at line 117 of file interRegionOption.C.

Member Function Documentation

void setMapper ( )
protected
TypeName ( "interRegionOption"  )

Runtime type information.

const Foam::word & nbrRegionName ( ) const
inline

Return const access to the neighbour region name.

Definition at line 29 of file interRegionOptionI.H.

References interRegionOption::nbrRegionName_.

const Foam::meshToMesh & meshInterp ( ) const
inline

Return const access to the mapToMap pointer.

Definition at line 36 of file interRegionOptionI.H.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and interRegionOption::meshInterpPtr_.

Here is the call graph for this function:

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from option.

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

Definition at line 30 of file interRegionOptionIO.C.

References 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

bool master_
protected

Master or slave region.

Definition at line 60 of file interRegionOption.H.

word nbrRegionName_
protected

Name of the neighbour region to map.

Definition at line 63 of file interRegionOption.H.

Referenced by interRegionOption::nbrRegionName(), and interRegionHeatTransferModel::nbrRegionName().

autoPtr<meshToMesh> meshInterpPtr_
protected

Mesh to mesh interpolation object.

Definition at line 66 of file interRegionOption.H.

Referenced by interRegionOption::meshInterp(), and interRegionHeatTransferModel::meshInterp().


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