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

#include <displacementMethod.H>

Inheritance diagram for displacementMethod:

[legend]

Collaboration diagram for displacementMethod:

[legend]

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

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

Protected Attributes
fvMesh &	mesh_
labelList	patchIDs_
	IDs of the patches to be moved.
autoPtr< motionSolver >	motionPtr_
scalar	maxDisplacement_
bool	preferPointField_
	Whether the motion solver prefers a point of a vol field as input.

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 55 of file displacementMethod.H.

Constructor & Destructor Documentation

◆ displacementMethod()

displacementMethod	(	fvMesh &	mesh,
		const labelList &	patchIDs )

Construct from components.

Definition at line 36 of file displacementMethod.C.

References maxDisplacement_, mesh, mesh_, motionPtr_, New(), patchIDs, and patchIDs_.

Here is the call graph for this function:

◆ ~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)	)

References mesh, and patchIDs.

◆ New()

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

static

Return a reference to the selected turbulence model.

Definition at line 51 of file displacementMethod.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, mesh, IOobjectOption::MUST_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, and patchIDs.

Referenced by displacementMethod().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preferPointField()

bool preferPointField ( ) const

virtual

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

Reimplemented in displacementMethodelasticityMotionSolver, displacementMethodlaplacianMotionSolver, and displacementMethodpLaplacianMotionSolver.

Definition at line 93 of file displacementMethod.C.

◆ setMotionField() [1/2]

virtual void setMotionField ( const pointVectorField & pointMovement )

pure virtual

Set motion filed related to model based on given motion.

Implemented in displacementMethoddisplacementLaplacian, displacementMethodelasticityMotionSolver, displacementMethodlaplacianMotionSolver, displacementMethodpLaplacianMotionSolver, displacementMethodvelocityLaplacian, 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 displacementMethoddisplacementLaplacian, displacementMethodelasticityMotionSolver, displacementMethodlaplacianMotionSolver, displacementMethodpLaplacianMotionSolver, displacementMethodvelocityLaplacian, 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 displacementMethoddisplacementLaplacian, displacementMethodelasticityMotionSolver, displacementMethodlaplacianMotionSolver, displacementMethodpLaplacianMotionSolver, displacementMethodvelocityLaplacian, 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 displacementMethoddisplacementLaplacian, displacementMethodelasticityMotionSolver, displacementMethodlaplacianMotionSolver, displacementMethodpLaplacianMotionSolver, displacementMethodvelocityLaplacian, 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 99 of file displacementMethod.C.

◆ getMotionSolver()

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

Get access to motionSolver.

Definition at line 105 of file displacementMethod.C.

References motionPtr_.

◆ getMaxDisplacement()

Foam::scalar getMaxDisplacement ( ) const

Get max displacement.

Definition at line 111 of file displacementMethod.C.

References maxDisplacement_.

◆ setPatchIDs()

void setPatchIDs ( const labelList & patchIDs )

inline

Set parametertised patch IDs.

Definition at line 194 of file displacementMethod.H.

References patchIDs, and patchIDs_.

◆ update()

void update ( )

Update mesh.

Definition at line 117 of file displacementMethod.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ mesh_

fvMesh& mesh_

protected

Definition at line 61 of file displacementMethod.H.

Referenced by displacementMethod(), displacementMethodelasticityMotionSolver::setMotionField(), and update().

◆ patchIDs_

labelList patchIDs_

protected

IDs of the patches to be moved.

Definition at line 66 of file displacementMethod.H.

◆ motionPtr_

autoPtr<motionSolver> motionPtr_

protected

Definition at line 68 of file displacementMethod.H.

◆ maxDisplacement_

scalar maxDisplacement_

protected

Definition at line 70 of file displacementMethod.H.

Referenced by displacementMethod(), getMaxDisplacement(), displacementMethoddisplacementLaplacian::setMotionField(), displacementMethodelasticityMotionSolver::setMotionField(), displacementMethodelasticityMotionSolver::setMotionField(), displacementMethodlaplacianMotionSolver::setMotionField(), displacementMethodlaplacianMotionSolver::setMotionField(), displacementMethodpLaplacianMotionSolver::setMotionField(), displacementMethodpLaplacianMotionSolver::setMotionField(), and displacementMethodvelocityLaplacian::setMotionField().

◆ preferPointField_

bool preferPointField_

protected

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

Definition at line 75 of file displacementMethod.H.

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

src/optimisation/adjointOptimisation/adjoint/displacementMethod/displacementMethod/displacementMethod.H
src/optimisation/adjointOptimisation/adjoint/displacementMethod/displacementMethod/displacementMethod.C

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ displacementMethod()

◆ ~displacementMethod()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ preferPointField()

◆ setMotionField() [1/2]

◆ setMotionField() [2/2]

◆ setControlField() [1/2]

◆ setControlField() [2/2]

◆ boundControlField()

◆ getMotionSolver()

◆ getMaxDisplacement()

◆ setPatchIDs()

◆ update()

Member Data Documentation

◆ mesh_

◆ patchIDs_

◆ motionPtr_

◆ maxDisplacement_

◆ preferPointField_