Loading...
Searching...
No Matches
barotropicCompressibilityModel Class Referenceabstract

Abstract class for barotropic compressibility models. More...

#include <barotropicCompressibilityModel.H>

Inheritance diagram for barotropicCompressibilityModel:
Inheritance graph
[legend]
Collaboration diagram for barotropicCompressibilityModel:
Collaboration graph
[legend]

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 ()=default
 Destructor.
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 &)=delete
 No copy construct.
void operator= (const barotropicCompressibilityModel &)=delete
 No copy assignment.

Protected Attributes

dictionary compressibilityProperties_
volScalarField psi_
const volScalarField & gamma_

Detailed Description

Abstract class for barotropic compressibility models.

Source files

Definition at line 61 of file barotropicCompressibilityModel.H.

Constructor & Destructor Documentation

◆ barotropicCompressibilityModel() [1/2]

barotropicCompressibilityModel ( const barotropicCompressibilityModel & )
protecteddelete

No copy construct.

References barotropicCompressibilityModel().

Referenced by barotropicCompressibilityModel(), Chung::Chung(), declareRunTimeSelectionTable(), linear::linear(), operator=(), and Wallis::Wallis().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ barotropicCompressibilityModel() [2/2]

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

Construct from components.

Definition at line 36 of file barotropicCompressibilityModel.C.

References compressibilityProperties(), compressibilityProperties_, gamma, gamma_, mesh, psi_, timeName, and Foam::Zero.

Here is the call graph for this function:

◆ ~barotropicCompressibilityModel()

virtual ~barotropicCompressibilityModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const barotropicCompressibilityModel & )
protecteddelete

No copy assignment.

References barotropicCompressibilityModel().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "barotropicCompressibilityModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

References barotropicCompressibilityModel(), compressibilityProperties(), and gamma.

Here is the call graph for this function:

◆ 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 27 of file barotropicCompressibilityModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, gamma, 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 151 of file barotropicCompressibilityModel.H.

References compressibilityProperties_.

Referenced by barotropicCompressibilityModel(), Chung::Chung(), correct(), declareRunTimeSelectionTable(), linear::linear(), read(), Chung::read(), linear::read(), Wallis::read(), Chung::TypeName(), linear::TypeName(), Wallis::TypeName(), and Wallis::Wallis().

Here is the caller graph for this function:

◆ psi()

const volScalarField & psi ( ) const
inline

Return the compressibility.

Definition at line 159 of file barotropicCompressibilityModel.H.

References psi_.

◆ correct()

virtual void correct ( )
pure virtual

Correct the compressibility.

Implemented in Chung, linear, and Wallis.

References compressibilityProperties().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & compressibilityProperties)
pure virtual

Read compressibilityProperties dictionary.

Implemented in Chung, linear, and Wallis.

Definition at line 61 of file barotropicCompressibilityModel.C.

References compressibilityProperties(), and compressibilityProperties_.

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

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ compressibilityProperties_

dictionary compressibilityProperties_
protected

Definition at line 68 of file barotropicCompressibilityModel.H.

Referenced by barotropicCompressibilityModel(), Chung::Chung(), compressibilityProperties(), linear::linear(), read(), Chung::read(), linear::read(), Wallis::read(), and Wallis::Wallis().

◆ psi_

volScalarField psi_
protected

Definition at line 70 of file barotropicCompressibilityModel.H.

Referenced by barotropicCompressibilityModel(), Chung::correct(), linear::correct(), Wallis::correct(), linear::linear(), and psi().

◆ gamma_

const volScalarField& gamma_
protected

Definition at line 71 of file barotropicCompressibilityModel.H.

Referenced by barotropicCompressibilityModel(), Chung::correct(), linear::correct(), and Wallis::correct().

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