lumpedPointMovement Class Reference

The movement driver that describes initial point locations, the current state of the points/rotations, and forwarding to the externalFileCoupler communication coordinator. More...

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

Public Types

enum class  outputFormatType { PLAIN , DICTIONARY }
 Output format types. More...
 
enum  scalingType { LENGTH = 0 , FORCE , MOMENT }
 Output format types. More...
 

Public Member Functions

 lumpedPointMovement ()
 Default construct. More...
 
 lumpedPointMovement (const dictionary &dict, label ownerId=-1)
 Construct from dictionary, optionally with some owner information. More...
 
virtual ~lumpedPointMovement ()=default
 Destructor. More...
 
void readDict (const dictionary &dict)
 Update settings from dictionary. More...
 
bool empty () const
 If no number of lumped points (locations) were specified. More...
 
label size () const
 The number of lumped points (number of locations) More...
 
label ownerId () const
 An owner Id, if needed for bookkeeping purposes. More...
 
void ownerId (label id)
 Change the owner id, if needed for bookkeeping purposes. More...
 
const externalFileCouplercoupler () const
 Communication control. More...
 
externalFileCouplercoupler ()
 Communication control. More...
 
bool couplingPending (const label timeIndex) const
 Check if coupling is pending (according to the calcFrequency) More...
 
void couplingCompleted (const label timeIndex) const
 Register that coupling is completed at this calcFrequency. More...
 
const lumpedPointStatestate0 () const
 The initial state (positions/rotations) More...
 
const lumpedPointStatestate () const
 The current state (positions/rotations) More...
 
const pointorigin () const
 The offset for lumped points, used on input. More...
 
void scalePoints (lumpedPointState &state) const
 Scale the lumped points (on input). More...
 
scalar relax () const
 The relaxation factor when changing states. More...
 
scalar & relax ()
 The relaxation factor when changing states. More...
 
const wordinputName () const
 The input (state) file name. More...
 
const wordoutputName () const
 The output (forces) file name. More...
 
const wordlogName () const
 The log file name. More...
 
lumpedPointState::inputFormatType inputFormat () const
 The input (state) file format. More...
 
lumpedPointMovement::outputFormatType outputFormat () const
 The output (forces) file format. More...
 
quaternion::eulerOrder rotationOrder () const
 The Euler-angle rotation order. More...
 
bool degrees () const
 Rotation angles in degrees. More...
 
bool hasPatchControl (const label patchIndex) const
 Check if patch control exists for specified patch. More...
 
bool hasPatchControl (const polyPatch &pp) const
 Check if patch control exists for specified patch. More...
 
bool hasInterpolator (const pointPatch &fpatch) const
 Check if patch control exists for specified patch. More...
 
void checkPatchControl (const polyPatch &pp) const
 Check if patch control exists for specified patch. More...
 
void setPatchControl (const polyPatch &pp, const wordList &ctrlNames, const pointField &points0)
 Define pressure-zones mapping for faces in the specified patches. More...
 
void setMapping (const polyMesh &mesh, const labelUList &patchIds, const pointField &points0)
 Define pressure-zones mapping for faces in the specified patches. More...
 
void setInterpolator (const pointPatch &fpatch, const pointField &points0)
 Check if patch control exists for specified patch. More...
 
bool hasMapping () const
 True if the pressure-zones mapping has already been performed. More...
 
bool hasInterpolator (const label patchIndex) const
 Check if patch interpolator exists for specified patch. More...
 
List< scalar > areas (const polyMesh &pmesh) const
 The areas for each pressure-zone. More...
 
bool forcesAndMoments (const polyMesh &pmesh, List< vector > &forces, List< vector > &moments) const
 The forces and moments acting on each pressure-zone. More...
 
tmp< pointFieldpointsDisplacement (const pointPatch &fpatch, const pointField &points0) const
 Displace points according to the current state. More...
 
tmp< pointFieldpointsDisplacement (const lumpedPointState &state, const pointPatch &fpatch, const pointField &points0) const
 Displace points according to specified state. More...
 
