Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
displacementMethod Class Referenceabstract

Abstract base class for displacement methods, which are a set or wrapper classes allowing to change the driving force of mesh motion solvers. More...

Inheritance diagram for displacementMethod:
[legend]
Collaboration diagram for displacementMethod:
[legend]

Public Member Functions

 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 setMotionField (const pointVectorField &pointMovement)=0
 Set motion filed related to model based on given motion. More...
 
virtual void setMotionField (const volVectorField &cellMovement)=0
 Set motion filed related to model based on given motion. More...
 
virtual void setControlField (const vectorField &controlField)=0
 
virtual void setControlField (const scalarField &controlField)=0
 
virtual void boundControlField (vectorField &controlField)
 
autoPtr< motionSolver > & getMotionSolver ()
 Get access to motionSolver. More...
 
scalar getMaxDisplacement () const
 Get max displacement. More...
 
void update ()
 Update mesh. More...
 

Static Public Member Functions

static autoPtr< displacementMethod > New (fvMesh &mesh, const labelList &patchIDs)
 Return a reference to the selected turbulence model. More...
 

Protected Attributes

fvMesh & mesh_
 
const labelList & patchIDs_
 IDs of the patches to be moved. More...
 
autoPtr< motionSolver > motionPtr_
 
scalar maxDisplacement_
 

Detailed Description

Abstract base class for displacement methods, which are a set or wrapper classes allowing to change the driving force of mesh motion solvers.

Source files

Definition at line 59 of file displacementMethod.H.

Constructor & Destructor Documentation

◆ displacementMethod()

displacementMethod ( fvMesh &  mesh,
const labelList &  patchIDs 
)

Construct from components.

Definition at line 44 of file displacementMethod.C.

◆ ~displacementMethod()

virtual ~displacementMethod ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "displacementMethod"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
displacementMethod  ,
dictionary  ,
(fvMesh &mesh, const labelList &patchIDs)  ,
(mesh, patchIDs)   
)

◆ New()

Foam::autoPtr< Foam::displacementMethod > New ( fvMesh &  mesh,
const labelList &  patchIDs 
)
static

Return a reference to the selected turbulence model.

Definition at line 59 of file displacementMethod.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, and mesh.

Here is the call graph for this function:

◆ setMotionField() [1/2]

virtual void setMotionField ( const pointVectorField &  pointMovement)
pure virtual

Set motion filed related to model based on given motion.

Implemented in displacementMethodelasticityMotionSolver, displacementMethodvelocityLaplacian, displacementMethodlaplacianMotionSolver, displacementMethoddisplacementLaplacian, and displacementMethodvolumetricBSplinesMotionSolver.

◆ setMotionField() [2/2]

virtual void setMotionField ( const volVectorField &  cellMovement)
pure virtual

Set motion filed related to model based on given motion.

Implemented in displacementMethodelasticityMotionSolver, displacementMethodvelocityLaplacian, displacementMethodlaplacianMotionSolver, displacementMethoddisplacementLaplacian, and displacementMethodvolumetricBSplinesMotionSolver.

◆ setControlField() [1/2]

virtual void setControlField ( const vectorField &  controlField)
pure virtual

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

Implemented in displacementMethodelasticityMotionSolver, displacementMethodvelocityLaplacian, displacementMethodlaplacianMotionSolver, displacementMethoddisplacementLaplacian, and displacementMethodvolumetricBSplinesMotionSolver.

◆ setControlField() [2/2]

virtual void setControlField ( const scalarField &  controlField)
pure virtual

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

Implemented in displacementMethodelasticityMotionSolver, displacementMethodvelocityLaplacian, displacementMethodlaplacianMotionSolver, displacementMethoddisplacementLaplacian, and displacementMethodvolumetricBSplinesMotionSolver.

◆ boundControlField()

void boundControlField ( vectorField &  controlField)
virtual

Bound control field in certain directions etc. For methods working with parameters (RBF etc) does nothing by default

Reimplemented in displacementMethodvolumetricBSplinesMotionSolver.

Definition at line 100 of file displacementMethod.C.

◆ getMotionSolver()

Foam::autoPtr< Foam::motionSolver > & getMotionSolver ( )

Get access to motionSolver.

Definition at line 106 of file displacementMethod.C.

◆ getMaxDisplacement()

Foam::scalar getMaxDisplacement ( ) const

Get max displacement.

Definition at line 112 of file displacementMethod.C.

◆ update()

void update ( )

Update mesh.

Definition at line 118 of file displacementMethod.C.

References Foam::endl(), Foam::gMax(), Foam::Info, and Foam::mag().

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

fvMesh& mesh_
protected

Definition at line 65 of file displacementMethod.H.

◆ patchIDs_

const labelList& patchIDs_
protected

IDs of the patches to be moved.

Definition at line 68 of file displacementMethod.H.

◆ motionPtr_

autoPtr<motionSolver> motionPtr_
protected

Definition at line 70 of file displacementMethod.H.

◆ maxDisplacement_

scalar maxDisplacement_
protected

Definition at line 72 of file displacementMethod.H.

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