barotropicCompressibilityModel Class Reference

Abstract class for barotropic compressibility models. More...

Inheritance diagram for barotropicCompressibilityModel:

Collaboration diagram for barotropicCompressibilityModel:

Public Member Functions
	TypeName ("barotropicCompressibilityModel")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, barotropicCompressibilityModel, dictionary,(const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName),(compressibilityProperties, gamma, psiName))
	barotropicCompressibilityModel (const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName="psi")
	Construct from components. More...
virtual	~barotropicCompressibilityModel ()=default
	Destructor. More...
const dictionary &	compressibilityProperties () const
	Return the phase transport properties dictionary. More...
const volScalarField &	psi () const
	Return the compressibility. More...
virtual void	correct ()=0
	Correct the compressibility. More...
virtual bool	read (const dictionary &compressibilityProperties)=0
	Read compressibilityProperties dictionary. More...

Static Public Member Functions
static autoPtr< barotropicCompressibilityModel >	New (const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName="psi")
	Return a reference to the selected compressibility model. More...

Protected Member Functions
	barotropicCompressibilityModel (const barotropicCompressibilityModel &)=delete
	No copy construct. More...
void	operator= (const barotropicCompressibilityModel &)=delete
	No copy assignment. More...

Protected Attributes
dictionary	compressibilityProperties_
volScalarField	psi_
const volScalarField &	gamma_

Detailed Description

Abstract class for barotropic compressibility models.

Source files

• barotropicCompressibilityModel.H
• barotropicCompressibilityModel.C
• newbarotropicCompressibilityModel.C

Definition at line 64 of file barotropicCompressibilityModel.H.

Constructor & Destructor Documentation

barotropicCompressibilityModel() [1/2]

barotropicCompressibilityModel ( const barotropicCompressibilityModel &  )

protecteddelete

No copy construct.

barotropicCompressibilityModel() [2/2]

barotropicCompressibilityModel	(	const dictionary &	compressibilityProperties,
		const volScalarField &	gamma,
		const word &	psiName = "psi"
	)

Construct from components.

Definition at line 43 of file barotropicCompressibilityModel.C.

~barotropicCompressibilityModel()

virtual ~barotropicCompressibilityModel ( )

virtualdefault

Destructor.

Member Function Documentation

operator=()

void operator= ( const barotropicCompressibilityModel &  )

protecteddelete

No copy assignment.

TypeName()

TypeName

(

"barotropicCompressibilityModel"

)

Runtime type information.

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		barotropicCompressibilityModel	,
		dictionary	,
		(const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName)	,
		(compressibilityProperties, gamma, psiName)
	)

New()

Foam::autoPtr< Foam::barotropicCompressibilityModel > New ( const dictionary &  compressibilityProperties, const volScalarField &  gamma, const word &  psiName = "psi"  )

static

Return a reference to the selected compressibility model.

Definition at line 34 of file barotropicCompressibilityModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, gamma, dictionary::get(), and Foam::Info.

Here is the call graph for this function:

compressibilityProperties()

const dictionary & compressibilityProperties ( ) const

inline

Return the phase transport properties dictionary.

Definition at line 140 of file barotropicCompressibilityModel.H.

References barotropicCompressibilityModel::compressibilityProperties_.

psi()

const volScalarField & psi ( ) const

inline

Return the compressibility.

Definition at line 146 of file barotropicCompressibilityModel.H.

References barotropicCompressibilityModel::psi_.

correct()

virtual void correct ( )

pure virtual

Correct the compressibility.

Implemented in Chung, linear, and Wallis.

read()

bool read ( const dictionary &  compressibilityProperties )

pure virtual

Read compressibilityProperties dictionary.

Implemented in Chung, linear, and Wallis.

Definition at line 68 of file barotropicCompressibilityModel.C.

Member Data Documentation

compressibilityProperties_

dictionary compressibilityProperties_

protected

Definition at line 71 of file barotropicCompressibilityModel.H.

Referenced by barotropicCompressibilityModel::compressibilityProperties().

psi_

volScalarField psi_

protected

Definition at line 73 of file barotropicCompressibilityModel.H.

Referenced by linear::linear(), and barotropicCompressibilityModel::psi().

gamma_

const volScalarField& gamma_

protected

Definition at line 74 of file barotropicCompressibilityModel.H.

---

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

• src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModel.H
• src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModel.C
• src/thermophysicalModels/barotropicCompressibilityModel/barotropicCompressibilityModel/barotropicCompressibilityModelNew.C