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< Type >
typedef Type value_type
 
typedef pointPatch Patch
 
typedef calculatedPointPatchField< Type > Calculated
 

Public Member Functions

 TypeName ("surfaceSlipDisplacement")
 Runtime type information. 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 fieldMapper &)
 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< pointPatchVectorField > clone (const DimensionedField< vector, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const searchableSurfaces & surfaces () 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< Type >
 TypeName ("pointPatchField")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const fieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))
 
 declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))
 
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const fieldMapper &)
 Construct by mapping given pointPatchField<Type> onto a new patch. More...
 
 pointPatchField (const pointPatchField< Type > &)=delete
 Disallow copy without setting internal field reference. More...
 
autoPtr< pointPatchField< Type > > clone () const
 Disallow clone without setting internal field reference. More...
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone (const DimensionedField< Type, pointMesh > &iF) const =0
 Construct and return a clone setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone (const pointPatch &patch, const DimensionedField< Type, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
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 objectRegistry & db () const
 Return local objectRegistry. More...
 
const pointPatch & patch () const
 Return patch. More...
 
const DimensionedField< Type, pointMesh > & internalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & primitiveField () const
 Return internal field reference. More...
 
bool updated () const
 Return true if the boundary condition has already been updated. More...
 
tmp< Field< Type > > patchInternalField () const
 Return field created from appropriate internal field values. More...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values. More...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 Return field created from selected internal field values. More...
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void setInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void setInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
virtual void map (const pointPatchField< Type > &, const fieldMapper &)
 Map the given pointPatchField onto this pointPatchField. More...
 
virtual void reset (const pointPatchField< Type > &)
 Reset the pointPatchField to the given 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< Type > &)
 
virtual void operator= (pointPatchField< Type > &&)
 
virtual void operator+= (const pointPatchField< Type > &)
 
virtual void operator-= (const pointPatchField< Type > &)
 
virtual void operator*= (const pointPatchField< scalar > &)
 
virtual void operator/= (const pointPatchField< scalar > &)
 
virtual void operator= (const Field< Type > &)
 
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 pointPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 
template<class Type2 >
Foam::autoPtr< Foam::pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &pf)
 
template<class Type1 >
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 
template<class Type1 >
Foam::tmp< Foam::Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 

Additional Inherited Members

- Static Public Member Functions inherited from pointPatchField< Type >
static autoPtr< pointPatchField< Type > > New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< Type > > New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< Type > > New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const fieldMapper &)
 Return a pointer to a new patchField created on freestore from. More...
 
static autoPtr< pointPatchField< Type > > New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
template<class Type2 >
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &)
 Return a pointer to a new calculatedPointPatchField created on. More...
 
static const word & calculatedType ()
 Return the type of the calculated form of pointPatchField. More...
 
- Static Public Attributes inherited from pointPatchField< Type >
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/4]

Construct from patch, internal field and dictionary.

Definition at line 306 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [2/4]

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

Definition at line 323 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [3/4]

Disallow copy without setting internal field reference.

◆ surfaceSlipDisplacementPointPatchVectorField() [4/4]

Copy constructor setting internal field reference.

Definition at line 341 of file surfaceSlipDisplacementPointPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceSlipDisplacement"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 153 of file surfaceSlipDisplacementPointPatchVectorField.H.

◆ surfaces()

const searchableSurfaces & surfaces ( ) const

Surface to follow. Demand loads surfaceNames.

Definition at line 360 of file surfaceSlipDisplacementPointPatchVectorField.C.

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

Here is the call graph for this function:

◆ evaluate()

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Reimplemented from pointPatchField< Type >.

Definition at line 406 of file surfaceSlipDisplacementPointPatchVectorField.C.

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

Here is the call graph for this function:

◆ operator=()

Disallow default bitwise assignment.


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