Uniform 3D-grid of samples. More...
Public Member Functions | |
TypeName ("boxUniform") | |
Runtime type information. More... | |
boxUniform (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) | |
Construct from dictionary. More... | |
virtual | ~boxUniform () |
Destructor. More... | |
![]() | |
TypeName ("sampledSet") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, sampledSet, word,(const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict),(name, mesh, searchEngine, dict)) | |
sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const word &axis) | |
Construct from components. More... | |
sampledSet (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) | |
Construct from dictionary. More... | |
autoPtr< sampledSet > | clone () const |
Clone. More... | |
virtual | ~sampledSet () |
Destructor. More... | |
const word & | name () const |
Access the name. More... | |
const polyMesh & | mesh () const |
Access the mesh. More... | |
const meshSearch & | searchEngine () const |
Access the search engine. More... | |
const pointField & | positions () const |
Access the positions. More... | |
const labelList & | cells () const |
Access the cells. More... | |
const labelList & | faces () const |
Access the faces. More... | |
![]() | |
coordSet () | |
Construct null. More... | |
coordSet (const labelList &segments, const word &positionName=word::null, const pointField &positions=pointField::null(), const word &distanceName=word::null, const scalarField &distances=scalarField::null(), const word &axis=axisTypeNames_[axisType::DEFAULT]) | |
Construct from components. More... | |
coordSet (const bool contiguous, const word &positionName, const pointField &positions, const word &axis=axisTypeNames_[axisType::DEFAULT]) | |
Construct from positions. More... | |
coordSet (const bool contiguous, const word &distanceName, const scalarField &distances, const word &axis=axisTypeNames_[axisType::DEFAULT]) | |
Construct from distances. More... | |
label | size () const |
Return the size. More... | |
const labelList & | segments () const |
Return the segments. More... | |
word | axis () const |
Return the axis name. More... | |
bool | hasScalarAxis () const |
Is the coordinate axis a scalar? More... | |
bool | hasPointAxis () const |
Is the coordinate axis a point? More... | |
scalar | scalarCoord (const label index) const |
Get scalar coordinate (axis is x, y, z or distance) More... | |
tmp< scalarField > | scalarCoords () const |
Get scalar coordinates (axis is x, y, z or distance) More... | |
word | scalarName () const |
Return the name of the scalar coordinates. More... | |
point | pointCoord (const label index) const |
Get vector coordinate (axis is xyz) More... | |
tmp< pointField > | pointCoords () const |
Get vector coordinate (axis is xyz) More... | |
word | pointName () const |
Return the name of the point coordinates. More... | |
labelList | vertices () const |
Return a list of isolated vertices. These are the points that are. More... | |
labelPairList | edges () const |
Return a list of edges. These are adjacent pairs of points which. More... | |
labelListList | lines () const |
Return a list of lines. These are lists of points which are in the. More... | |
Tuple2< coordSet, labelList > | gather () const |
Combine coordinate sets onto the master. Return both the combined. More... | |
template<class Type > | |
Foam::tmp< Foam::Field< Type > > | gather (const Field< Type > &values, const labelList &order) |
Additional Inherited Members | |
![]() | |
enum class | axisType { XYZ , X , Y , Z , DISTANCE , DEFAULT } |
Enumeration defining the output format for coordinates. More... | |
![]() | |
static autoPtr< sampledSet > | New (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) |
Return a reference to the selected sampledSet. More... | |
![]() | |
template<class Type > | |
static tmp< Field< Type > > | gather (const Field< Type > &values, const labelList &order) |
Combine a field using the ordering obtained from the coordinate set. More... | |
![]() | |
static const NamedEnum< axisType, 6 > | axisTypeNames_ |
String representation of axis enums. More... | |
![]() | |
void | setSamples (const List< point > &samplingPositions, const labelList &samplingSegments, const labelList &samplingCells, const labelList &samplingFaces) |
Sets sample data. More... | |
void | setSamples (const List< point > &samplingPositions, const List< scalar > &samplingDistances, const labelList &samplingSegments, const labelList &samplingCells, const labelList &samplingFaces) |
Sets sample data. More... | |
![]() | |
labelList | cells_ |
Cell numbers. More... | |
labelList | faces_ |
Face numbers (-1 if not known) More... | |
![]() | |
labelList | segments_ |
Connected segments. More... | |
word | positionName_ |
Name of the positions. More... | |
autoPtr< pointField > | positions_ |
Point positions. More... | |
word | distanceName_ |
Name of the distances. More... | |
autoPtr< scalarField > | distances_ |
Scalar distances. More... | |
axisType | axis_ |
Axis. More... | |
Uniform 3D-grid of samples.
Property | Description | Req'd? | Default |
---|---|---|---|
box | The box which contains the samples | yes | |
nPoints | The number of points in each direction | yes | |
axis | The coordinate axis that is written | yes |
Example specification:
{ type boxUniform; box (0.95 0 0.25) (1.2 0.25 0.5); nPoints (2 4 6); axis x; }
Definition at line 91 of file boxUniform.H.
boxUniform | ( | const word & | name, |
const polyMesh & | mesh, | ||
const meshSearch & | searchEngine, | ||
const dictionary & | dict | ||
) |
Construct from dictionary.
Definition at line 120 of file boxUniform.C.
|
virtual |
Destructor.
Definition at line 138 of file boxUniform.C.
TypeName | ( | "boxUniform" | ) |
Runtime type information.