Inheritance diagram for thermalShellModel:

Collaboration diagram for thermalShellModel:

Public Member Functions
	TypeName ("thermalShellModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, thermalShellModel, dictionary,(const word &modelType, const fvPatch &patch, const dictionary &dict),(modelType, patch, dict))

	thermalShellModel (const word &modelType, const fvPatch &patch, const dictionary &dict)
	Construct from type name and mesh and dict. More...

	thermalShellModel (const thermalShellModel &)=delete
	No copy construct. More...

void	operator= (const thermalShellModel &)=delete
	No copy assignment. More...

virtual	~thermalShellModel ()=default
	Destructor. More...

const volScalarField &	Tp () const
	Return primary region temperature. More...

const areaScalarField &	T () const
	Return shell temperature. More...

Foam::fa::options &	faOptions ()
	Return faOptions. More...

virtual void	preEvolveRegion ()
	Pre-evolve region. More...

Public Member Functions inherited from regionFaModel
	TypeName ("regionFaModel")
	Runtime type information. More...

	regionFaModel (const fvPatch &patch, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
	Construct from mesh and name and dict. More...

	regionFaModel (const regionFaModel &)=delete
	No copy construct. More...

void	operator= (const regionFaModel &)=delete
	No copy assignment. More...

virtual	~regionFaModel ()=default
	Destructor. More...

const fvMesh &	primaryMesh () const
	Return the reference to the primary mesh database. More...

const Time &	time () const
	Return the reference to the time database. More...

const Switch &	active () const
	Return the active flag. More...

const Switch &	infoOutput () const
	Return the information flag. More...

const word &	modelName () const
	Return the model name. More...

const faMesh &	regionMesh () const
	Return the region mesh database. More...

faMesh &	regionMesh ()
	Return the region mesh database for manipulation. More...

const dictionary &	coeffs () const
	Return the model coefficients dictionary. More...

const dictionary &	solution () const
	Return the solution dictionary. More...

const volSurfaceMapping &	vsm () const
	Return volSurfaceMapping. More...

label	patchID ()

virtual void	evolve ()
	Main driver routing to evolve the region - calls other evolves. More...

virtual void	evolveRegion ()
	Evolve the region. More...

virtual void	postEvolveRegion ()
	Post-evolve region. More...

virtual void	info ()
	Provide some feedback. More...

Static Public Member Functions
static autoPtr< thermalShellModel >	New (const fvPatch &patch, const dictionary &dict)
	Return a reference to the selected model using dictionary. More...

Protected Member Functions
virtual bool	read (const dictionary &)
	Read control parameters from dictionary. More...

Protected Attributes
word	TName_
	Name of the temperature field. More...

const volScalarField &	Tp_
	Primary region temperature. More...

areaScalarField	T_
	Shell temperature. More...

Foam::fa::options &	faOptions_
	Pointer to faOptions. More...

Protected Attributes inherited from regionFaModel
const fvMesh &	primaryMesh_
	Reference to the primary mesh database. More...

const fvPatch &	patch_
	Reference to fvPatch. More...

const Time &	time_
	Reference to the time database. More...

Switch	active_
	Active flag. More...

Switch	infoOutput_
	Active information output. More...

const word	modelName_
	Model name. More...

autoPtr< faMesh >	regionMeshPtr_
	Pointer to the region mesh database. More...

dictionary	coeffs_
	Model coefficients dictionary. More...

autoPtr< volSurfaceMapping >	vsmPtr_
	Volume-to surface mapping. More...

label	patchID_
	Patch IDs on the primary region coupled to this region. More...

word	regionName_
	Region name. More...

Detailed Description

Definition at line 108 of file thermalShellModel.H.

Constructor & Destructor Documentation

◆ thermalShellModel() [1/2]

thermalShellModel	(	const word &	modelType,
		const fvPatch &	patch,
		const dictionary &	dict
	)

Construct from type name and mesh and dict.

Definition at line 62 of file thermalShellModel.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ thermalShellModel() [2/2]

thermalShellModel ( const thermalShellModel & )

delete

No copy construct.

◆ ~thermalShellModel()

virtual ~thermalShellModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ read()

bool read ( const dictionary & dict )

protectedvirtual

Read control parameters from dictionary.

Reimplemented from regionFaModel.

Reimplemented in thermalShell.

Definition at line 48 of file thermalShellModel.C.

References dict, and regionFaModel::read().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "thermalShellModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		thermalShellModel	,
		dictionary	,
		(const word &modelType, const fvPatch &patch, const dictionary &dict)	,
		(modelType, patch, dict)
	)

◆ operator=()

void operator= ( const thermalShellModel & )

delete

No copy assignment.

◆ New()

autoPtr< thermalShellModel > New	(	const fvPatch &	patch,
		const dictionary &	dict
	)

static

Return a reference to the selected model using dictionary.

Definition at line 40 of file thermalShellModelNew.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and p.

Here is the call graph for this function:

◆ Tp()

const Foam::volScalarField & Tp ( ) const

Return primary region temperature.

Definition at line 98 of file thermalShellModel.C.

References thermalShellModel::Tp_.

◆ T()

const Foam::areaScalarField & T ( ) const

Return shell temperature.

Definition at line 104 of file thermalShellModel.C.

References thermalShellModel::T_.

◆ faOptions()

Foam::fa::options & faOptions ( )

Return faOptions.

Definition at line 110 of file thermalShellModel.C.

References thermalShellModel::faOptions_.

Referenced by thermalShell::solveEnergy().

Here is the caller graph for this function:

◆ preEvolveRegion()

void preEvolveRegion ( )

virtual

Pre-evolve region.

Reimplemented from regionFaModel.

Reimplemented in thermalShell.

Definition at line 94 of file thermalShellModel.C.

Member Data Documentation

◆ TName_

word TName_

protected

Name of the temperature field.

Definition at line 123 of file thermalShellModel.H.

◆ Tp_

const volScalarField& Tp_

protected

Primary region temperature.

Definition at line 126 of file thermalShellModel.H.

Referenced by thermalShellModel::Tp().

◆ T_

areaScalarField T_

protected

Shell temperature.

Definition at line 129 of file thermalShellModel.H.

Referenced by thermalShell::evolveRegion(), thermalShell::solveEnergy(), and thermalShellModel::T().

◆ faOptions_

Foam::fa::options& faOptions_

protected

Pointer to faOptions.

Definition at line 132 of file thermalShellModel.H.

Referenced by thermalShellModel::faOptions().

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

src/regionFaModels/thermalShellModel/thermalShellModel.H
src/regionFaModels/thermalShellModel/thermalShellModel.C
src/regionFaModels/thermalShellModel/thermalShellModelNew.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ thermalShellModel() [1/2]

◆ thermalShellModel() [2/2]

◆ ~thermalShellModel()

Member Function Documentation

◆ read()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ operator=()

◆ New()

◆ Tp()

◆ T()

◆ faOptions()

◆ preEvolveRegion()

Member Data Documentation

◆ TName_

◆ Tp_

◆ T_

◆ faOptions_