emptyFaPatchField< Type > Class Template Reference

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd. More...

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

Public Member Functions

 TypeName (emptyFaPatch::typeName_())
 Runtime type information. More...
 
 emptyFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 emptyFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 emptyFaPatchField (const emptyFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping given emptyFaPatchField onto a new patch. More...
 
 emptyFaPatchField (const emptyFaPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< faPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 emptyFaPatchField (const emptyFaPatchField< 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...
 
virtual ~emptyFaPatchField ()=default
 Destructor. 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...
 
void updateCoeffs ()
 Update the coefficients associated with the patch field. 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...
 
tmp< Field< Type > > gradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
tmp< Field< Type > > gradientBoundaryCoeffs () const
 Return the matrix source coefficients corresponding to the. More...
 
- 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 tmp< Field< Type > > snGrad () const
 Return patch-normal gradient. 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 void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Evaluate the patch field, sets Updated to false. 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< 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::emptyFaPatchField< Type >

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 56 of file emptyFaPatchField.H.

Constructor & Destructor Documentation

◆ emptyFaPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 36 of file emptyFaPatchField.C.

◆ emptyFaPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 71 of file emptyFaPatchField.C.

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

Here is the call graph for this function:

◆ emptyFaPatchField() [3/5]

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

Construct by mapping given emptyFaPatchField onto a new patch.

Definition at line 47 of file emptyFaPatchField.C.

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

Here is the call graph for this function:

◆ emptyFaPatchField() [4/5]

emptyFaPatchField ( const emptyFaPatchField< Type > &  ptf)

Construct as copy.

Definition at line 94 of file emptyFaPatchField.C.

◆ emptyFaPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 109 of file emptyFaPatchField.C.

◆ ~emptyFaPatchField()

virtual ~emptyFaPatchField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( emptyFaPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Reimplemented from faPatchField< Type >.

Definition at line 100 of file emptyFaPatchField.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 faPatchField< Type >.

Definition at line 117 of file emptyFaPatchField.H.

◆ autoMap()

virtual void autoMap ( const faPatchFieldMapper )
inlinevirtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from faPatchField< Type >.

Definition at line 138 of file emptyFaPatchField.H.

◆ rmap()

virtual void rmap ( const faPatchField< Type > &  ,
const labelList  
)
inlinevirtual

Reverse map the given faPatchField onto this faPatchField.

Reimplemented from faPatchField< Type >.

Definition at line 145 of file emptyFaPatchField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

This only checks to see the case is actually 1D or 2D for which this boundary condition is valid

Reimplemented from faPatchField< Type >.

Definition at line 121 of file emptyFaPatchField.C.

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

Here is the call graph for this function:

◆ valueInternalCoeffs()

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 163 of file emptyFaPatchField.H.

References faPatchField< Type >::New().

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

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

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 173 of file emptyFaPatchField.H.

References faPatchField< Type >::New().

Here is the call graph for this function:

◆ gradientInternalCoeffs()

tmp<Field<Type> > gradientInternalCoeffs ( ) const
inlinevirtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 182 of file emptyFaPatchField.H.

◆ gradientBoundaryCoeffs()

tmp<Field<Type> > gradientBoundaryCoeffs ( ) const
inlinevirtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 189 of file emptyFaPatchField.H.


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