slicedFvPatchField< Type > Class Template Reference

Specialization of fvPatchField which creates the underlying fvPatchField as a slice of the given complete field. More...

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

Public Member Functions

 TypeName ("sliced")
 Runtime type information. More...
 
 slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
 Construct from patch, internal field and field to slice. More...
 
 slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. Assign value later. More...
 
 slicedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 slicedFvPatchField (const slicedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given slicedFvPatchField<Type> More...
 
 slicedFvPatchField (const slicedFvPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 slicedFvPatchField (const slicedFvPatchField< 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...
 
virtual ~slicedFvPatchField ()
 Destructor. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
virtual bool assignable () const
 Return false: this patch field is not altered by assignment. 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 void patchInternalField (Field< Type > &) const
 Return internal field next to patch as patch field. More...
 
virtual tmp< Field< Type > > patchNeighbourField (const Field< Type > &iField) const
 Return neighbour coupled given internal cell data. More...
 
virtual tmp< Field< Type > > patchNeighbourField () const
 Return patchField of the values on the patch or on the. 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< 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...
 
virtual void operator= (const UList< Type > &)
 
virtual void operator= (const fvPatchField< Type > &)
 
virtual void operator+= (const fvPatchField< Type > &)
 
virtual void operator-= (const fvPatchField< Type > &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator/= (const fvPatchField< 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)
 
- Public Member Functions inherited from fvPatchField< Type >
 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 Type &value)
 Construct from patch, internal field and value. 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=true)
 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 ~fvPatchField ()=default
 Destructor. More...
 
bool useImplicit () const noexcept
 Use implicit formulation for coupled patches only. More...
 
bool useImplicit (bool on) noexcept
 Set useImplicit on/off. More...
 
virtual bool coupled () const
 Return true if this patch field is coupled. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, volMesh > & 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...
 
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 tmp< Field< Type > > snGrad (const scalarField &deltaCoeffs) const
 Return patch-normal gradient for coupled-patches. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void updateWeightedCoeffs (const scalarField &weights)
 Update the coefficients associated with the patch field. More...
 
virtual tmp< Field< Type > > valueInternalCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientInternalCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix diagonal coefficients corresponding to the. More...
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
 Return the matrix source coefficients corresponding to the. 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...
 
virtual void manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
 Manipulate fvMatrix. More...
 
void check (const fvPatchField< Type > &) const
 Check fvPatchField<Type> against given fvPatchField<Type> More...
 
virtual void operator== (const fvPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > > NewCalculatedType (const fvPatchField< Type2 > &pf)
 

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 > &)
 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...
 
template<class Type2 >
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< Type >
static int disallowGenericFvPatchField
 Debug switch to disallow the use of genericFvPatchField. More...
 

Detailed Description

template<class Type>
class Foam::slicedFvPatchField< Type >

Specialization of fvPatchField which creates the underlying fvPatchField as a slice of the given complete field.

The destructor is wrapped to avoid deallocation of the storage of the complete fields when this is destroyed.

Should only used as a template argument for SlicedGeometricField.

See also
Foam::fvPatchField
Source files

Definition at line 64 of file slicedFvPatchField.H.

Constructor & Destructor Documentation

◆ slicedFvPatchField() [1/6]

slicedFvPatchField ( const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const Field< Type > &  completeField 
)

Construct from patch, internal field and field to slice.

Definition at line 35 of file slicedFvPatchField.C.

References p.

◆ slicedFvPatchField() [2/6]

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

Construct from patch and internal field. Assign value later.

Definition at line 50 of file slicedFvPatchField.C.

◆ slicedFvPatchField() [3/6]

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

Construct from patch, internal field and dictionary.

Definition at line 61 of file slicedFvPatchField.C.

References NotImplemented.

◆ slicedFvPatchField() [4/6]

slicedFvPatchField ( const slicedFvPatchField< Type > &  ptf,
const fvPatch p,
const DimensionedField< Type, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping the given slicedFvPatchField<Type>

onto a new patch

Definition at line 75 of file slicedFvPatchField.C.

References NotImplemented.

◆ slicedFvPatchField() [5/6]

slicedFvPatchField ( const slicedFvPatchField< Type > &  ptf)

Construct as copy.

Definition at line 115 of file slicedFvPatchField.C.

◆ slicedFvPatchField() [6/6]

slicedFvPatchField ( const slicedFvPatchField< Type > &  ptf,
const DimensionedField< Type, volMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 90 of file slicedFvPatchField.C.

◆ ~slicedFvPatchField()

~slicedFvPatchField ( )
virtual

Destructor.

Definition at line 146 of file slicedFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sliced"  )

Runtime type information.

◆ clone() [1/2]

Foam::tmp< Foam::fvPatchField< Type > > clone ( ) const
virtual

Construct and return a clone.

Reimplemented from fvPatchField< Type >.

Definition at line 104 of file slicedFvPatchField.C.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Reimplemented from fvPatchField< Type >.

Definition at line 134 of file slicedFvPatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Reimplemented from fvPatchField< Type >.

Definition at line 141 of file slicedFvPatchField.H.

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

Return false: this patch field is not altered by assignment.

Reimplemented from fvPatchField< Type >.

Definition at line 147 of file slicedFvPatchField.H.

◆ snGrad()

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

Return patch-normal gradient.

Reimplemented from fvPatchField< Type >.

Definition at line 157 of file slicedFvPatchField.C.

References NotImplemented.

◆ patchInternalField() [1/2]

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

Return internal field next to patch as patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 167 of file slicedFvPatchField.C.

References NotImplemented.

◆ patchInternalField() [2/2]

void patchInternalField ( Field< Type > &  ) const
virtual

Return internal field next to patch as patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 176 of file slicedFvPatchField.C.

References NotImplemented.

◆ patchNeighbourField() [1/2]

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

Return neighbour coupled given internal cell data.

Definition at line 185 of file slicedFvPatchField.C.

References NotImplemented.

◆ patchNeighbourField() [2/2]

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

Return patchField of the values on the patch or on the.

opposite patch

Reimplemented from fvPatchField< Type >.

Definition at line 197 of file slicedFvPatchField.C.

References NotImplemented.

◆ initEvaluate()

virtual void initEvaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking)
inlinevirtual

Initialise the evaluation of the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 176 of file slicedFvPatchField.H.

◆ evaluate()

virtual void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking)
inlinevirtual

Evaluate the patch field, sets Updated to false.

Reimplemented from fvPatchField< Type >.

Definition at line 184 of file slicedFvPatchField.H.

◆ valueInternalCoeffs()

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 208 of file slicedFvPatchField.C.

References NotImplemented.

◆ valueBoundaryCoeffs()

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

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 221 of file slicedFvPatchField.C.

References NotImplemented.

◆ gradientInternalCoeffs()

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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 233 of file slicedFvPatchField.C.

References NotImplemented.

◆ gradientBoundaryCoeffs()

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

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 243 of file slicedFvPatchField.C.

References NotImplemented.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 252 of file slicedFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

◆ operator=() [1/3]

virtual void operator= ( const UList< Type > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 219 of file slicedFvPatchField.H.

◆ operator=() [2/3]

virtual void operator= ( const fvPatchField< Type > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 221 of file slicedFvPatchField.H.

◆ operator+=() [1/3]

virtual void operator+= ( const fvPatchField< Type > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 222 of file slicedFvPatchField.H.

◆ operator-=() [1/3]

virtual void operator-= ( const fvPatchField< Type > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 223 of file slicedFvPatchField.H.

◆ operator*=() [1/3]

virtual void operator*= ( const fvPatchField< scalar > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 224 of file slicedFvPatchField.H.

◆ operator/=() [1/3]

virtual void operator/= ( const fvPatchField< scalar > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 225 of file slicedFvPatchField.H.

◆ operator+=() [2/3]

virtual void operator+= ( const Field< Type > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 227 of file slicedFvPatchField.H.

◆ operator-=() [2/3]

virtual void operator-= ( const Field< Type > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 228 of file slicedFvPatchField.H.

◆ operator*=() [2/3]

virtual void operator*= ( const Field< scalar > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 230 of file slicedFvPatchField.H.

◆ operator/=() [2/3]

virtual void operator/= ( const Field< scalar > &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 231 of file slicedFvPatchField.H.

◆ operator=() [3/3]

virtual void operator= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 233 of file slicedFvPatchField.H.

◆ operator+=() [3/3]

virtual void operator+= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 234 of file slicedFvPatchField.H.

◆ operator-=() [3/3]

virtual void operator-= ( const Type &  )
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 235 of file slicedFvPatchField.H.

◆ operator*=() [3/3]

virtual void operator*= ( const  scalar)
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 236 of file slicedFvPatchField.H.

◆ operator/=() [3/3]

virtual void operator/= ( const  scalar)
inlinevirtual

Reimplemented from fvPatchField< Type >.

Definition at line 237 of file slicedFvPatchField.H.


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