Template Class relativePermeabilityModelBase

Inheritance Relationships

Base Type

  • public regIOobject

Derived Type

Class Documentation

template<int nPhases>
class relativePermeabilityModelBase : public regIOobject

An abstract class template for relative permeability models.

Source files

Subclassed by krBrooksCorey

Public Functions

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

Construct from components.

virtual ~relativePermeabilityModelBase()

Destructor.

const dictionary &transportProperties() const

Return model hosting dictionary.

volScalarField kr(int phaseIndex) const

Return relative permeability component.

scalar kr(int phaseIndex, int cellID) const

Return relative permeability of cell.

volScalarField dkrdS(int phaseIndex) const

Return relative permeability derivative.

scalar dkrdS(int phaseIndex, int cellID) const

Return relative permeability derivative of cell.

const volVectorNField<numberOfKrFields(nPhases)> &krTable() const

Return Kr table as a hole (For debugging)

const volVectorNField<numberOfKrFields(nPhases)> &dkrdSTable() const

Return Kr table as a hole (For debugging)

virtual void correct() = 0

Correct relative permeability 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 label phaseIndex(const word &phaseName) const = 0

Return phase index.

virtual bool writeData(Ostream&) const

Write Data to Ostream.

Public Static Functions

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

Return a reference to the selected Kr model.

Protected Functions

relativePermeabilityModelBase(const relativePermeabilityModelBase&)

Disallow copy construct.

void operator=(const relativePermeabilityModelBase&)

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.

volVectorNField<numberOfKrFields(nPhases)> kr_

Phase Relative permeabilities.

volVectorNField<numberOfKrFields(nPhases)> dkrdS_

Phase Relative permeability derivatives.