Template Class wellModelBase

Inheritance Relationships

Base Type

  • public objectRegistry

Class Documentation

template<class KType, int nPhases>
class wellModelBase : public objectRegistry

An abstract class for well models based on the assumption that well bottom hole pressure is a function of (main) pressure and some flowrate variable (Total, or phase-specific).

Source files

Public Functions

TypeName("wellBaseModel")

Runtime type information.

declareRunTimeSelectionTable(autoPtr, wellModelBase, Dictionary, (const word & name , const dictionary &wellProperties, const fvMesh &mesh), ( name , wellProperties, mesh))
wellModelBase(const word &name, const dictionary &wellProperties, const fvMesh &mesh)

Construct from components.

virtual ~wellModelBase()

Destructor.

const word &name() const

Return well model name.

const dictionary &dict() const

Return Wells dict.

const objectRegistry &thisDb() const

Return the object registry.

const PtrList<wellBase<KType, nPhases>> &wells() const

Return wells List.

const fvScalarMatrix &source(const word &phaseName) const

Return phase well source matrix.

const uniformDimensionedVectorField &g() const

Return a ref to model gracitational field.

virtual void correct() = 0

Correct well rates.

virtual void operator()(const word &wellName) const = 0

Virtual Functor operator.

Public Static Functions

Foam::autoPtr<Foam::wellModelBase<KType, nPhases>> New(const word &name, const dictionary &wellProperties, const fvMesh &mesh)

Return a reference to the well control model.

Protected Functions

void readWells()

Read wells from list.

Protected Attributes

const word &name_

Model Name.

const dictionary &wellProperties_

Well dictionary entry.

const fvMesh &mesh_

Const ref to mesh.

const volScalarField &p_

Const ref to pressure field.

const KType &K_

Const ref to absolute permeability.

PtrList<wellBase<KType, nPhases>> wells_

Wells List.

HashTable<fvScalarMatrix> source_

Sources matrices.

const uniformDimensionedVectorField &g_

Ref to Gravitational field.