processorFaPatchField< Type > Class Template Reference

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

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

Public Member Functions

 TypeName (processorFaPatch::typeName_())
 Runtime type information. More...
 
 processorFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 processorFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 processorFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 processorFaPatchField (const processorFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping given processorFaPatchField onto a new patch. More...
 
 processorFaPatchField (const processorFaPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< faPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 processorFaPatchField (const processorFaPatchField< 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...
 
 ~processorFaPatchField ()
 
virtual bool coupled () const
 Return true if running parallel. More...
 
tmp< Field< Type > > patchNeighbourField () const
 Return neighbour field given internal field. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType)
 Initialise the evaluation of the patch field. More...
 
virtual void evaluate (const Pstream::commsTypes commsType)
 Evaluate the patch field. More...
 
virtual tmp< Field< Type > > snGrad () const
 Return patch-normal gradient. More...
 
virtual void transformCoupleField (solveScalarField &f, const direction cmpt) const
 Transform neighbour field. More...
 
virtual void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual void initInterfaceMatrixUpdate (Field< Type > &result, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &coeffs, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual void updateInterfaceMatrix (Field< Type > &result, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &coeffs, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
virtual label comm () const
 Processor coupled interface functions. More...
 
virtual int myProcNo () const
 Return processor number. More...
 
virtual int neighbProcNo () const
 Return neighbour processor number. More...
 
virtual bool doTransform () const
 Does the patch field perform the transformation. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual int rank () const
 Return rank of component for transform. More...
 
template<>
void transformCoupleField (solveScalarField &f, const direction cmpt) const
 Transform given patch component field. More...
 
template<>
void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const
 
template<>
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
template<>
void transformCoupleField (solveScalarField &f, const direction cmpt) const
 Transform given patch component field. More...
 
template<>
void initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const
 
template<>
void updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const
 Update result field based on interface functionality. More...
 
- Public Member Functions inherited from processorLduInterfaceField
 TypeName ("processorLduInterfaceField")
 Runtime type information. More...
 
 processorLduInterfaceField ()=default
 Construct null. More...
 
virtual ~processorLduInterfaceField ()=default
 Destructor. More...
 
template<class Type >
void transformCoupleField (Field< Type > &f) const
 Transform given patch field. More...
 
void transformCoupleField (solveScalarField &f, const direction cmpt) const
 Transform given patch component field. More...
 
- Public Member Functions inherited from coupledFaPatchField< Type >
 TypeName (coupledFaPatch::typeName_())
 Runtime type information. More...
 
 coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 coupledFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 coupledFaPatchField (const coupledFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 Construct by mapping the given coupledFaPatchField onto a new patch. More...
 
 coupledFaPatchField (const coupledFaPatchField< Type > &)
 Construct as copy. More...
 
 coupledFaPatchField (const coupledFaPatchField< 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 write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from lduInterfaceField
 TypeName ("lduInterfaceField")
 Runtime type information. More...
 
 lduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~lduInterfaceField ()=default
 Destructor. More...
 
const lduInterfaceinterface () const
 Return the interface. More...
 
virtual const wordinterfaceFieldType () const
 Return the interface type. More...
 
bool updatedMatrix () const
 Whether matrix has been updated. More...
 
boolupdatedMatrix ()
 Whether matrix has been updated. More...
 
virtual bool ready () const
 Is all data available. More...
 
template<class Type >
void addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const
 Add/subtract weighted contributions to internal field. 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...
 
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 > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 
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::processorFaPatchField< Type >

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

Definition at line 58 of file processorFaPatchField.H.

Constructor & Destructor Documentation

◆ processorFaPatchField() [1/6]

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

Construct from patch and internal field.

Definition at line 39 of file processorFaPatchField.C.

◆ processorFaPatchField() [2/6]

processorFaPatchField ( const faPatch p,
const DimensionedField< Type, areaMesh > &  iF,
const Field< Type > &  f 
)

Construct from patch and internal field and patch field.

Definition at line 51 of file processorFaPatchField.C.

◆ processorFaPatchField() [3/6]

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

Construct from patch, internal field and dictionary.

Definition at line 89 of file processorFaPatchField.C.

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

Here is the call graph for this function:

◆ processorFaPatchField() [4/6]

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

Construct by mapping given processorFaPatchField onto a new patch.

Definition at line 64 of file processorFaPatchField.C.

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

Here is the call graph for this function:

◆ processorFaPatchField() [5/6]

processorFaPatchField ( const processorFaPatchField< Type > &  ptf)

Construct as copy.

Definition at line 113 of file processorFaPatchField.C.

◆ processorFaPatchField() [6/6]

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

Construct as copy setting internal field reference.

Definition at line 125 of file processorFaPatchField.C.

◆ ~processorFaPatchField()

Definition at line 138 of file processorFaPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( processorFaPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Implements coupledFaPatchField< Type >.

Definition at line 113 of file processorFaPatchField.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.

Implements coupledFaPatchField< Type >.

Definition at line 130 of file processorFaPatchField.H.

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if running parallel.

Reimplemented from coupledFaPatchField< Type >.

Definition at line 151 of file processorFaPatchField.H.

References UPstream::parRun().

Here is the call graph for this function:

◆ patchNeighbourField()

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

Return neighbour field given internal field.

Implements coupledFaPatchField< Type >.

Definition at line 146 of file processorFaPatchField.C.

◆ initEvaluate()

void initEvaluate ( const Pstream::commsTypes  commsType)
virtual

Initialise the evaluation of the patch field.

Reimplemented from coupledFaPatchField< Type >.

Definition at line 154 of file processorFaPatchField.C.

◆ evaluate()

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Evaluate the patch field.

Reimplemented from coupledFaPatchField< Type >.

Definition at line 167 of file processorFaPatchField.C.

References Foam::transform().

Here is the call graph for this function:

◆ snGrad()

Foam::tmp< Foam::Field< Type > > snGrad ( ) const
virtual

Return patch-normal gradient.

Reimplemented from coupledFaPatchField< Type >.

Definition at line 184 of file processorFaPatchField.C.

References Foam::foamVersion::patch.

◆ transformCoupleField() [1/3]

virtual void transformCoupleField ( solveScalarField f,
const direction  cmpt 
) const
inlinevirtual

Transform neighbour field.

Implements coupledFaPatchField< Type >.

Definition at line 182 of file processorFaPatchField.H.

References f(), and processorLduInterfaceField::transformCoupleField().

Here is the call graph for this function:

◆ initInterfaceMatrixUpdate() [1/4]

void initInterfaceMatrixUpdate ( solveScalarField result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const solveScalarField psiInternal,
const scalarField coeffs,
const direction  cmpt,
const Pstream::commsTypes  commsType 
) const
virtual

Initialise neighbour matrix update.

Reimplemented from lduInterfaceField.

Definition at line 192 of file processorFaPatchField.C.

References Foam::foamVersion::patch.

◆ updateInterfaceMatrix() [1/4]

void updateInterfaceMatrix ( solveScalarField result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const solveScalarField psiInternal,
const scalarField coeffs,
const direction  cmpt,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFaPatchField< Type >.

Definition at line 213 of file processorFaPatchField.C.

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

◆ initInterfaceMatrixUpdate() [2/4]

void initInterfaceMatrixUpdate ( Field< Type > &  result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const Field< Type > &  psiInternal,
const scalarField coeffs,
const Pstream::commsTypes  commsType 
) const
virtual

Initialise neighbour matrix update.

Definition at line 255 of file processorFaPatchField.C.

References Foam::foamVersion::patch.

◆ updateInterfaceMatrix() [2/4]

void updateInterfaceMatrix ( Field< Type > &  result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const Field< Type > &  ,
const scalarField coeffs,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFaPatchField< Type >.

Definition at line 275 of file processorFaPatchField.C.

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

◆ comm()

virtual label comm ( ) const
inlinevirtual

Processor coupled interface functions.

Return communicator used for comms

Implements processorLduInterfaceField.

Definition at line 243 of file processorFaPatchField.H.

References UPstream::worldComm.

◆ myProcNo()

virtual int myProcNo ( ) const
inlinevirtual

Return processor number.

Implements processorLduInterfaceField.

Definition at line 249 of file processorFaPatchField.H.

References processorFaPatch::myProcNo().

Here is the call graph for this function:

◆ neighbProcNo()

virtual int neighbProcNo ( ) const
inlinevirtual

Return neighbour processor number.

Implements processorLduInterfaceField.

Definition at line 255 of file processorFaPatchField.H.

References processorFaPatch::neighbProcNo().

Here is the call graph for this function:

◆ doTransform()

virtual bool doTransform ( ) const
inlinevirtual

Does the patch field perform the transformation.

Implements processorLduInterfaceField.

Definition at line 261 of file processorFaPatchField.H.

References coupledFaPatch::parallel().

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements processorLduInterfaceField.

Definition at line 267 of file processorFaPatchField.H.

References processorFaPatch::forwardT().

Here is the call graph for this function:

◆ rank()

virtual int rank ( ) const
inlinevirtual

Return rank of component for transform.

Implements processorLduInterfaceField.

Definition at line 273 of file processorFaPatchField.H.

◆ transformCoupleField() [2/3]

void transformCoupleField ( solveScalarField f,
const direction  cmpt 
) const
virtual

Transform given patch component field.

Implements coupledFaPatchField< Type >.

Definition at line 35 of file processorFaPatchScalarField.C.

◆ initInterfaceMatrixUpdate() [3/4]

void initInterfaceMatrixUpdate ( solveScalarField result,
const bool  add,
const lduAddressing ,
const label  interfacei,
const solveScalarField psiInternal,
const scalarField coeffs,
const  cmpt,
const Pstream::commsTypes  commsType 
) const
virtual

Initialise neighbour matrix update. Add/subtract coupled contributions to matrix

Reimplemented from lduInterfaceField.

Definition at line 44 of file processorFaPatchScalarField.C.

References Foam::foamVersion::patch.

◆ updateInterfaceMatrix() [3/4]

void updateInterfaceMatrix ( solveScalarField result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const solveScalarField psiInternal,
const scalarField coeffs,
const  direction,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFaPatchField< Type >.

Definition at line 65 of file processorFaPatchScalarField.C.

References Foam::add(), forAll, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ transformCoupleField() [3/3]

void transformCoupleField ( solveScalarField f,
const direction  cmpt 
) const
virtual

Transform given patch component field.

Implements coupledFaPatchField< Type >.

◆ initInterfaceMatrixUpdate() [4/4]

void initInterfaceMatrixUpdate ( solveScalarField result,
const bool  add,
const lduAddressing ,
const label  interfacei,
const solveScalarField psiInternal,
const scalarField coeffs,
const  cmpt,
const Pstream::commsTypes  commsType 
) const
virtual

Initialise neighbour matrix update. Add/subtract coupled contributions to matrix

Reimplemented from lduInterfaceField.

◆ updateInterfaceMatrix() [4/4]

void updateInterfaceMatrix ( solveScalarField result,
const bool  add,
const lduAddressing lduAddr,
const label  patchId,
const solveScalarField psiInternal,
const scalarField coeffs,
const  direction,
const Pstream::commsTypes  commsType 
) const
virtual

Update result field based on interface functionality.

Implements coupledFaPatchField< Type >.


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