tmp< pointFieldpointsPosition (const lumpedPointState &state, const pointPatch &fpatch, const pointField &points0) const
 The points absolute position according to specified state. More...
 
void writeDict (Ostream &os) const
 Write axis, locations, division as a dictionary. More...
 
bool writeData (Ostream &os, const UList< vector > &forces, const UList< vector > &moments, const outputFormatType fmt=outputFormatType::PLAIN, const Tuple2< scalar, scalar > *timesWritten=nullptr) const
 Write points, forces, moments. Only call from the master process. More...
 
bool writeData (const UList< vector > &forces, const UList< vector > &moments=List< vector >(), const Tuple2< scalar, scalar > *timesWritten=nullptr) const
 Write points, forces, moments. More...
 
bool readState ()
 Read state from file, applying relaxation as requested. More...
 
void writeStateVTP (const lumpedPointState &state, const fileName &file) const
 Write state as VTK PolyData format. More...
 
void writeStateVTP (const fileName &file) const
 Write state as VTK PolyData format. More...
 
void writeForcesAndMomentsVTP (const fileName &file, const UList< vector > &forces, const UList< vector > &moments) const
 Write forces on points as VTK PolyData format. More...
 
void writeZonesVTP (const fileName &file, const polyMesh &mesh, const pointField &points0) const
 Write pressure-zones geometry, write as VTK PolyData format. More...
 
void writeVTP (const fileName &file, const polyMesh &mesh, const pointField &points0) const
 Write displaced geometry according to the current state,. More...
 
void writeVTP (const fileName &file, const lumpedPointState &state, const polyMesh &mesh, const pointField &points0) const
 Write displaced geometry according to the specified state,. More...
 

Static Public Attributes

static const Enum< outputFormatTypeformatNames
 Names for the output format types. More...
 
static const Enum< scalingTypescalingNames
 Names for the scaling types. More...
 
static int debug
 Debug switch. More...
 
static const word canonicalName
 The canonical name ("lumpedPointMovement") for the dictionary. More...
 

Detailed Description

The movement driver that describes initial point locations, the current state of the points/rotations, and forwarding to the externalFileCoupler communication coordinator.

The lumpedPointIOMovement class is simply a registered version of the same.

See externalFileCoupler for more information about some of the communication parameters and setup.


Dictionary parameters

Property Description Required Default
points Initial locations of lumped points yes
pointLabels The FEA ids for the points no
origin Shift offset when reading points no (0 0 0)
rotationOrder The Euler rotation order no zxz
degrees Input rotations in degrees no false
relax Relaxation/scaling for updating positions no 1
controllers Motion controllers (dictionary) yes
forces Force settings (dictionary) no
communication Communication settings (dictionary) yes


Parameters for communication dictionary

Property Description Required Default
inputName Name of positions input file yes
outputName Name of forces output file yes
logName Name of log file no movement.log
inputFormat Input format: dictionary/plain yes
outputFormat Output format: dictionary/plain yes
scaleInput Input scaling parameter dictionary no
scaleOutput Output scaling parameter dictionary no
calcFrequency Calculation/coupling frequency no 1


Parameters for optional communication/scaleInput dictionary

Property Description Required Default
length Scaling for input positions no 1


Parameters for optional communication/scaleOutput dictionary

Property Description Required Default
length Scaling for output positions no 1
force Scaling for force no 1
moment Scaling for moment no 1


Parameters for optional forces dictionary

Property Description Required Default
p Name of the pressure field no p
pRef Reference pressure in Pa no 0
rhoRef Reference density for incompressible no 1
Source files

Definition at line 269 of file lumpedPointMovement.H.

Member Enumeration Documentation

◆ outputFormatType

enum class outputFormatType
strong

Output format types.

Enumerator
PLAIN 

"plain" is a simple ASCII format

DICTIONARY 

"dictionary" is the OpenFOAM dictionary format

Definition at line 276 of file lumpedPointMovement.H.

◆ scalingType

Output format types.

Enumerator
LENGTH 

The "length" scaling.

FORCE 

The "force" scaling.

MOMENT 

The "moment" scaling.

