Inheritance diagram for constantRadiation:

Collaboration diagram for constantRadiation:

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

	constantRadiation (surfaceFilmModel &owner, const dictionary &dict)
	Construct from surface film model and dictionary. More...

virtual	~constantRadiation ()
	Destructor. More...

virtual void	correct ()
	Correct. More...

virtual tmp< volScalarField >	Shs ()
	Return the radiation sensible enthalpy source. More...

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

	declareRunTimeSelectionTable (autoPtr, filmRadiationModel, dictionary,(surfaceFilmModel &owner, const dictionary &dict),(owner, dict))

	filmRadiationModel (surfaceFilmModel &owner)
	Construct null. More...

	filmRadiationModel (const word &modelType, surfaceFilmModel &owner, const dictionary &dict)
	Construct from type name, dictionary and surface film model. More...

virtual	~filmRadiationModel ()
	Destructor. More...

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmModel &owner)
	Construct null. More...

	filmSubModelBase (surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner film wihout name. More...

	filmSubModelBase (const word &modelName, surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner film with name. More...

virtual	~filmSubModelBase ()
	Destructor. More...

virtual bool	outputTime () const
	Flag to indicate when to write a property. More...

const surfaceFilmModel &	owner () const
	Return const access to the owner surface film model. More...

surfaceFilmModel &	owner ()
	Return the reference to the owner surface film model. More...

template<class FilmType >
const FilmType &	filmType () const

Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null. More...

	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name. More...

	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name. More...

	subModelBase (const subModelBase &smb)
	Construct as copy. More...

virtual	~subModelBase ()
	Destructor. More...

const word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () const
	Return const access to the properties dictionary. More...

virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg. More...

virtual bool	active () const
	Return the model 'active' status - default active = true. More...

virtual void	cacheFields (const bool store)
	Cache dependant sub-model fields. More...

template<class Type >
Type	getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the base model. More...

template<class Type >
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model. More...

template<class Type >
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model. More...

template<class Type >
void	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model. More...

template<class Type >
Type	getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
	Retrieve generic property from the sub-model. More...

template<class Type >
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model. More...

virtual void	write (Ostream &os) const
	Write. More...

Private Member Functions
	constantRadiation (const constantRadiation &)
	Disallow default bitwise copy construct. More...

void	operator= (const constantRadiation &)
	Disallow default bitwise assignment. More...

Private Attributes
volScalarField	QrConst_
	Constant radiative flux [kg/s3]. More...

volScalarField	mask_
	Radiation mask. More...

scalar	absorptivity_
	Absorptivity. More...

const scalar	timeStart_
	Time start [s]. More...

const scalar	duration_
	Duration [s]. More...

Additional Inherited Members
Static Public Member Functions inherited from filmRadiationModel
static autoPtr< filmRadiationModel >	New (surfaceFilmModel &owner, const dictionary &dict)
	Return a reference to the selected phase change model. More...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes inherited from filmSubModelBase
surfaceFilmModel &	owner_
	Reference to the owner surface film model. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	Reference to properties dictionary e.g. for restart. More...

const dictionary	dict_
	Copy of dictionary used during construction. More...

const word	baseName_
	Name of the sub-model base class. More...

const word	modelType_
	Type of the sub-model. More...

const dictionary	coeffDict_
	Coefficients dictionary. More...

Detailed Description

Definition at line 56 of file constantRadiation.H.

Constructor & Destructor Documentation

◆ constantRadiation() [1/2]

constantRadiation ( const constantRadiation & )

private

Disallow default bitwise copy construct.

◆ constantRadiation() [2/2]

constantRadiation	(	surfaceFilmModel &	owner,
		const dictionary &	dict
	)

Construct from surface film model and dictionary.

Definition at line 54 of file constantRadiation.C.

References Foam::pos().

Here is the call graph for this function:

◆ ~constantRadiation()

~constantRadiation ( )

virtual

Destructor.

Definition at line 95 of file constantRadiation.C.

Member Function Documentation

◆ operator=()

void operator= ( const constantRadiation & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "constantRadiation" )

Runtime type information.

◆ correct()

void correct ( )

virtual

Correct.

Implements filmRadiationModel.

Definition at line 101 of file constantRadiation.C.

◆ Shs()

tmp< volScalarField > Shs ( )

virtual

Return the radiation sensible enthalpy source.

Also updates QrNet

Implements filmRadiationModel.

Definition at line 105 of file constantRadiation.C.

References constantRadiation::absorptivity_, Foam::constant::atomic::alpha, surfaceFilmModel::alpha(), Foam::dimMass, Foam::dimTime, constantRadiation::duration_, GeometricField::internalField(), constantRadiation::mask_, IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner(), filmSubModelBase::owner_, Foam::pow3(), Qr(), constantRadiation::QrConst_, regionModel::time(), timeName, constantRadiation::timeStart_, and dimensioned::value().

Here is the call graph for this function:

Field Documentation

◆ QrConst_

volScalarField QrConst_

private

Constant radiative flux [kg/s3].

Definition at line 65 of file constantRadiation.H.

Referenced by constantRadiation::Shs().

◆ mask_

volScalarField mask_

private

Radiation mask.

Definition at line 68 of file constantRadiation.H.

Referenced by constantRadiation::Shs().

◆ absorptivity_

scalar absorptivity_

private

Absorptivity.

Definition at line 71 of file constantRadiation.H.

Referenced by constantRadiation::Shs().

◆ timeStart_

const scalar timeStart_

private

Time start [s].

Definition at line 74 of file constantRadiation.H.

Referenced by constantRadiation::Shs().

◆ duration_

const scalar duration_

private

Duration [s].

Definition at line 77 of file constantRadiation.H.

Referenced by constantRadiation::Shs().

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

src/regionModels/surfaceFilmModels/submodels/thermo/filmRadiationModel/constantRadiation/constantRadiation.H
src/regionModels/surfaceFilmModels/submodels/thermo/filmRadiationModel/constantRadiation/constantRadiation.C

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ constantRadiation() [1/2]

◆ constantRadiation() [2/2]

◆ ~constantRadiation()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ correct()

◆ Shs()

Field Documentation

◆ QrConst_

◆ mask_

◆ absorptivity_

◆ timeStart_

◆ duration_