Inheritance diagram for standardRadiation:

Collaboration diagram for standardRadiation:

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

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

virtual	~standardRadiation ()
	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
	standardRadiation (const standardRadiation &)
	Disallow default bitwise copy construct. More...

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

Private Attributes
volScalarField	QinPrimary_
	Radiative incident flux mapped from the primary region / [kg/s3]. More...

volScalarField	QrNet_
	Remaining radiative flux after removing local contribution. More...

scalar	beta_
	Beta coefficient. More...

scalar	kappaBar_
	Bar(kappa) coefficient. 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 53 of file standardRadiation.H.

Constructor & Destructor Documentation

◆ standardRadiation() [1/2]

standardRadiation ( const standardRadiation & )

private

Disallow default bitwise copy construct.

◆ standardRadiation() [2/2]

standardRadiation	(	surfaceFilmModel &	owner,
		const dictionary &	dict
	)

Construct from surface film model and dictionary.

Definition at line 54 of file standardRadiation.C.

◆ ~standardRadiation()

~standardRadiation ( )

virtual

Destructor.

Definition at line 95 of file standardRadiation.C.

Member Function Documentation

◆ operator=()

void operator= ( const standardRadiation & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "standardRadiation" )

Runtime type information.

◆ correct()

void correct ( )

virtual

Correct.

Implements filmRadiationModel.

Definition at line 101 of file standardRadiation.C.

References GeometricField::correctBoundaryConditions(), and standardRadiation::QinPrimary_.

Here is the call graph for this function:

◆ Shs()

tmp< volScalarField > Shs ( )

virtual

Return the radiation sensible enthalpy source.

Also updates QrNet

Implements filmRadiationModel.

Definition at line 108 of file standardRadiation.C.

References Foam::constant::atomic::alpha, surfaceFilmModel::alpha(), standardRadiation::beta_, GeometricField::correctBoundaryConditions(), delta, surfaceFilmModel::delta(), Foam::dimMass, Foam::dimTime, Foam::exp(), GeometricField::internalField(), standardRadiation::kappaBar_, IOobject::NO_READ, IOobject::NO_WRITE, filmSubModelBase::owner(), filmSubModelBase::owner_, Foam::pow3(), standardRadiation::QinPrimary_, standardRadiation::QrNet_, and timeName.

Here is the call graph for this function:

Field Documentation

◆ QinPrimary_

volScalarField QinPrimary_

private

Radiative incident flux mapped from the primary region / [kg/s3].

Definition at line 62 of file standardRadiation.H.

Referenced by standardRadiation::correct(), and standardRadiation::Shs().

◆ QrNet_

volScalarField QrNet_

private

Remaining radiative flux after removing local contribution.

Definition at line 65 of file standardRadiation.H.

Referenced by standardRadiation::Shs().

◆ beta_

scalar beta_

private

Beta coefficient.

Definition at line 71 of file standardRadiation.H.

Referenced by standardRadiation::Shs().

◆ kappaBar_

scalar kappaBar_

private

Bar(kappa) coefficient.

Definition at line 74 of file standardRadiation.H.

Referenced by standardRadiation::Shs().

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

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ standardRadiation() [1/2]

◆ standardRadiation() [2/2]

◆ ~standardRadiation()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ correct()

◆ Shs()

Field Documentation

◆ QinPrimary_

◆ QrNet_

◆ beta_

◆ kappaBar_