clampedPlateFaPatchField< Type > Class Template Reference

This BC provides a clamped BC. It sets zero fixe value and zeroGradient. More...

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

Public Member Functions

 TypeName ("clampedPlate")
 Runtime type information. More...
 
 clampedPlateFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
 Construct from patch and internal field. More...
 
 clampedPlateFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 clampedPlateFaPatchField (const clampedPlateFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
 
 clampedPlateFaPatchField (const clampedPlateFaPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< faPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 clampedPlateFaPatchField (const clampedPlateFaPatchField< 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 ~clampedPlateFaPatchField ()
 Destructor. 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 > > valueInternalCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< Type > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< Type > > gradientInternalCoeffs () const
 
virtual tmp< Field< Type > > gradientBoundaryCoeffs () const
 
virtual void write (Ostream &) const
 Write. More...
 
template<>
void evaluate (const Pstream::commsTypes)
 Evaluate the patch field, sets Updated to false. 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 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
 
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::clampedPlateFaPatchField< Type >

This BC provides a clamped BC. It sets zero fixe value and zeroGradient.

Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries (unmodifiable)
    type                clampedPlate;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
type Type name: clampedPlate word yes -

The inherited entries are elaborated in:

Source files

Definition at line 85 of file clampedPlateFaPatchField.H.

Constructor & Destructor Documentation

◆ clampedPlateFaPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 42 of file clampedPlateFaPatchField.C.

◆ clampedPlateFaPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 53 of file clampedPlateFaPatchField.C.

References faPatchField< Type >::operator=().

Here is the call graph for this function:

◆ clampedPlateFaPatchField() [3/5]

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

Construct by mapping the given clampedPlateFaPatchField<Type> onto a new patch

Definition at line 67 of file clampedPlateFaPatchField.C.

◆ clampedPlateFaPatchField() [4/5]

Construct as copy.

Definition at line 80 of file clampedPlateFaPatchField.C.

◆ clampedPlateFaPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 90 of file clampedPlateFaPatchField.C.

◆ ~clampedPlateFaPatchField()

virtual ~clampedPlateFaPatchField ( )
inlinevirtual

Destructor.

Definition at line 158 of file clampedPlateFaPatchField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "clampedPlate"  )

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 129 of file clampedPlateFaPatchField.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 146 of file clampedPlateFaPatchField.H.

◆ snGrad()

virtual tmp<Field<Type> > snGrad ( ) const
inlinevirtual

Return gradient at boundary.

Reimplemented from faPatchField< Type >.

Definition at line 167 of file clampedPlateFaPatchField.H.

References Foam::Zero.

◆ evaluate() [1/2]

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

Evaluate the patch field.

Reimplemented from faPatchField< Type >.

Definition at line 102 of file clampedPlateFaPatchField.C.

References notImplemented, and Foam::type().

Here is the call graph for this function:

◆ valueInternalCoeffs()

tmp< 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 132 of file clampedPlateFaPatchField.C.

◆ valueBoundaryCoeffs()

tmp< 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 143 of file clampedPlateFaPatchField.C.

◆ gradientInternalCoeffs()

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

Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 153 of file clampedPlateFaPatchField.C.

References Foam::foamVersion::patch.

◆ gradientBoundaryCoeffs()

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

Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchField

Reimplemented from faPatchField< Type >.

Definition at line 161 of file clampedPlateFaPatchField.C.

References Foam::foamVersion::patch.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from faPatchField< Type >.

Definition at line 168 of file clampedPlateFaPatchField.C.

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

Here is the call graph for this function:

◆ evaluate() [2/2]

void evaluate ( const Pstream::commsTypes  commsType)
virtual

Evaluate the patch field, sets Updated to false.

Reimplemented from faPatchField< Type >.

Definition at line 109 of file clampedPlateFaPatchField.C.

References edgeID, faPatchField< Type >::evaluate(), forAll, Field< Type >::operator=(), and Foam::foamVersion::patch.

Here is the call graph for this function:

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