interRegionModel Class Reference

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

Inheritance diagram for interRegionModel:

Collaboration diagram for interRegionModel:

Public Member Functions
	TypeName ("interRegionModel")
	Runtime type information. More...
	interRegionModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from dictionary. More...
virtual	~interRegionModel ()
	Destructor. More...
bool	master () const
	Return whether the master region. More...
const word &	nbrRegionName () const
	Return const access to the neighbour region name. More...
const fvMesh &	nbrMesh () const
	Return const access to the neighbour mesh. More...
const cellsToCells &	interpolation () const
	Return const access to the interpolation engine. More...
template<class Type >
tmp< Field< Type > >	interpolate (const Field< Type > &field) const
	Interpolate field. More...
template<class Type >
void	interpolate (const Field< Type > &field, Field< Type > &result) const
	Interpolate field. More...
virtual bool	read (const dictionary &dict)
	Read dictionary. More...
template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolate (const Field< Type > &field) const
Public Member Functions inherited from fvModel
	TypeName ("fvModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))
	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...
autoPtr< fvModel >	clone () const
	Return clone. More...
virtual	~fvModel ()
	Destructor. More...
const word &	name () const
	Return const access to the source name. More...
const fvMesh &	mesh () const
	Return const access to the mesh database. More...
const dictionary &	coeffs () const
	Return dictionary. More...
virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...
virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...
virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...
virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...
template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...
template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...
template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...
template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...
virtual void	preUpdateMesh ()
	Prepare for mesh update. More...
virtual bool	movePoints ()=0
	Update for mesh motion. More...
virtual void	topoChange (const polyTopoChangeMap &)=0
	Update topology using the given map. More...
virtual void	mapMesh (const polyMeshMap &)=0
	Update from another mesh using the given map. More...
virtual void	distribute (const polyDistributionMap &)=0
	Redistribute or update using the given distribution map. More...
virtual void	correct ()
	Correct the fvModel. More...
virtual bool	write (const bool write=true) const
	Write fvModel data. More...
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

Protected Member Functions
const interRegionModel &	nbrModel () const
	Get the neighbour interRegionModel. More...
Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...
template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...
template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...
template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...
static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...
template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...
static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. More...
static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Detailed Description

Base class for inter-region exchange.

Definition at line 49 of file interRegionModel.H.

Constructor & Destructor Documentation

interRegionModel()

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

Construct from dictionary.

Definition at line 129 of file interRegionModel.C.

~interRegionModel()

~interRegionModel ( )

virtual

Destructor.

Definition at line 149 of file interRegionModel.C.

Member Function Documentation

nbrModel()

const Foam::fv::interRegionModel & nbrModel ( ) const

protected

Get the neighbour interRegionModel.

Definition at line 99 of file interRegionModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, objectRegistry::lookupObject(), fvMesh::name(), Foam::name(), interRegionModel::nbrRegionName(), Foam::nl, and fvMesh::time().

Referenced by interRegionModel::interpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"interRegionModel"

)

Runtime type information.

master()

bool master ( ) const

inline

Return whether the master region.

Definition at line 30 of file interRegionModelI.H.

Referenced by interRegionModel::interpolate().

Here is the caller graph for this function:

nbrRegionName()

const Foam::word & nbrRegionName ( ) const

inline

Return const access to the neighbour region name.

Definition at line 36 of file interRegionModelI.H.

Referenced by interRegionPorosityForce::interRegionPorosityForce(), and interRegionModel::nbrModel().

Here is the caller graph for this function:

nbrMesh()

const Foam::fvMesh & nbrMesh ( ) const

inline

Return const access to the neighbour mesh.

Definition at line 42 of file interRegionModelI.H.

References objectRegistry::lookupObject(), and fvMesh::time().

Referenced by interRegionPorosityForce::interRegionPorosityForce().

Here is the call graph for this function:

Here is the caller graph for this function:

interpolation()

const Foam::cellsToCells & interpolation

(

)

const

Return const access to the interpolation engine.

Definition at line 58 of file interRegionModel.C.

References Foam::decrIndent(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::incrIndent(), Foam::indent(), Foam::Info, Foam::name(), cellsToCells::New(), and Foam::nl.

Referenced by interRegionModel::interpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

interpolate() [1/3]

tmp<Field<Type> > interpolate

(

const Field< Type > &

field

)

const

Interpolate field.

Referenced by interRegionPorosityForce::interRegionPorosityForce().

Here is the caller graph for this function:

interpolate() [2/3]

void interpolate	(	const Field< Type > &	field,
		Field< Type > &	result
	)		const

Interpolate field.

Definition at line 49 of file interRegionModelTemplates.C.

read()

bool read ( const dictionary &  dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Reimplemented in interRegionPorosityForce, and interRegionHeatTransfer.

Definition at line 155 of file interRegionModel.C.

References dict, and fvModel::read().

Referenced by interRegionHeatTransfer::read(), and interRegionPorosityForce::read().

Here is the call graph for this function:

Here is the caller graph for this function:

interpolate() [3/3]

Foam::tmp<Foam::Field<Type> > interpolate

(

const Field< Type > &

field

)

const

Definition at line 32 of file interRegionModelTemplates.C.

References interRegionModel::interpolation(), interRegionModel::master(), interRegionModel::nbrModel(), cellsToCells::srcToTgt(), and cellsToCells::tgtToSrc().

Here is the call graph for this function:

---

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

• src/fvModels/interRegion/interRegionModel/interRegionModel.H
• src/fvModels/interRegion/interRegionModel/interRegionModel.C
• src/fvModels/interRegion/interRegionModel/interRegionModelI.H
• src/fvModels/interRegion/interRegionModel/interRegionModelTemplates.C