interRegionOption Class Reference

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

#include <interRegionOption.H>

Inheritance diagram for interRegionOption:

Collaboration diagram for interRegionOption:

Public Member Functions
	TypeName ("interRegionOption")
	Runtime type information.
	interRegionOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from dictionary.
	interRegionOption (const interRegionOption &)=delete
	No copy construct.
void	operator= (const interRegionOption &)=delete
	No copy assignment.
virtual	~interRegionOption ()=default
	Destructor.
const word &	nbrRegionName () const
	Return const access to the neighbour region name.
const meshToMesh &	meshInterp () const
	Return const access to the mapToMap pointer.
virtual bool	read (const dictionary &dict)
	Read dictionary.
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	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.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual bool	isActive ()
	Is the source active?
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
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	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.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Protected Member Functions
void	setMapper ()
	Set the mesh to mesh interpolation object.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.

Protected Attributes
bool	master_
	Master or slave region.
word	nbrRegionName_
	Name of the neighbour region to map.
autoPtr< meshToMesh >	meshInterpPtr_
	Mesh to mesh interpolation object.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

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.
Public Attributes inherited from option
bool	log
	Switch write log to Info.

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:

• fvOption.H
• meshToMesh.H

Source files

• interRegionOption.H
• interRegionOption.C

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 )

Construct from dictionary.

Definition at line 92 of file interRegionOption.C.

References option::active(), option::coeffs_, dict, master_, option::mesh(), meshInterpPtr_, option::name(), nbrRegionName_, option::option(), and setMapper().

Referenced by interRegionExplicitPorositySource::interRegionExplicitPorositySource(), interRegionHeatTransferModel::interRegionHeatTransferModel(), interRegionOption(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

interRegionOption() [2/2]

interRegionOption ( const interRegionOption & )

delete

No copy construct.

References interRegionOption().

Here is the call graph for this function:

~interRegionOption()

virtual ~interRegionOption ( )

virtualdefault

Destructor.

References dict.

Member Function Documentation

setMapper()

void setMapper ( )

protected

Set the mesh to mesh interpolation object.

Definition at line 37 of file interRegionOption.C.

References option::coeffs_, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, meshToMesh::imCellVolumeWeight, Foam::indent(), Foam::Info, meshToMesh::interpolationMethodNames_, master_, option::mesh_, meshInterpPtr_, nbrRegionName_, Foam::nl, meshToMesh::pmAABB, and meshToMesh::procMapMethodNames_.

Referenced by interRegionOption().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"interRegionOption"

)

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

operator=()

void operator= ( const interRegionOption & )

delete

No copy assignment.

References interRegionOption().

Here is the call graph for this function:

nbrRegionName()

const Foam::word & nbrRegionName ( ) const

inline

Return const access to the neighbour region name.

Definition at line 25 of file interRegionOptionI.H.

References nbrRegionName_.

meshInterp()

const Foam::meshToMesh & meshInterp ( ) const

inline

Return const access to the mapToMap pointer.

Definition at line 32 of file interRegionOptionI.H.

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

Referenced by interRegionExplicitPorositySource::addSup(), and interRegionExplicitPorositySource::addSup().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from option.

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

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

Master or slave region.

Definition at line 114 of file interRegionOption.H.

Referenced by constantHeatTransfer::constantHeatTransfer(), interRegionHeatTransferModel::correct(), interRegionHeatTransferModel::interpolate(), interRegionHeatTransferModel::interpolate(), interRegionOption(), setMapper(), and variableHeatTransfer::variableHeatTransfer().

nbrRegionName_

word nbrRegionName_

protected

Name of the neighbour region to map.

Definition at line 119 of file interRegionOption.H.

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

meshInterpPtr_

autoPtr<meshToMesh> meshInterpPtr_

protected

Mesh to mesh interpolation object.

Definition at line 124 of file interRegionOption.H.

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

---

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

• src/fvOptions/interRegionOption/interRegionOption.H
• src/fvOptions/interRegionOption/interRegionOption.C
• src/fvOptions/interRegionOption/interRegionOptionI.H