barotropicCompressibilityModel Class Reference

Abstract class for barotropic compressibility models. More...

Inheritance diagram for barotropicCompressibilityModel:

[legend]

Collaboration diagram for barotropicCompressibilityModel:

[legend]

List of all members.

Public Member Functions
	TypeName ("barotropicCompressibilityModel")
	Runtime type information.
	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.
virtual	~barotropicCompressibilityModel ()
const dictionary &	compressibilityProperties () const
	Return the phase transport properties dictionary.
const volScalarField &	psi () const
	Return the compressibility.
virtual void	correct ()=0
	Correct the compressibility.
virtual bool	read (const dictionary &compressibilityProperties)=0
	Read compressibilityProperties dictionary.
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.
Protected Member Functions
	barotropicCompressibilityModel (const barotropicCompressibilityModel &)
	Disallow copy construct.
void	operator= (const barotropicCompressibilityModel &)
	Disallow default bitwise assignment.
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 57 of file barotropicCompressibilityModel.H.

---

Constructor & Destructor Documentation

barotropicCompressibilityModel

(

const barotropicCompressibilityModel &

)

[protected]

Disallow copy construct.

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

Construct from components.

Definition at line 34 of file barotropicCompressibilityModel.C.

References Foam::defineRunTimeSelectionTable(), and Foam::defineTypeNameAndDebug().

Here is the call graph for this function:

virtual ~barotropicCompressibilityModel

(

)

[inline, virtual]

Definition at line 125 of file barotropicCompressibilityModel.H.

---

Member Function Documentation

void operator=

(

const barotropicCompressibilityModel &

)

[protected]

Disallow default bitwise assignment.

TypeName

(

"barotropicCompressibilityModel"

)

Runtime type information.

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

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 24 of file newBarotropicCompressibilityModel.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and dictionary::lookup().

Here is the call graph for this function:

const dictionary& compressibilityProperties

(

)

const [inline]

Return the phase transport properties dictionary.

Definition at line 132 of file barotropicCompressibilityModel.H.

const volScalarField& psi

(

)

const [inline]

Return the compressibility.

Definition at line 138 of file barotropicCompressibilityModel.H.

References barotropicCompressibilityModel::compressibilityProperties_.

virtual void correct

(

)

[pure virtual]

Correct the compressibility.

Implemented in Chung, linear, and Wallis.

bool read

(

const dictionary &

compressibilityProperties

)

[pure virtual]

Read compressibilityProperties dictionary.

Implemented in Chung, linear, and Wallis.

Definition at line 59 of file barotropicCompressibilityModel.C.

---

Member Data Documentation

dictionary compressibilityProperties_ [protected]

Definition at line 64 of file barotropicCompressibilityModel.H.

Referenced by barotropicCompressibilityModel::psi().

volScalarField psi_ [protected]

Definition at line 66 of file barotropicCompressibilityModel.H.

Referenced by linear::read(), and Wallis::read().

const volScalarField& gamma_ [protected]

Definition at line 67 of file barotropicCompressibilityModel.H.

Referenced by linear::read(), and Wallis::read().

---

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/newBarotropicCompressibilityModel.C