Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
barotropicCompressibilityModel Class Referenceabstract

Abstract class for barotropic compressibility models. More...

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

Public Member Functions

 TypeName ("barotropicCompressibilityModel")
 
 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")
 
virtual ~barotropicCompressibilityModel ()=default
 
const dictionarycompressibilityProperties () const
 
const volScalarFieldpsi () const
 
virtual void correct ()=0
 
virtual bool read (const dictionary &compressibilityProperties)=0
 

Static Public Member Functions

static autoPtr< barotropicCompressibilityModelNew (const dictionary &compressibilityProperties, const volScalarField &gamma, const word &psiName="psi")
 

Protected Member Functions

 barotropicCompressibilityModel (const barotropicCompressibilityModel &)=delete
 
void operator= (const barotropicCompressibilityModel &)=delete
 

Protected Attributes

dictionary compressibilityProperties_
 
volScalarField psi_
 
const volScalarFieldgamma_
 

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() [2/2]

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

Definition at line 37 of file barotropicCompressibilityModel.C.

◆ ~barotropicCompressibilityModel()

virtual ~barotropicCompressibilityModel ( )
virtualdefault

Member Function Documentation

◆ operator=()

void operator= ( const barotropicCompressibilityModel )
protecteddelete

◆ TypeName()

TypeName ( "barotropicCompressibilityModel"  )

◆ 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

Definition at line 28 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

◆ psi()

const volScalarField& psi ( ) const
inline

◆ correct()

virtual void correct ( )
pure virtual

Implemented in Wallis, Chung, and linear.

◆ read()

bool read ( const dictionary compressibilityProperties)
pure virtual

Implemented in Wallis, Chung, and linear.

Definition at line 62 of file barotropicCompressibilityModel.C.

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

Here is the caller graph for this function:

Member Data Documentation

◆ compressibilityProperties_

dictionary compressibilityProperties_
protected

◆ psi_

volScalarField psi_
protected

◆ gamma_

const volScalarField& gamma_
protected

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