Public Member Functions | Protected Attributes | List of all members
displacementMethodpLaplacianMotionSolver Class Reference

Wrapper class for the pLaplacian motion solver. More...

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

Public Member Functions

 TypeName ("pLaplacianMotionSolver")
 Runtime type information. More...
 
 displacementMethodpLaplacianMotionSolver (fvMesh &mesh, const labelList &patchIDs)
 Construct from components. More...
 
virtual ~displacementMethodpLaplacianMotionSolver ()=default
 Destructor. More...
 
virtual bool preferPointField () const
 Whether the motion solver prefers a point of a vol field as input. More...
 
void setMotionField (const pointVectorField &pointMovement)
 Set motion filed related to model based on given motion. More...
 
void setMotionField (const volVectorField &cellMovement)
 Set motion filed related to model based on given motion. More...
 
void setControlField (const vectorField &controlField)
 Set control field as a vectorField. For methods working with parameters (RBF etc) More...
 
void setControlField (const scalarField &controlField)
 Set control field as a vectorField. For methods working with parameters (RBF etc) More...
 
- Public Member Functions inherited from displacementMethod
 TypeName ("displacementMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, displacementMethod, dictionary,(fvMesh &mesh, const labelList &patchIDs),(mesh, patchIDs))
 
 displacementMethod (fvMesh &mesh, const labelList &patchIDs)
 Construct from components. More...
 
virtual ~displacementMethod ()=default
 Destructor. More...
 
virtual void boundControlField (vectorField &controlField)
 Bound control field in certain directions etc. For methods working with parameters (RBF etc) does nothing by default. More...
 
autoPtr< motionSolver > & getMotionSolver ()
 Get access to motionSolver. More...
 
scalar getMaxDisplacement () const
 Get max displacement. More...
 
void setPatchIDs (const labelList &patchIDs)
 Set parametertised patch IDs. More...
 
void update ()
 Update mesh. More...
 

Protected Attributes

pointVectorField & pointMotionU_
 
volVectorField & cellMotionU_
 
bool resetFields_
 
- Protected Attributes inherited from displacementMethod
fvMesh & mesh_
 
labelList patchIDs_
 IDs of the patches to be moved. More...
 
autoPtr< motionSolver > motionPtr_
 
scalar maxDisplacement_
 
bool preferPointField_
 Whether the motion solver prefers a point of a vol field as input. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from displacementMethod
static autoPtr< displacementMethod > New (fvMesh &mesh, const labelList &patchIDs)
 Return a reference to the selected turbulence model. More...
 

Detailed Description

Wrapper class for the pLaplacian motion solver.

Source files

Definition at line 48 of file displacementMethodpLaplacianMotionSolver.H.

Constructor & Destructor Documentation

◆ displacementMethodpLaplacianMotionSolver()

displacementMethodpLaplacianMotionSolver ( fvMesh &  mesh,
const labelList &  patchIDs 
)

Construct from components.

Definition at line 44 of file displacementMethodpLaplacianMotionSolver.C.

◆ ~displacementMethodpLaplacianMotionSolver()

virtual ~displacementMethodpLaplacianMotionSolver ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "pLaplacianMotionSolver"  )

Runtime type information.

◆ preferPointField()

bool preferPointField ( ) const
virtual

Whether the motion solver prefers a point of a vol field as input.

Reimplemented from displacementMethod.

Definition at line 76 of file displacementMethodpLaplacianMotionSolver.C.

◆ setMotionField() [1/2]

void setMotionField ( const pointVectorField &  pointMovement)
virtual

Set motion filed related to model based on given motion.

Implements displacementMethod.

Definition at line 83 of file displacementMethodpLaplacianMotionSolver.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::gMax(), Foam::mag(), Foam::max(), and Foam::Zero.

Here is the call graph for this function:

◆ setMotionField() [2/2]

void setMotionField ( const volVectorField &  cellMovement)
virtual

Set motion filed related to model based on given motion.

Implements displacementMethod.

Definition at line 133 of file displacementMethodpLaplacianMotionSolver.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::gMax(), Foam::mag(), Foam::max(), and Foam::Zero.

Here is the call graph for this function:

◆ setControlField() [1/2]

void setControlField ( const vectorField &  controlField)
virtual

Set control field as a vectorField. For methods working with parameters (RBF etc)

Implements displacementMethod.

Definition at line 163 of file displacementMethodpLaplacianMotionSolver.C.

References NotImplemented.

◆ setControlField() [2/2]

void setControlField ( const scalarField &  controlField)
virtual

Set control field as a vectorField. For methods working with parameters (RBF etc)

Implements displacementMethod.

Definition at line 172 of file displacementMethodpLaplacianMotionSolver.C.

References NotImplemented.

Member Data Documentation

◆ pointMotionU_

pointVectorField& pointMotionU_
protected

Definition at line 56 of file displacementMethodpLaplacianMotionSolver.H.

◆ cellMotionU_

volVectorField& cellMotionU_
protected

Definition at line 58 of file displacementMethodpLaplacianMotionSolver.H.

◆ resetFields_

bool resetFields_
protected

Definition at line 60 of file displacementMethodpLaplacianMotionSolver.H.

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