symmetryFaPatchField< Type > Class Template Reference

Foam::symmetryFaPatchField. More...

Inheritance diagram for symmetryFaPatchField< Type >:
[legend]
Collaboration diagram for symmetryFaPatchField< Type >:
[legend]

Public Member Functions

 TypeName (symmetryFaPatch::typeName_())
 Runtime type information. More...
 
 symmetryFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 symmetryFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 symmetryFaPatchField (const symmetryFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping given symmetryFaPatchField onto a new patch. More...
 
 symmetryFaPatchField (const symmetryFaPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< faPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 symmetryFaPatchField (const symmetryFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< faPatchField< Type > > clone (const DimensionedField< Type, areaMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
- Public Member Functions inherited from basicSymmetryFaPatchField< Type >
 basicSymmetryFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 basicSymmetryFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 basicSymmetryFaPatchField (const basicSymmetryFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping given basicSymmetryFaPatchField onto a new patch. More...
 
 basicSymmetryFaPatchField (const basicSymmetryFaPatchField< Type > &)
 Construct as copy. More...
 
 basicSymmetryFaPatchField (const basicSymmetryFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< Field< Type > > snGrad () const
 Return gradient at boundary. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Evaluate the patch field. More...
 
virtual tmp< Field< Type > > snGradTransformDiag () const
 Return face-gradient transform diagonal. More...
 
template<>
tmp< scalarFieldsnGrad () const
 Return gradient at boundary. More...
 
template<>
void evaluate (const Pstream::commsTypes commsType)
 Evaluate the patch field, sets Updated to false. More...
 
template<>
Foam::tmp< Foam::scalarFieldsnGrad () const
 Return gradient at boundary. More...
 
template<>
void evaluate (const Pstream::commsTypes)
 Evaluate the patch field, sets Updated to false. More...
 
- Public Member Functions inherited from transformFaPatchField< Type >
 TypeName ("transform")
 Runtime type information. More...
 
 transformFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 transformFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 transformFaPatchField (const transformFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping the given transformFaPatchField<Type> More...
 
 transformFaPatchField (const transformFaPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
virtual void operator= (const faPatchField< Type > &)
 
template<>
tmp< scalarFieldgradientInternalCoeffs () const
 
template<>
Foam::tmp< Foam::scalarFieldgradientInternalCoeffs () const
 
- Public Member Functions inherited from faPatchField< Type >
 TypeName ("faPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping the given faPatchField onto a new patch. More...
 
 faPatchField (const faPatchField< Type > &)
 Construct as copy. More...
 
 faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual ~faPatchField ()=default
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const faPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, areaMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & primitiveField () 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...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. More...
 
virtual void autoMap (const faPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const faPatchField< Type > &, const labelList &)
 Reverse map the given faPatchField onto this faPatchField. More...
 
virtual void updateCoeffs ()
 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 tmp< Field< Type > > patchNeighbourField () const
 Return patchField on the opposite patch of a coupled patch. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Initialise the evaluation of the patch field. More...
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 
virtual void write (Ostream &) const
 Write. More...
 
void check (const faPatchField< Type > &) const
 Check faPatchField<Type> against given faPatchField<Type> More...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator+= (const faPatchField< Type > &)
 
virtual void operator-= (const faPatchField< Type > &)
 
virtual void operator*= (const faPatchField< scalar > &)
 
virtual void operator/= (const faPatchField< scalar > &)
 
virtual void operator+= (const Field< Type > &)
 
virtual void operator-= (const Field< Type > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator= (const Type &)
 
virtual void operator+= (const Type &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const faPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::tmp< Foam::faPatchField< Type > > NewCalculatedType (const faPatchField< Type2 > &pf)
 

Additional Inherited Members

- Public Types inherited from faPatchField< Type >
typedef faPatch Patch
 
typedef calculatedFaPatchField< Type > Calculated
 
- Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > > New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)
 
static tmp< faPatchField< Type > > New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)
 
static tmp< faPatchField< Type > > New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 
static tmp< faPatchField< Type > > New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 
template<class Type2 >
static tmp< faPatchField< Type > > NewCalculatedType (const faPatchField< Type2 > &)
 
static const wordcalculatedType ()
 Return the type of the calculated for of faPatchField. More...
 
- Static Public Attributes inherited from faPatchField< Type >
static int disallowGenericFaPatchField
 Debug switch to disallow the use of. More...
 

Detailed Description

template<class Type>
class Foam::symmetryFaPatchField< Type >

Foam::symmetryFaPatchField.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 56 of file symmetryFaPatchField.H.

Constructor & Destructor Documentation

◆ symmetryFaPatchField() [1/5]

symmetryFaPatchField ( const faPatch p,
const DimensionedField< Type, areaMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 34 of file symmetryFaPatchField.C.

◆ symmetryFaPatchField() [2/5]

symmetryFaPatchField ( const faPatch p,
const DimensionedField< Type, areaMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 69 of file symmetryFaPatchField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and p.

Here is the call graph for this function:

◆ symmetryFaPatchField() [3/5]

symmetryFaPatchField ( const symmetryFaPatchField< Type > &  ptf,
const faPatch p,
const DimensionedField< Type, areaMesh > &  iF,
const faPatchFieldMapper mapper 
)

Construct by mapping given symmetryFaPatchField onto a new patch.

Definition at line 45 of file symmetryFaPatchField.C.

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

Here is the call graph for this function:

◆ symmetryFaPatchField() [4/5]

symmetryFaPatchField ( const symmetryFaPatchField< Type > &  ptf)

Construct as copy.

Definition at line 92 of file symmetryFaPatchField.C.

◆ symmetryFaPatchField() [5/5]

symmetryFaPatchField ( const symmetryFaPatchField< Type > &  ptf,
const DimensionedField< Type, areaMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 102 of file symmetryFaPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( symmetryFaPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Reimplemented from basicSymmetryFaPatchField< Type >.

Definition at line 100 of file symmetryFaPatchField.H.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from basicSymmetryFaPatchField< Type >.

Definition at line 117 of file symmetryFaPatchField.H.


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