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

Displacement fixed by projection onto triSurface. Use in a displacementMotionSolver as a bc on the pointDisplacement field. More...

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

Public Types

enum  projectMode { NEAREST, POINTNORMAL, FIXEDNORMAL }
 

Public Member Functions

 TypeName ("surfaceDisplacement")
 Runtime type information. More...
 
 surfaceDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &)
 Construct from patch and internal field. More...
 
 surfaceDisplacementPointPatchVectorField (const pointPatch &, const DimensionedField< vector, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 surfaceDisplacementPointPatchVectorField (const surfaceDisplacementPointPatchVectorField &, const pointPatch &, const DimensionedField< vector, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patch field onto a new patch. More...
 
 surfaceDisplacementPointPatchVectorField (const surfaceDisplacementPointPatchVectorField &)
 Construct as copy. More...
 
 surfaceDisplacementPointPatchVectorField (const surfaceDisplacementPointPatchVectorField &, const DimensionedField< vector, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< vector > > clone () const
 Return a clone. More...
 
virtual autoPtr< pointPatchField< vector > > 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 updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

Displacement fixed by projection onto triSurface. Use in a displacementMotionSolver as a bc on the pointDisplacement field.

Calculates the projection onto the surface according to the projectMode

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

This displacement is then clipped with the specified velocity * deltaT.

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 72 of file surfaceDisplacementPointPatchVectorField.H.

Member Enumeration Documentation

◆ projectMode

enum projectMode
Enumerator
NEAREST 
POINTNORMAL 
FIXEDNORMAL 

Definition at line 81 of file surfaceDisplacementPointPatchVectorField.H.

Constructor & Destructor Documentation

◆ surfaceDisplacementPointPatchVectorField() [1/5]

surfaceDisplacementPointPatchVectorField ( const pointPatch &  p,
const DimensionedField< vector, pointMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 296 of file surfaceDisplacementPointPatchVectorField.C.

◆ surfaceDisplacementPointPatchVectorField() [2/5]

surfaceDisplacementPointPatchVectorField ( const pointPatch &  p,
const DimensionedField< vector, pointMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 311 of file surfaceDisplacementPointPatchVectorField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ surfaceDisplacementPointPatchVectorField() [3/5]

surfaceDisplacementPointPatchVectorField ( const surfaceDisplacementPointPatchVectorField &  ppf,
const pointPatch &  p,
const DimensionedField< vector, pointMesh > &  iF,
const pointPatchFieldMapper &  mapper 
)

Construct by mapping given patch field onto a new patch.

Definition at line 343 of file surfaceDisplacementPointPatchVectorField.C.

◆ surfaceDisplacementPointPatchVectorField() [4/5]

surfaceDisplacementPointPatchVectorField ( const surfaceDisplacementPointPatchVectorField &  ppf)

Construct as copy.

Definition at line 362 of file surfaceDisplacementPointPatchVectorField.C.

◆ surfaceDisplacementPointPatchVectorField() [5/5]

surfaceDisplacementPointPatchVectorField ( const surfaceDisplacementPointPatchVectorField &  ppf,
const DimensionedField< vector, pointMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 378 of file surfaceDisplacementPointPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "surfaceDisplacement"  )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchField<vector> > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 209 of file surfaceDisplacementPointPatchVectorField.H.

References pointPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Definition at line 218 of file surfaceDisplacementPointPatchVectorField.H.

References pointPatchField< Type >::Clone().

Here is the call graph for this function:

◆ surfaces()

const Foam::searchableSurfaces & surfaces ( ) const

Surface to follow. Demand loads surfaceNames.

Definition at line 396 of file surfaceDisplacementPointPatchVectorField.C.

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

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 423 of file surfaceDisplacementPointPatchVectorField.C.

References TimeState::deltaTValue(), forAll, Foam::mag(), mesh, Foam::min(), Foam::operator==(), Foam::foamVersion::patch, and fvMesh::time().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 464 of file surfaceDisplacementPointPatchVectorField.C.

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

Here is the call graph for this function:
The documentation for this class was generated from the following files: