Public Types | Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
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
typedef pointPatch Patch
 

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 &)
 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::blocking)
 Update the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from pointPatchField
 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 pointPatchFieldMapper &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 pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 pointPatchField (const pointPatchField< Type > &)
 Construct as copy. 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 ~pointPatchField ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
label size () const
 Return size. More...
 
const pointPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, pointMesh > & dimensionedInternalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & internalField () 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...
 
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 setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
virtual const wordconstraintType () const
 Return the constraint type this pointPatchField implements. More...
 
virtual void autoMap (const pointPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const pointPatchField< Type > &, 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::blocking)
 Initialise evaluation of the patch field (do nothing) More...
 
virtual void operator= (const 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 Type >
tmp< Field< Type > > patchInternalField () const
 

Private Member Functions

void calcProjection (vectorField &displacement) const
 Calculate displacement (w.r.t. points0()) to project onto surface. More...
 
void operator= (const surfaceSlipDisplacementPointPatchVectorField &)
 Disallow default bitwise assignment. More...
 

Private Attributes

const dictionary surfacesDict_
 Names of surfaces. More...
 
const projectMode projectMode_
 How to project/project onto surface. More...
 
const vector projectDir_
 Direction to project. More...
 
const label wedgePlane_
 Plane for 2D wedge case or -1. More...
 
const word frozenPointsZone_
 pointZone with frozen points More...
 
autoPtr< searchableSurfacessurfacesPtr_
 Demand driven: surface to project. More...
 

Static Private Attributes

static const NamedEnum< projectMode, 3 > projectModeNames_
 Project mode names. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from pointPatchField
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 pointPatchFieldMapper &)
 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 wordcalculatedType ()
 Return the type of the calculated form of pointPatchField. More...
 
- Static Public Attributes inherited from pointPatchField
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

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

Needs:

Source files

Definition at line 67 of file surfaceSlipDisplacementPointPatchVectorField.H.

Member Enumeration Documentation

◆ projectMode

Enumerator
NEAREST 
POINTNORMAL 
FIXEDNORMAL 

Definition at line 76 of file surfaceSlipDisplacementPointPatchVectorField.H.

Constructor & Destructor Documentation

◆ surfaceSlipDisplacementPointPatchVectorField() [1/5]

Construct from patch and internal field.

Definition at line 304 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [2/5]

Construct from patch, internal field and dictionary.

Definition at line 318 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [3/5]

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

Definition at line 335 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [4/5]

Construct as copy.

Definition at line 353 of file surfaceSlipDisplacementPointPatchVectorField.C.

◆ surfaceSlipDisplacementPointPatchVectorField() [5/5]

Construct as copy setting internal field reference.

Definition at line 368 of file surfaceSlipDisplacementPointPatchVectorField.C.

Member Function Documentation

◆ calcProjection()

void calcProjection ( vectorField displacement) const
private

◆ operator=()

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "surfaceSlipDisplacement"  )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements pointPatchField.

Definition at line 157 of file surfaceSlipDisplacementPointPatchVectorField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Definition at line 177 of file surfaceSlipDisplacementPointPatchVectorField.H.

◆ surfaces()

const searchableSurfaces & surfaces ( ) const

◆ evaluate()

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

Update the patch field.

Reimplemented from pointPatchField.

Definition at line 412 of file surfaceSlipDisplacementPointPatchVectorField.C.

References pointPatchField::evaluate(), and internalField().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Field Documentation

◆ projectModeNames_

const NamedEnum< surfaceSlipDisplacementPointPatchVectorField::projectMode, 3 > projectModeNames_
staticprivate

◆ surfacesDict_

const dictionary surfacesDict_
private

◆ projectMode_

const projectMode projectMode_
private

How to project/project onto surface.

Definition at line 94 of file surfaceSlipDisplacementPointPatchVectorField.H.

Referenced by surfaceSlipDisplacementPointPatchVectorField::write().

◆ projectDir_

const vector projectDir_
private

Direction to project.

Definition at line 97 of file surfaceSlipDisplacementPointPatchVectorField.H.

Referenced by surfaceSlipDisplacementPointPatchVectorField::write().

◆ wedgePlane_

const label wedgePlane_
private

Plane for 2D wedge case or -1.

Definition at line 100 of file surfaceSlipDisplacementPointPatchVectorField.H.

Referenced by surfaceSlipDisplacementPointPatchVectorField::write().

◆ frozenPointsZone_

const word frozenPointsZone_
private

◆ surfacesPtr_

autoPtr<searchableSurfaces> surfacesPtr_
mutableprivate

Demand driven: surface to project.

Definition at line 106 of file surfaceSlipDisplacementPointPatchVectorField.H.

Referenced by surfaceSlipDisplacementPointPatchVectorField::surfaces().


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