Public Types | Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
energyRegionCoupledFvPatchScalarField Class Reference

Energy region coupled implicit boundary condition. The fvPatch is treated as uncoupled from the delta point of view. In the mesh the fvPatch is an interface and is incorporated into the matrix implicitly. More...

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

Public Types

enum  kappaMethodType { SOLID, FLUID, UNDEFINED }
 
- Public Types inherited from fvPatchField< scalar >
typedef fvPatch Patch
 

Public Member Functions

 TypeName ("compressible::energyRegionCoupled")
 Runtime type information. More...
 
 energyRegionCoupledFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 energyRegionCoupledFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 energyRegionCoupledFvPatchScalarField (const energyRegionCoupledFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given energyRegionCoupledFvPatchScalarField. More...
 
 energyRegionCoupledFvPatchScalarField (const energyRegionCoupledFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< scalar > > clone () const
 Construct and return a clone. More...
 
 energyRegionCoupledFvPatchScalarField (const energyRegionCoupledFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< scalar > > clone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~energyRegionCoupledFvPatchScalarField ()
 Destructor. More...
 
word kappaMethod () const
 Method to obtain K. More...
 
virtual tmp< scalarFieldpatchNeighbourField () const
 Return neighbour coupled internal cell data. More...
 
virtual tmp< scalarFieldsnGrad () const
 Return patch-normal gradient. More...
 
virtual tmp< scalarFieldsnGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient. More...
 
virtual void evaluate (const Pstream::commsTypes commsType)
 Evaluate the patch field. More...
 
virtual void updateInterfaceMatrix (Field< scalar > &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual void updateInterfaceMatrix (Field< scalar > &, const Field< scalar > &, const scalarField &, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual const wordinterfaceFieldType () const
 Return the interface type. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from coupledFvPatchField< scalar >
 TypeName (coupledFvPatch::typeName_())
 Runtime type information. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const Field< scalar > &)
 Construct from patch and internal field and patch field. More...
 
 coupledFvPatchField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 coupledFvPatchField (const coupledFvPatchField< scalar > &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given coupledFvPatchField onto a new patch. More...
 
 coupledFvPatchField (const coupledFvPatchField< scalar > &)
 Construct as copy. More...
 
 coupledFvPatchField (const coupledFvPatchField< scalar > &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< scalar > > clone () const=0
 Construct and return a clone. More...
 
virtual bool coupled () const
 Return true if this patch field is derived from. More...
 
virtual tmp< Field< scalar > > patchNeighbourField () const=0
 Return neighbour field of internal field. More...
 
virtual tmp< Field< scalar > > snGrad () const
 Return patch-normal gradient. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType)
 Initialise the evaluation of the patch field. More...
 
virtual tmp< Field< scalar > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< scalar > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< scalar > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< scalar > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< scalar > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< scalar > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
- Public Member Functions inherited from LduInterfaceField< scalar >
 LduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
 TypeName ("LduInterfaceField")
 Runtime type information. More...
 
virtual ~LduInterfaceField ()
 Destructor. More...
 
virtual void initInterfaceMatrixUpdate (Field< scalar > &, const Field< scalar > &, const scalarField &, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual void initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
 Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...
 
virtual void updateInterfaceMatrix (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const =0
 Inherit updateInterfaceMatrix from lduInterfaceField. More...
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 Runtime type information. More...
 
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~lduInterfaceField ()
 Destructor. More...
 
const lduInterfaceinterface () const
 Return the interface. More...
 
bool updatedMatrix () const
 Whether matrix has been updated. More...
 
bool & updatedMatrix ()
 Whether matrix has been updated. More...
 
virtual bool ready () const
 Is all data available. More...
 
virtual void initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
- Public Member Functions inherited from fvPatchField< scalar >
 TypeName ("fvPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
 Construct from patch and internal field and patch type. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
 Construct from patch, internal field and dictionary. More...
 
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvPatchField onto a new patch. More...
 
 fvPatchField (const fvPatchField< Type > &)
 Construct as copy. More...
 
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatch &p)
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
virtual ~fvPatchField ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, volMesh > & dimensionedInternalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & internalField () const
 Return internal field reference. More...
 
const wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 Optional patch type. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. More...
 
bool manipulatedMatrix () const
 Return true if the matrix has already been manipulated. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void updateCoeffs (const scalarField &weights)
 Update the coefficients associated with the patch field. More...
 
virtual tmp< Field< Type > > patchInternalField () const
 Return internal field next to patch as patch field. More...
 
virtual void patchInternalField (Field< Type > &) const
 Return internal field next to patch as patch field. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 Manipulate matrix. More...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 Manipulate matrix with given weights. More...
 
void writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
 Helper function to write the keyword and entry only if the. More...
 
void check (const fvPatchField< Type > &) const
 Check fvPatchField<Type> against given fvPatchField<Type> More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 

Private Member Functions

tmp< scalarFieldweights () const
 Local weight for this coupled field. More...
 
tmp< scalarFieldpatchNeighbourTemperatureField () const
 Return nbr temperature internal field. More...
 
tmp< scalarFieldpatchInternalTemperatureField () const
 Return local temperature internal field. More...
 
tmp< scalarFieldkappa () const
 Return kappa. More...
 
void setMethod () const
 Set method. More...
 

Private Attributes

const regionCoupledBaseFvPatchregionCoupledPatch_
 Local reference to region couple patch. More...
 
kappaMethodType method_
 How to get K. More...
 
const basicThermonbrThermoPtr_
 AutoPtr to nbr thermo. More...
 
const basicThermothermoPtr_
 AutoPtr to my thermo. More...
 

Static Private Attributes

static const NamedEnum< kappaMethodType, 3 > methodTypeNames_
 Methof to extract kappa. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fvPatchField< scalar >
static tmp< fvPatchField< Type > > New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvPatchField< Type > > New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 Return a pointer to a new calculatedFvPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated for of fvPatchField. More...
 
- Static Public Attributes inherited from fvPatchField< scalar >
static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField. More...
 

Detailed Description

Energy region coupled implicit boundary condition. The fvPatch is treated as uncoupled from the delta point of view. In the mesh the fvPatch is an interface and is incorporated into the matrix implicitly.

Source files

Definition at line 57 of file energyRegionCoupledFvPatchScalarField.H.

Member Enumeration Documentation

◆ kappaMethodType

Enumerator
SOLID 
FLUID 
UNDEFINED 

Definition at line 64 of file energyRegionCoupledFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ energyRegionCoupledFvPatchScalarField() [1/5]

energyRegionCoupledFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 211 of file energyRegionCoupledFvPatchScalarField.C.

Referenced by energyRegionCoupledFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ energyRegionCoupledFvPatchScalarField() [2/5]

energyRegionCoupledFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 243 of file energyRegionCoupledFvPatchScalarField.C.

References dimensionedInternalField(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, and p.

Here is the call graph for this function:

◆ energyRegionCoupledFvPatchScalarField() [3/5]

energyRegionCoupledFvPatchScalarField ( const energyRegionCoupledFvPatchScalarField ptf,
const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping given energyRegionCoupledFvPatchScalarField.

onto a new patch

Definition at line 226 of file energyRegionCoupledFvPatchScalarField.C.

◆ energyRegionCoupledFvPatchScalarField() [4/5]

Construct as copy.

Definition at line 270 of file energyRegionCoupledFvPatchScalarField.C.

◆ energyRegionCoupledFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 284 of file energyRegionCoupledFvPatchScalarField.C.

◆ ~energyRegionCoupledFvPatchScalarField()

virtual ~energyRegionCoupledFvPatchScalarField ( )
inlinevirtual

Destructor.

Definition at line 179 of file energyRegionCoupledFvPatchScalarField.H.

Member Function Documentation

◆ weights()

Foam::tmp< Foam::scalarField > weights ( ) const
private

◆ patchNeighbourTemperatureField()

Foam::tmp< Foam::scalarField > patchNeighbourTemperatureField ( ) const
private

Return nbr temperature internal field.

Definition at line 376 of file energyRegionCoupledFvPatchScalarField.C.

References fvPatch::faceCells().

Here is the call graph for this function:

◆ patchInternalTemperatureField()

Foam::tmp< Foam::scalarField > patchInternalTemperatureField ( ) const
private

Return local temperature internal field.

Definition at line 395 of file energyRegionCoupledFvPatchScalarField.C.

◆ kappa()

Foam::tmp< Foam::scalarField > kappa ( ) const
private

Return kappa.

Definition at line 103 of file energyRegionCoupledFvPatchScalarField.C.

References basicThermo::dictName, Foam::exit(), Foam::FatalError, FatalErrorInFunction, ThermalDiffusivity< BasicTurbulenceModel >::kappaEff(), and turbulenceModel::propertiesName.

Referenced by energyRegionCoupledFvPatchScalarField::weights().

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

◆ setMethod()

void setMethod ( ) const
private

◆ TypeName()

TypeName ( "compressible::energyRegionCoupled"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<scalar> > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 150 of file energyRegionCoupledFvPatchScalarField.H.

References energyRegionCoupledFvPatchScalarField::energyRegionCoupledFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchField<scalar> > clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Implements coupledFvPatchField< scalar >.

Definition at line 167 of file energyRegionCoupledFvPatchScalarField.H.

References energyRegionCoupledFvPatchScalarField::energyRegionCoupledFvPatchScalarField().

Here is the call graph for this function:

◆ kappaMethod()

word kappaMethod ( ) const
inline

◆ patchNeighbourField()

Foam::tmp< Foam::Field< Foam::scalar > > patchNeighbourField ( ) const
virtual

Return neighbour coupled internal cell data.

Definition at line 349 of file energyRegionCoupledFvPatchScalarField.C.

References fvPatch::faceCells(), and patchi.

Here is the call graph for this function:

◆ snGrad() [1/2]

Foam::tmp< Foam::scalarField > snGrad ( ) const
virtual

Return patch-normal gradient.

Definition at line 300 of file energyRegionCoupledFvPatchScalarField.C.

References Debug.

◆ snGrad() [2/2]

Foam::tmp< Foam::scalarField > snGrad ( const scalarField deltaCoeffs) const
virtual

Return patch-normal gradient.

Note: the deltaCoeffs supplied are not used

Reimplemented from coupledFvPatchField< scalar >.

Definition at line 310 of file energyRegionCoupledFvPatchScalarField.C.

References Debug, and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ evaluate()

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Evaluate the patch field.

Reimplemented from coupledFvPatchField< scalar >.

Definition at line 318 of file energyRegionCoupledFvPatchScalarField.C.

References fvPatchField::evaluate(), Field::operator, and patchi.

Here is the call graph for this function:

◆ updateInterfaceMatrix() [1/2]

void updateInterfaceMatrix ( Field< scalar > &  result,
const scalarField psiInternal,
const scalarField coeffs,
const direction  cmpt,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFvPatchField< scalar >.

Definition at line 409 of file energyRegionCoupledFvPatchScalarField.C.

References forAll, internalField(), patchi, and Field::T().

Here is the call graph for this function:

◆ updateInterfaceMatrix() [2/2]

void updateInterfaceMatrix ( Field< scalar > &  result,
const Field< scalar > &  psiInternal,
const scalarField coeffs,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFvPatchField< scalar >.

Definition at line 450 of file energyRegionCoupledFvPatchScalarField.C.

References NotImplemented.

◆ interfaceFieldType()

virtual const word& interfaceFieldType ( ) const
inlinevirtual

Return the interface type.

Reimplemented from lduInterfaceField.

Definition at line 239 of file energyRegionCoupledFvPatchScalarField.H.

References energyRegionCoupledFvPatchScalarField::regionCoupledPatch_, and regionCoupledBaseFvPatch::regionCoupleType().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from coupledFvPatchField< scalar >.

Definition at line 461 of file energyRegionCoupledFvPatchScalarField.C.

References fvPatchField::write().

Here is the call graph for this function:

Field Documentation

◆ regionCoupledPatch_

const regionCoupledBaseFvPatch& regionCoupledPatch_
private

◆ methodTypeNames_

Methof to extract kappa.

Definition at line 80 of file energyRegionCoupledFvPatchScalarField.H.

Referenced by energyRegionCoupledFvPatchScalarField::kappaMethod().

◆ method_

kappaMethodType method_
mutableprivate

◆ nbrThermoPtr_

const basicThermo* nbrThermoPtr_
mutableprivate

AutoPtr to nbr thermo.

Definition at line 86 of file energyRegionCoupledFvPatchScalarField.H.

Referenced by energyRegionCoupledFvPatchScalarField::setMethod().

◆ thermoPtr_

const basicThermo* thermoPtr_
mutableprivate

AutoPtr to my thermo.

Definition at line 89 of file energyRegionCoupledFvPatchScalarField.H.

Referenced by energyRegionCoupledFvPatchScalarField::setMethod().


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