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:
Collaboration diagram for surfaceSlipDisplacementPointPatchVectorField:

Public Types

enum  projectMode { NEAREST, POINTNORMAL, FIXEDNORMAL }
 
- Public Types inherited from pointPatchField< vector >
typedef vector value_type
 
typedef pointPatch Patch
 
typedef calculatedPointPatchField< vectorCalculated
 

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 patchField<vector> onto a new patch. More...
 
 surfaceSlipDisplacementPointPatchVectorField (const surfaceSlipDisplacementPointPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 surfaceSlipDisplacementPointPatchVectorField (const surfaceSlipDisplacementPointPatchVectorField &, const DimensionedField< vector, pointMesh > &)
 Copy constructor 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...
 
void operator= (const surfaceSlipDisplacementPointPatchVectorField &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from pointPatchField< vector >
 TypeName ("pointPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(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 patchField<Type> onto a new patch. More...
 
 pointPatchField (const pointPatchField< vector > &)=delete
 Disallow copy without setting internal field reference. More...
 
 pointPatchField (const pointPatchField< vector > &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
autoPtr< pointPatchField< vector > > clone () const
 Disallow clone without setting internal field reference. More...
 
Foam::autoPtr< Foam::pointPatchField< vector > > NewCalculatedType (const pointPatchField< Type2 > &pf)
 
virtual ~pointPatchField ()
 Destructor. More...
 
label size () const
 Return size. 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 overridesConstraint () const
 Return true if this overrides the underlying constraint type. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const pointPatchpatch () const
 Return patch. More...
 
const DimensionedField< vector, pointMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< vector > & primitiveField () const
 Return internal field reference. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. 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. More...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 Return field created from selected internal field values. More...
 
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &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,. More...
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 Given the internal field and a patch field,. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch 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= (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 &)
 

Additional Inherited Members

- Static Public Member Functions inherited from pointPatchField< vector >
static autoPtr< pointPatchField< vector > > New (const word &, const pointPatch &, const DimensionedField< vector, pointMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< vector > > New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< vector, pointMesh > &)
 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 const wordcalculatedType ()
 Return the type of the calculated form of pointPatchField. More...
 
- Static Public Attributes inherited from pointPatchField< vector >
static int disallowGenericPointPatchField
 Debug switch to disallow the use of genericPointPatchField. 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.

- NEAREST : nearest

  • POINTNORMAL : intersection with point normal
  • FIXEDNORMAL : intersection with fixed vector

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

Needs:

  • geometry : dictionary with searchableSurfaces. (usually triSurfaceMeshes in constant/triSurface)
  • projectMode : see above
  • projectDirection : if projectMode = fixedNormal
  • wedgePlane : -1 or component to knock out of intersection normal
  • frozenPointsZone : empty or name of pointZone containing points that do not move
Source files

Definition at line 67 of file surfaceSlipDisplacementPointPatchVectorField.H.

Member Enumeration Documentation

◆ projectMode

Enumerator
NEAREST 
POINTNORMAL 
FIXEDNORMAL 

Definition at line 75 of file surfaceSlipDisplacementPointPatchVectorField.H.

Constructor & Destructor Documentation

◆ surfaceSlipDisplacementPointPatchVectorField() [1/5]

◆ surfaceSlipDisplacementPointPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

Definition at line 319 of file surfaceSlipDisplacementPointPatchVectorField.C.

References surfaceSlipDisplacementPointPatchVectorField::surfaceSlipDisplacementPointPatchVectorField().

Here is the call graph for this function:

◆ surfaceSlipDisplacementPointPatchVectorField() [3/5]

Construct by mapping given patchField<vector> onto a new patch.

Definition at line 336 of file surfaceSlipDisplacementPointPatchVectorField.C.

References surfaceSlipDisplacementPointPatchVectorField::surfaceSlipDisplacementPointPatchVectorField().

Here is the call graph for this function:

◆ surfaceSlipDisplacementPointPatchVectorField() [4/5]

Disallow copy without setting internal field reference.

◆ surfaceSlipDisplacementPointPatchVectorField() [5/5]

Copy constructor setting internal field reference.

Definition at line 354 of file surfaceSlipDisplacementPointPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceSlipDisplacement"  )

Runtime type information.

◆ clone()

◆ surfaces()

const searchableSurfaces & surfaces ( ) const

Surface to follow. Demand loads surfaceNames.

Definition at line 371 of file surfaceSlipDisplacementPointPatchVectorField.C.

References pointPatchField< vector >::db(), surfaceSlipDisplacementPointPatchVectorField::evaluate(), searchableSurface::geometryDir(), IOobject::MUST_READ, and IOobject::NO_WRITE.

Referenced by surfaceSlipDisplacementPointPatchVectorField::clone(), and NamedEnum< compressibleField, 8 >::names().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ evaluate()

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from pointPatchField< vector >.

Definition at line 417 of file surfaceSlipDisplacementPointPatchVectorField.C.

References Foam::makePointPatchTypeField(), word::null, pointPatchField< vector >::write(), and Foam::writeEntry().

Referenced by surfaceSlipDisplacementPointPatchVectorField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

Disallow default bitwise assignment.


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