surfaceSlipDisplacementFvPatchField< Type > Class Template Reference

fvPatchField corresponding to surfaceSlipDisplacementPointPatchField. Is just a slip type since all hard work (projection) is done in the pointPatch field. More...

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

Public Member Functions

 TypeName ("surfaceSlipDisplacement")
 Runtime type information. More...
 
 surfaceSlipDisplacementFvPatchField (const fvPatch &p, const DimensionedField< Type, volMesh > &iF)
 Construct from patch and internal field. More...
 
 surfaceSlipDisplacementFvPatchField (const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict)
 Construct from patch, internal field and dictionary. More...
 
 surfaceSlipDisplacementFvPatchField (const surfaceSlipDisplacementFvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &mapper)
 Construct by mapping given surfaceSlipDisplacementFvPatchField. More...
 
 surfaceSlipDisplacementFvPatchField (const surfaceSlipDisplacementFvPatchField< Type > &ptf)
 Construct as copy. More...
 
virtual tmp< fvPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 surfaceSlipDisplacementFvPatchField (const surfaceSlipDisplacementFvPatchField< Type > &ptf, const DimensionedField< Type, volMesh > &iF)
 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 void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from slipFvPatchField< Type >
 TypeName ("slip")
 Runtime type information. More...
 
 slipFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 slipFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 slipFvPatchField (const slipFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given slipFvPatchField onto a new patch. More...
 
 slipFvPatchField (const slipFvPatchField< Type > &)
 Construct as copy. More...
 
 slipFvPatchField (const slipFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual bool assignable () const
 Return false: this patch field is not altered by assignment. More...
 
- Public Member Functions inherited from basicSymmetryFvPatchField< Type >
 basicSymmetryFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 basicSymmetryFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 basicSymmetryFvPatchField (const basicSymmetryFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given basicSymmetryFvPatchField onto a new. More...
 
 basicSymmetryFvPatchField (const basicSymmetryFvPatchField< Type > &)
 Construct as copy. More...
 
 basicSymmetryFvPatchField (const basicSymmetryFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 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 transformFvPatchField< Type >
 TypeName ("transform")
 Runtime type information. More...
 
 transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field. More...
 
 transformFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 transformFvPatchField (const transformFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given transformFvPatchField<Type> More...
 
 transformFvPatchField (const transformFvPatchField< Type > &)
 Construct as copy. More...
 
 transformFvPatchField (const transformFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 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 fvPatchField< Type > &)
 
template<>
tmp< scalarFieldvalueInternalCoeffs (const tmp< scalarField > &) const
 
template<>
tmp< scalarFieldgradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
template<>
Foam::tmp< Foam::scalarFieldvalueInternalCoeffs (const tmp< scalarField > &) const
 
template<>
Foam::tmp< Foam::scalarFieldgradientInternalCoeffs () const
 Return the matrix diagonal coefficients corresponding to the. More...
 
- 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 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...
 
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 > > 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
 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
 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 UList< 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)
 
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::surfaceSlipDisplacementFvPatchField< Type >

fvPatchField corresponding to surfaceSlipDisplacementPointPatchField. Is just a slip type since all hard work (projection) is done in the pointPatch field.

Source files

Definition at line 53 of file surfaceSlipDisplacementFvPatchField.H.

Constructor & Destructor Documentation

◆ surfaceSlipDisplacementFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 68 of file surfaceSlipDisplacementFvPatchField.H.

◆ surfaceSlipDisplacementFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 78 of file surfaceSlipDisplacementFvPatchField.H.

◆ surfaceSlipDisplacementFvPatchField() [3/5]

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

Construct by mapping given surfaceSlipDisplacementFvPatchField.

onto a new patch

Definition at line 90 of file surfaceSlipDisplacementFvPatchField.H.

◆ surfaceSlipDisplacementFvPatchField() [4/5]

Construct as copy.

Definition at line 103 of file surfaceSlipDisplacementFvPatchField.H.

◆ surfaceSlipDisplacementFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 121 of file surfaceSlipDisplacementFvPatchField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceSlipDisplacement"  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Reimplemented from slipFvPatchField< Type >.

Definition at line 111 of file surfaceSlipDisplacementFvPatchField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Reimplemented from slipFvPatchField< Type >.

Definition at line 131 of file surfaceSlipDisplacementFvPatchField.H.

◆ write()

virtual void write ( Ostream os) const
inlinevirtual

Write.

Reimplemented from fvPatchField< Type >.

Definition at line 141 of file surfaceSlipDisplacementFvPatchField.H.

References os(), and fvPatchField< Type >::write().

Here is the call graph for this function:

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