Definition at line 283 of file lumpedPointMovement.H.

Constructor & Destructor Documentation

◆ lumpedPointMovement() [1/2]

Default construct.

◆ lumpedPointMovement() [2/2]

lumpedPointMovement ( const dictionary dict,
label  ownerId = -1 
)
explicit

Construct from dictionary, optionally with some owner information.

◆ ~lumpedPointMovement()

virtual ~lumpedPointMovement ( )
virtualdefault

Destructor.

Member Function Documentation

◆ readDict()

void readDict ( const dictionary dict)

Update settings from dictionary.

◆ empty()

bool empty ( ) const
inline

If no number of lumped points (locations) were specified.

Definition at line 28 of file lumpedPointMovementI.H.

References lumpedPointState::empty().

Here is the call graph for this function:

◆ size()

Foam::label size ( ) const
inline

The number of lumped points (number of locations)

Definition at line 34 of file lumpedPointMovementI.H.

◆ ownerId() [1/2]

Foam::label ownerId ( ) const
inline

An owner Id, if needed for bookkeeping purposes.

Definition at line 40 of file lumpedPointMovementI.H.

Referenced by lumpedPointIOMovement::lumpedPointIOMovement(), and lumpedPointDisplacementPointPatchVectorField::~lumpedPointDisplacementPointPatchVectorField().

Here is the caller graph for this function:

◆ ownerId() [2/2]

void ownerId ( label  id)
inline

Change the owner id, if needed for bookkeeping purposes.

Definition at line 46 of file lumpedPointMovementI.H.

◆ coupler() [1/2]

const Foam::externalFileCoupler & coupler ( ) const
inline

Communication control.

Definition at line 69 of file lumpedPointMovementI.H.

◆ coupler() [2/2]

Foam::externalFileCoupler & coupler ( )
inline

Communication control.

Definition at line 75 of file lumpedPointMovementI.H.

◆ couplingPending()

bool couplingPending ( const label  timeIndex) const

Check if coupling is pending (according to the calcFrequency)

◆ couplingCompleted()

void couplingCompleted ( const label  timeIndex) const

Register that coupling is completed at this calcFrequency.

Referenced by lumpedPointDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ state0()

const Foam::lumpedPointState & state0 ( ) const
inline

The initial state (positions/rotations)

Definition at line 81 of file lumpedPointMovementI.H.

◆ state()

const Foam::lumpedPointState & state ( ) const
inline

The current state (positions/rotations)

Definition at line 87 of file lumpedPointMovementI.H.

Referenced by lumpedPointMovement::writeStateVTP().

Here is the caller graph for this function:

◆ origin()

const Foam::point & origin ( ) const
inline

The offset for lumped points, used on input.

Definition at line 93 of file lumpedPointMovementI.H.

◆ scalePoints()

void scalePoints ( lumpedPointState state) const
inline

Scale the lumped points (on input).

Definition at line 99 of file lumpedPointMovementI.H.

References lumpedPointState::scalePoints().

Here is the call graph for this function:

◆ relax() [1/2]

Foam::scalar relax ( ) const
inline

The relaxation factor when changing states.

Definition at line 108 of file lumpedPointMovementI.H.

◆ relax() [2/2]

Foam::scalar & relax ( )
inline

The relaxation factor when changing states.

Definition at line 114 of file lumpedPointMovementI.H.

◆ inputName()

const Foam::word & inputName ( ) const
inline

The input (state) file name.

Definition at line 120 of file lumpedPointMovementI.H.

◆ outputName()

const Foam::word & outputName ( ) const
inline

The output (forces) file name.

Definition at line 126 of file lumpedPointMovementI.H.

◆ logName()

const Foam::word & logName ( ) const
inline

The log file name.

Definition at line 132 of file lumpedPointMovementI.H.

◆ inputFormat()

Foam::lumpedPointState::inputFormatType inputFormat ( ) const
inline

The input (state) file format.

Definition at line 139 of file lumpedPointMovementI.H.

◆ outputFormat()

Foam::lumpedPointMovement::outputFormatType outputFormat ( ) const
inline

The output (forces) file format.

