Public Member Functions | List of all members
genericFvPatchField< Type > Class Template Reference

This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition. More...

Inheritance diagram for genericFvPatchField< Type >:
Inheritance graph
[legend]
Collaboration diagram for genericFvPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("generic")
 
 genericFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 genericFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
 genericFvPatchField (const genericFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
 genericFvPatchField (const genericFvPatchField< Type > &)=default
 
 genericFvPatchField (const genericFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone (const DimensionedField< Type, volMesh > &iF) const
 
virtual void write (Ostream &) const
 
virtual void autoMap (const fvPatchFieldMapper &)
 
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 
tmp< Field< Type > > gradientInternalCoeffs () const
 
tmp< Field< Type > > gradientBoundaryCoeffs () const
 
- Public Member Functions inherited from calculatedFvPatchField< Type >
 TypeName ("calculated")
 
 calculatedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 
 calculatedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 calculatedFvPatchField (const calculatedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 calculatedFvPatchField (const calculatedFvPatchField< Type > &)
 
 calculatedFvPatchField (const calculatedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual bool fixesValue () const
 
tmp< Field< Type > > gradientInternalCoeffs () const
 
tmp< Field< Type > > gradientBoundaryCoeffs () const
 
- Public Member Functions inherited from fvPatchField< Type >
 TypeName ("fvPatchField")
 
 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 > &)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 
 fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
 
 fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
 fvPatchField (const fvPatchField< Type > &)
 
 fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 
virtual tmp< fvPatchField< Type > > clone () const
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatch &p)
 
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 
virtual ~fvPatchField ()=default
 
bool useImplicit () const noexcept
 
bool useImplicit (bool on) noexcept
 
virtual bool fixesValue () const
 
virtual bool assignable () const
 
virtual bool coupled () const
 
const objectRegistrydb () const
 
const fvPatchpatch () const
 
const DimensionedField< Type, volMesh > & internalField () const
 
const Field< Type > & primitiveField () const
 
const wordpatchType () const
 
wordpatchType ()
 
bool updated () const
 
bool manipulatedMatrix () const
 
virtual tmp< Field< Type > > snGrad () const
 
virtual tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 
virtual void updateCoeffs ()
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 
virtual tmp< Field< Type > > patchInternalField () const
 
virtual void patchInternalField (Field< Type > &) const
 
virtual tmp< Field< Type > > patchNeighbourField () const
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix)
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
 
void check (const fvPatchField< Type > &) const
 
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 &)
 
- Public Member Functions inherited from genericPatchFieldBase
 genericPatchFieldBase ()=default
 
 genericPatchFieldBase (const genericPatchFieldBase &)=default
 
 genericPatchFieldBase (genericPatchFieldBase &&)=default
 
 genericPatchFieldBase (const dictionary &dict)
 
const wordactualType () const noexcept
 

Additional Inherited Members

- Public Types inherited from fvPatchField< Type >
typedef fvPatch Patch
 
typedef calculatedFvPatchField< Type > Calculated
 
- Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > > New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
 
static tmp< fvPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
 
static tmp< fvPatchField< Type > > New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 
static tmp< fvPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatch &)
 
static tmp< fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &)
 
static const wordcalculatedType ()
 
- Static Public Attributes inherited from fvPatchField< Type >
static int disallowGenericFvPatchField
 
- Protected Member Functions inherited from genericPatchFieldBase
void genericFatalSolveError (const word &patchName, const IOobject &io) const
 
void reportMissingEntry (const word &entryName, const word &patchName, const IOobject &io) const
 
void processGeneric (const label patchSize, const word &patchName, const IOobject &io, const bool separateValue)
 
bool processEntry (const entry &dEntry, const label patchSize, const word &patchName, const IOobject &io)
 
void putEntry (const entry &e, Ostream &os) const
 
void writeGeneric (Ostream &os, const bool separateValue) const
 
template<class MapperType >
void mapGeneric (const genericPatchFieldBase &rhs, const MapperType &mapper)
 
template<class MapperType >
void autoMapGeneric (const MapperType &mapper)
 
void rmapGeneric (const genericPatchFieldBase &rhs, const labelList &addr)
 
 genericPatchFieldBase (const Foam::zero, const genericPatchFieldBase &)
 
- Protected Attributes inherited from genericPatchFieldBase
word actualTypeName_
 
dictionary dict_
 
HashPtrTable< scalarFieldscalarFields_
 
HashPtrTable< vectorFieldvectorFields_
 
HashPtrTable< sphericalTensorFieldsphTensorFields_
 
HashPtrTable< symmTensorFieldsymmTensorFields_
 
HashPtrTable< tensorFieldtensorFields_
 

Detailed Description

template<class Type>
class Foam::genericFvPatchField< Type >

This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition.

See also
Foam::calculatedFvPatchField
Source files

Definition at line 54 of file genericFvPatchField.H.

Constructor & Destructor Documentation

◆ genericFvPatchField() [1/5]

genericFvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF 
)

Definition at line 29 of file genericFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ genericFvPatchField() [2/5]

genericFvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const dictionary dict 
)

Definition at line 46 of file genericFvPatchField.C.

References dict, and Foam::foamVersion::patch.

◆ genericFvPatchField() [3/5]

genericFvPatchField ( const genericFvPatchField< Type > &  rhs,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Definition at line 71 of file genericFvPatchField.C.

◆ genericFvPatchField() [4/5]

genericFvPatchField ( const genericFvPatchField< Type > &  )
default

◆ genericFvPatchField() [5/5]

genericFvPatchField ( const genericFvPatchField< Type > &  rhs,
const DimensionedField< Type, volMesh > &  iF 
)

Definition at line 87 of file genericFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic"  )

◆ clone() [1/2]

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

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 96 of file genericFvPatchField.H.

◆ clone() [2/2]

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

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 116 of file genericFvPatchField.H.

◆ write()

void write ( Ostream os) const
virtual

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 100 of file genericFvPatchField.C.

References os().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 110 of file genericFvPatchField.C.

◆ rmap()

void rmap ( const fvPatchField< Type > &  rhs,
const labelList addr 
)
virtual

Reimplemented from fvPatchField< Type >.

Definition at line 121 of file genericFvPatchField.C.

◆ valueInternalCoeffs()

Foam::tmp< Foam::Field< Type > > valueInternalCoeffs ( const tmp< scalarField > &  ) const
virtual

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 139 of file genericFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > &  ) const
virtual

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 160 of file genericFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ gradientInternalCoeffs()

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs

Definition at line 180 of file genericFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ gradientBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs

Definition at line 197 of file genericFvPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::name(), and Foam::foamVersion::patch.

Here is the call graph for this function:

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