lumpedPointController Class Reference

Simple connectivity of point labels to specify a controller for lumped point movement. More...

Public Member Functions

 lumpedPointController () noexcept
 Default construct. More...
 
 lumpedPointController (const labelUList &pointLabels)
 Copy construct from point ids. More...
 
 lumpedPointController (labelList &&pointLabels)
 Move construct from point ids. More...
 
 lumpedPointController (const dictionary &dict)
 Construct from dictionary. More...
 
 ~lumpedPointController ()=default
 Destructor. More...
 
bool empty () const
 No controller points specified? More...
 
label size () const
 Number of controller points specified. More...
 
const labelListpointLabels () const
 The controller points. More...
 
void remapPointLabels (const label nPoints, const Map< label > &originalIds)
 Check point mapping (the count) or remap the point labels. More...
 

Static Public Member Functions

static autoPtr< lumpedPointControllerNew (const dictionary &dict)
 Factory method. More...
 

Detailed Description

Simple connectivity of point labels to specify a controller for lumped point movement.


Dictionary parameters

Property Description Required Default
pointLabels List of point labels yes
Note
If the calling program itself specified a point-label mapping (eg, original ids from FEA), these can be used initially and remapped.
Source files

Definition at line 75 of file lumpedPointController.H.

Constructor & Destructor Documentation

◆ lumpedPointController() [1/4]

lumpedPointController ( )
noexcept

Default construct.

Definition at line 35 of file lumpedPointController.C.

◆ lumpedPointController() [2/4]

lumpedPointController ( const labelUList pointLabels)
explicit

Copy construct from point ids.

Definition at line 41 of file lumpedPointController.C.

◆ lumpedPointController() [3/4]

lumpedPointController ( labelList &&  pointLabels)
explicit

Move construct from point ids.

Definition at line 50 of file lumpedPointController.C.

◆ lumpedPointController() [4/4]

lumpedPointController ( const dictionary dict)
explicit

Construct from dictionary.

Definition at line 59 of file lumpedPointController.C.

◆ ~lumpedPointController()

~lumpedPointController ( )
default

Destructor.

Member Function Documentation

◆ New()

static autoPtr< lumpedPointController > New ( const dictionary dict)
inlinestatic

Factory method.

Definition at line 101 of file lumpedPointController.H.

References dict, and Time::New().

Here is the call graph for this function:

◆ empty()

bool empty ( ) const
inline

No controller points specified?

Definition at line 114 of file lumpedPointController.H.

References UList< T >::empty().

Here is the call graph for this function:

◆ size()

label size ( ) const
inline

Number of controller points specified.

Definition at line 120 of file lumpedPointController.H.

References UList< T >::size().

Here is the call graph for this function:

◆ pointLabels()

const labelList & pointLabels ( ) const
inline

The controller points.

Definition at line 126 of file lumpedPointController.H.

◆ remapPointLabels()

void remapPointLabels ( const label  nPoints,
const Map< label > &  originalIds 
)

Check point mapping (the count) or remap the point labels.

Definition at line 70 of file lumpedPointController.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::max(), Foam::min(), Foam::nl, nPoints, and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

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