Definition at line 146 of file lumpedPointMovementI.H.

◆ rotationOrder()

Foam::quaternion::eulerOrder rotationOrder ( ) const
inline

The Euler-angle rotation order.

Definition at line 153 of file lumpedPointMovementI.H.

◆ degrees()

bool degrees ( ) const
inline

Rotation angles in degrees.

Definition at line 159 of file lumpedPointMovementI.H.

◆ hasPatchControl() [1/2]

bool hasPatchControl ( const label  patchIndex) const
inline

Check if patch control exists for specified patch.

Definition at line 53 of file lumpedPointMovementI.H.

◆ hasPatchControl() [2/2]

bool hasPatchControl ( const polyPatch pp) const

Check if patch control exists for specified patch.

◆ hasInterpolator() [1/2]

bool hasInterpolator ( const pointPatch fpatch) const

Check if patch control exists for specified patch.

◆ checkPatchControl()

void checkPatchControl ( const polyPatch pp) const

Check if patch control exists for specified patch.

◆ setPatchControl()

void setPatchControl ( const polyPatch pp,
const wordList ctrlNames,
const pointField points0 
)

Define pressure-zones mapping for faces in the specified patches.

The face centres are compared to the controller points,

Parameters
ppThe patch with a control
ctrlNamesThe patch ids to be included in the mapping
points0The initial mesh points, prior to movement

◆ setMapping()

void setMapping ( const polyMesh mesh,
const labelUList patchIds,
const pointField points0 
)

Define pressure-zones mapping for faces in the specified patches.

The face centres are compared to the controller points,

Parameters
meshThe volume mesh reference
patchIdsThe patch ids to be included in the mapping
points0The initial mesh points, prior to movement

◆ setInterpolator()

void setInterpolator ( const pointPatch fpatch,
const pointField points0 
)

Check if patch control exists for specified patch.

◆ hasMapping()

bool hasMapping ( ) const
inline

True if the pressure-zones mapping has already been performed.

Definition at line 165 of file lumpedPointMovementI.H.

◆ hasInterpolator() [2/2]

bool hasInterpolator ( const label  patchIndex) const
inline

Check if patch interpolator exists for specified patch.

Definition at line 60 of file lumpedPointMovementI.H.

◆ areas()

List< scalar > areas ( const polyMesh pmesh) const

The areas for each pressure-zone.

◆ forcesAndMoments()

bool forcesAndMoments ( const polyMesh pmesh,
List< vector > &  forces,
List< vector > &  moments 
) const

The forces and moments acting on each pressure-zone.

The zones must be previously defined via setMapping.

◆ pointsDisplacement() [1/2]

tmp< pointField > pointsDisplacement ( const pointPatch fpatch,
const pointField points0 
) const

Displace points according to the current state.

◆ pointsDisplacement() [2/2]

tmp< pointField > pointsDisplacement ( const lumpedPointState state,
const pointPatch fpatch,
const pointField points0 
) const

Displace points according to specified state.

◆ pointsPosition()

tmp< pointField > pointsPosition ( const lumpedPointState state,
const pointPatch fpatch,
const pointField points0 
) const

The points absolute position according to specified state.

◆ writeDict()

void writeDict ( Ostream os) const

Write axis, locations, division as a dictionary.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ writeData() [1/2]

bool writeData ( Ostream os,
const UList< vector > &  forces,
const UList< vector > &  moments,
const outputFormatType  fmt = outputFormatType::PLAIN,
const Tuple2< scalar, scalar > *  timesWritten = nullptr 
) const

Write points, forces, moments. Only call from the master process.

◆ writeData() [2/2]

bool writeData ( const UList< vector > &  forces,
const UList< vector > &  moments = Listvector >(),
const Tuple2< scalar, scalar > *  timesWritten = nullptr 
) const

Write points, forces, moments.

◆ readState()

bool readState ( )

Read state from file, applying relaxation as requested.

◆ writeStateVTP() [1/2]

void writeStateVTP ( const lumpedPointState state,
const fileName file 
) const

Write state as VTK PolyData format.

