Public Types | Public Member Functions | List of all members
surfaceSlipDisplacementPointPatchVectorField Class Reference

Displacement follows a triSurface. Use in a displacementMotionSolver as a bc on the pointDisplacement field. Following is done by calculating the projection onto the surface according to the projectMode. More...

Inheritance diagram for surfaceSlipDisplacementPointPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for surfaceSlipDisplacementPointPatchVectorField:
Collaboration graph
[legend]

Public Types

enum  projectMode { NEAREST, POINTNORMAL, FIXEDNORMAL }
 
- Public Types inherited from pointPatchField< vector >
typedef vector value_type
 The Field value_type. More...
 
typedef DimensionedField< vector, pointMeshInternal
 The internal field type associated with the patch field. More...
 
typedef pointPatch Patch
 The patch type for the patch field. More...
 
typedef calculatedPointPatchField< vectorCalculated
 Type for a calculated patch. More...
 

Public Member Functions

 TypeName ("surfaceSlipDisplacement")
 Runtime type information. More...
 
 surfaceSlipDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
 Construct from patch and internal field. More...
 
 surfaceSlipDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 surfaceSlipDisplacementPointPatchVectorField (const surfaceSlipDisplacementPointPatchVectorField &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patch field onto a new patch. More...
 
 surfaceSlipDisplacementPointPatchVectorField (const surfaceSlipDisplacementPointPatchVectorField &)
 Construct as copy. More...
 
virtual autoPtr< pointPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 surfaceSlipDisplacementPointPatchVectorField (const surfaceSlipDisplacementPointPatchVectorField &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchVectorFieldclone (const DimensionedField< vector, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const searchableSurfacessurfaces () const
 Surface to follow. Demand loads surfaceNames. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Update the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from pointPatchField< vector >
 declareRunTimeSelectionTable (autoPtr, pointPatchField, patch,(const pointPatch &p, const DimensionedField< vector, pointMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< vector > &ptf, const pointPatch &p, const DimensionedField< vector, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< vector, pointMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 pointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
 Construct from patch and internal field. More...
 
 pointPatchField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pointPatchField (const pointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patch field onto a new patch. More...
 
 pointPatchField (const pointPatchField< vector > &)
 Construct as copy. More...
 
 pointPatchField (const pointPatchField< vector > &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
Foam::autoPtr< Foam::pointPatchField< vector > > NewCalculatedType (const pointPatchField< Type2 > &pf)
 
virtual ~pointPatchField ()=default
 Destructor. More...
 
label size () const
 Return the patch size. More...
 
const DimensionedField< vector, pointMesh > & internalField () const noexcept
 Return const-reference to the dimensioned internal field. More...
 
const Field< vector > & primitiveField () const noexcept
 Return const-reference to the internal field values. More...
 
tmp< Field< vector > > patchInternalField () const
 Return field created from appropriate internal field values. More...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values given internal field reference. More...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelUList &meshPoints) const
 Return field created from selected internal field values given internal field reference. More...
 
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelUList &meshPoints) const
 
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field, add the patch field to the internal field. More...
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &points) const
 Given the internal field and a patch field, add selected elements of the patch field to the internal field. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &meshPoints) const
 Given the internal field and a patch field, set the patch field in the internal field. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field, set the patch field in the internal field. More...
 
virtual void autoMap (const pointPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const pointPatchField< vector > &, const labelList &)
 Reverse map the given pointPatchField onto this pointPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Initialise evaluation of the patch field (do nothing) More...
 
virtual void operator= (const pointPatchField< vector > &)
 
virtual void operator= (const Field< vector > &)
 
virtual void operator= (const vector &)
 
virtual void operator+= (const pointPatchField< vector > &)
 
virtual void operator+= (const Field< vector > &)
 
virtual void operator+= (const vector &)
 
virtual void operator-= (const pointPatchField< vector > &)
 
virtual void operator-= (const Field< vector > &)
 
virtual void operator-= (const vector &)
 
virtual void operator*= (const pointPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const pointPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const pointPatchField< vector > &)
 
virtual void operator== (const Field< vector > &)
 
virtual void operator== (const vector &)
 
void negate ()
 Negate the field inplace. Dummy placeholder for FieldField. More...
 
void normalise ()
 Normalise the field inplace. Dummy placeholder for FieldField. More...
 
- Public Member Functions inherited from pointPatchFieldBase
 TypeName ("pointPatchField")
 Runtime type information. More...
 
 pointPatchFieldBase (const pointPatch &p)
 Construct from patch. More...
 
 pointPatchFieldBase (const pointPatch &p, const word &patchType)
 Construct from patch and patch type. More...
 
 pointPatchFieldBase (const pointPatch &p, const dictionary &dict)
 Construct from patch and dictionary. More...
 
 pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p)
 Copy construct with new patch. More...
 
 pointPatchFieldBase (const pointPatchFieldBase &)
 Copy construct. More...
 
virtual ~pointPatchFieldBase ()=default
 Destructor. More...
 
virtual bool fixesValue () const
 True if the patch field fixes a value. More...
 
virtual bool coupled () const
 True if the patch field is coupled. More...
 
virtual const wordconstraintType () const
 The constraint type the pointPatchField implements. More...
 
const objectRegistrydb () const
 The associated objectRegistry. More...
 
const pointPatchpatch () const noexcept
 Return the patch. More...
 
const wordpatchType () const noexcept
 The optional patch type. More...
 
wordpatchType () noexcept
 The optional patch type. More...
 
bool updated () const noexcept
 True if the boundary condition has already been updated. More...
 
bool manipulatedMatrix () const noexcept
 True if the matrix has already been manipulated. Currently ignored (always false) for pointPatchField. More...
 
void checkPatch (const pointPatchFieldBase &rhs) const
 Check that patches are identical. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from pointPatchField< vector >
static autoPtr< pointPatchField< vector > > New (const word &patchFieldType, const pointPatch &p, const DimensionedField< vector, pointMesh > &iF)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< vector > > New (const word &patchFieldType, const word &actualPatchType, const pointPatch &p, const DimensionedField< vector, pointMesh > &iF)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< vector > > New (const pointPatchField< vector > &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static autoPtr< pointPatchField< vector > > New (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static autoPtr< pointPatchField< vector > > NewCalculatedType (const pointPatchField< Type2 > &)
 Return a pointer to a new calculatedPointPatchField created on. More...
 
- Static Public Member Functions inherited from pointPatchFieldBase
static const wordemptyType () noexcept
 The type name for empty patch fields. More...
 
static const wordcalculatedType () noexcept
 The type name for calculated patch fields. More...
 
static const wordzeroGradientType () noexcept
 The type name for zeroGradient patch fields. More...
 
- Static Public Attributes inherited from pointPatchFieldBase
static int disallowGenericPatchField
 Debug switch to disallow the use of generic pointPatchField. More...
 
- Protected Member Functions inherited from pointPatchFieldBase
virtual void readDict (const dictionary &dict)
 Read dictionary entries. More...
 
void setUpdated (bool state) noexcept
 Set updated state. More...
 
void setManipulated (bool state) noexcept
 Set matrix manipulated state. Currently a no-op for pointPatchField. More...
 

Detailed Description

Displacement follows a triSurface. Use in a displacementMotionSolver as a bc on the pointDisplacement field. Following is done by calculating the projection onto the surface according to the projectMode.

Optionally (intersection only) removes a component ("wedgePlane") to stay in 2D.

Needs:

Source files

Definition at line 65 of file surfaceSlipDisplacementPointPatchVectorField.H.

Member Enumeration Documentation

◆ projectMode

Enumerator
NEAREST 
POINTNORMAL 
FIXEDNORMAL 

Definition at line 74 of file surfaceSlipDisplacementPointPatchVectorField.H.

Constructor & Destructor Documentation

◆ surfaceSlipDisplacementPointPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 287 of file surfaceSlipDisplacementPointPatchVectorField.C.

Referenced by surfaceSlipDisplacementPointPatchVectorField::clone().

Here is the caller graph for this function:

◆ surfaceSlipDisplacementPointPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

Definition at line 301 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [3/5]

Construct by mapping given patch field onto a new patch.

Definition at line 318 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [4/5]

Construct as copy.

Definition at line 336 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 351 of file surfaceSlipDisplacementPointPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceSlipDisplacement"  )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements pointPatchField< vector >.

Definition at line 188 of file surfaceSlipDisplacementPointPatchVectorField.H.

References surfaceSlipDisplacementPointPatchVectorField::surfaceSlipDisplacementPointPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<pointPatchVectorField> clone ( const DimensionedField< vector, pointMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Implements pointPatchField< vector >.

Definition at line 212 of file surfaceSlipDisplacementPointPatchVectorField.H.

References surfaceSlipDisplacementPointPatchVectorField::surfaceSlipDisplacementPointPatchVectorField().

Here is the call graph for this function:

◆ surfaces()

const Foam::searchableSurfaces & surfaces ( ) const

Surface to follow. Demand loads surfaceNames.

Definition at line 368 of file surfaceSlipDisplacementPointPatchVectorField.C.

References IOobjectOption::MUST_READ, and IOobjectOption::NO_WRITE.

◆ evaluate()

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

Update the patch field.

Reimplemented from pointPatchField< vector >.

Definition at line 396 of file surfaceSlipDisplacementPointPatchVectorField.C.

References pointPatchField< vector >::evaluate().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from pointPatchField< vector >.

Definition at line 416 of file surfaceSlipDisplacementPointPatchVectorField.C.

References word::null, os(), pointPatchField< Type >::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

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