Template Class capillaryPressureModelBase

Inheritance Relationships

Base Type

  • public regIOobject

Class Documentation

template<int nPhases>
class capillaryPressureModelBase : public regIOobject

An abstract class template for capillarity models.

Source files

Public Functions

TypeName("capillaryPressureModelBase")
declareRunTimeSelectionTable(autoPtr, capillaryPressureModelBase, dictionary, (const word &name, const dictionary & transportProperties , const fvMesh &mesh), (name, transportProperties , mesh))
capillaryPressureModelBase(const word &name, const dictionary &transportProperties, const fvMesh &mesh)

Construct from components.

virtual ~capillaryPressureModelBase()

Destructor.

const dictionary &transportProperties() const

Return model hosting dictionary.

tmp<volScalarField> pc(int phaseIndex = 0)

Return capillarity component.

tmp<volScalarField> dpcdS(int phaseIndex = 0)

Return capillarity derivative.

const pcTableReturn<nPhases>::type &pcTable() const

Return Pc table as a hole (For debugging) by ref.

const pcTableReturn<nPhases>::type &dpcdSTable() const

Return dPc table as a hole (For debugging) by ref.

virtual void correct() = 0

Correct capillarity fields.

virtual const wordList phaseNames() const = 0

Return associated phase names as a list.

virtual const word canonicalPhase() const = 0

Return canonical phase name.

virtual bool writeData(Ostream&) const

Write Data to Ostream.

Public Static Functions

autoPtr<capillaryPressureModelBase<nPhases>> New(const word &name, const dictionary &transportProperties, const fvMesh &mesh)

Return a reference to the selected Pc model.

Protected Functions

capillaryPressureModelBase(const capillaryPressureModelBase&)

Disallow copy construct.

void operator=(const capillaryPressureModelBase&)

Disallow default bitwise assignment.

Protected Attributes

word name_

Model Name.

const dictionary &transportProperties_

Const-ref to Hosting dict.

const fvMesh &mesh_

Const-ref to mesh.

pcTableReturn<nPhases>::type pc_

Model capillary Pressure.

pcTableReturn<nPhases>::type dpcdS_

Model capillary Pressure derivatives.