Definition at line 37 of file lumpedPointMovementWriter.C.

References UList< T >::first(), Foam::identity(), splitCell::master(), List< T >::resize(), lumpedPointState::size(), lumpedPointMovement::state(), and lumpedPointState::writeVTP().

Here is the call graph for this function:

◆ writeStateVTP() [2/2]

void writeStateVTP ( const fileName file) const

Write state as VTK PolyData format.

Definition at line 75 of file lumpedPointMovementWriter.C.

◆ writeForcesAndMomentsVTP()

void writeForcesAndMomentsVTP ( const fileName file,
const UList< vector > &  forces,
const UList< vector > &  moments 
) const

Write forces on points as VTK PolyData format.

Definition at line 81 of file lumpedPointMovementWriter.C.

References Foam::vtk::CONNECTIVITY, format(), Foam::vtk::INLINE_ASCII, splitCell::master(), Foam::vtk::newFormatter(), nPoints, Foam::vtk::NUMBER_OF_POINTS, Foam::vtk::NUMBER_OF_VERTS, Foam::vtk::OFFSETS, os(), Foam::vtk::PIECE, points, Foam::vtk::POINTS, Foam::vtk::POLY_DATA, UList< T >::size(), OFstream::stdStream(), Foam::vtk::VERTS, Foam::vtk::writeIdentity(), and Foam::vtk::writeList().

Here is the call graph for this function:

◆ writeZonesVTP()

void writeZonesVTP ( const fileName file,
const polyMesh mesh,
const pointField points0 
) const

Write pressure-zones geometry, write as VTK PolyData format.

Definition at line 216 of file lumpedPointMovementWriter.C.

References internalMeshWriter::beginCellData(), polyMesh::boundaryMesh(), fileWriter::endCellData(), polyMesh::faces(), Foam::vtk::INLINE_ASCII, PrimitivePatch< FaceList, PointField >::localFaces(), PrimitivePatch< FaceList, PointField >::localPoints(), mesh, patches, patchIds, points0(), polyBoundaryMesh::range(), internalMeshWriter::writeGeometry(), writer(), and internalMeshWriter::writeUniform().

Here is the call graph for this function:

◆ writeVTP() [1/2]

void writeVTP ( const fileName file,
const polyMesh mesh,
const pointField points0 
) const

Write displaced geometry according to the current state,.

write as VTK PolyData format.

Definition at line 258 of file lumpedPointMovementWriter.C.

References mesh, and points0().

Here is the call graph for this function:

◆ writeVTP() [2/2]

void writeVTP ( const fileName file,
const lumpedPointState state,
const polyMesh mesh,
const pointField points0 
) const

Write displaced geometry according to the specified state,.

write as VTK PolyData format.

Definition at line 269 of file lumpedPointMovementWriter.C.

References internalMeshWriter::beginCellData(), internalMeshWriter::beginPointData(), pointMesh::boundary(), polyMesh::boundaryMesh(), fileWriter::endCellData(), fileWriter::endPointData(), forAll, Foam::vtk::INLINE_ASCII, PrimitivePatch< FaceList, PointField >::localFaces(), mesh, patches, patchIds, points0(), UList< T >::size(), internalMeshWriter::writeGeometry(), writer(), and internalMeshWriter::writeUniform().

Here is the call graph for this function:

Member Data Documentation

◆ formatNames

Names for the output format types.

Definition at line 294 of file lumpedPointMovement.H.

◆ scalingNames

const Foam::Enum< Foam::lumpedPointMovement::scalingType > scalingNames
static

Names for the scaling types.

Definition at line 297 of file lumpedPointMovement.H.

◆ debug

int debug
static

Debug switch.

Definition at line 382 of file lumpedPointMovement.H.

Referenced by lumpedPointDisplacementPointPatchVectorField::updateCoeffs().

◆ canonicalName

const Foam::word canonicalName
static

The canonical name ("lumpedPointMovement") for the dictionary.

Definition at line 385 of file lumpedPointMovement.H.

Referenced by lumpedPointIOMovement::getMovementObject(), and lumpedPointIOMovement::New().


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