Holds list of sampling positions. More...
#include <sampling/coordSet.H>
Holds list of sampling positions.
Definition at line 50 of file coordSet.H.
Inheritance diagram for coordSet: Collaboration diagram for coordSet:Public Member Functions | |
| coordSet (const word &name, const word &axis) | |
| Construct from components.
| |
| coordSet (const word &name, const word &axis, const List< point > &points, const point &refPoint=point::zero) | |
| Construct from components.
| |
| coordSet (const word &name, const word &axis, const scalarField &points, const scalar refPoint=0.0) | |
| Construct from components.
| |
| const word & | name () const |
| const word & | axis () const |
| const point & | refPoint () const |
| bool | hasVectorAxis () const |
| Is axis specification a vector.
| |
| scalar | scalarCoord (const label index) const |
| Get coordinate of point according to axis specification.
| |
| vector | vectorCoord (const label index) const |
| Get point according to axis="full" specification.
| |
| Ostream & | write (Ostream &os) const |
Protected Attributes | |
| const word | name_ |
| Name.
| |
| const word | axis_ |
| Axis write type.
| |
| point | refPoint_ |
| Reference point for "distance" write specifier.
| |
Construct from components.
Definition at line 34 of file coordSet.C.
| coordSet | ( | const word & | name, |
| const word & | axis, | ||
| const List< point > & | points, | ||
| const point & | refPoint = point::zero
|
||
| ) |
Construct from components.
Definition at line 48 of file coordSet.C.
| coordSet | ( | const word & | name, |
| const word & | axis, | ||
| const scalarField & | points, | ||
| const scalar | refPoint = 0.0
|
||
| ) |
Construct from components.
Definition at line 64 of file coordSet.C.
References Foam::exit(), Foam::FatalError, FatalErrorIn, and Y.
| const word& name | ( | ) | const [inline]
|
Definition at line 99 of file coordSet.H.
References coordSet::name_.
Referenced by writer< Type >::getBaseName(), sampledSet::iNew::operator()(), xmgraceSetWriter< Type >::write(), jplotSetWriter< Type >::write(), and gnuplotSetWriter< Type >::write().
| const word& axis | ( | ) | const [inline]
|
Definition at line 104 of file coordSet.H.
References coordSet::axis_.
Referenced by xmgraceSetWriter< Type >::write().
| const point& refPoint | ( | ) | const [inline]
|
Definition at line 109 of file coordSet.H.
References coordSet::refPoint_.
| bool hasVectorAxis | ( | ) | const |
Is axis specification a vector.
Definition at line 105 of file coordSet.C.
References coordSet::axis_.
Referenced by writer< Type >::writeCoord().
| Foam::scalar scalarCoord | ( | const label | index ) | const |
Get coordinate of point according to axis specification.
If axis="distance" can be: -distance to starting point (e.g. uniformSet) or -distance to first sampling point (e.g. cloudSet)
Definition at line 112 of file coordSet.C.
References Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::mag(), p, Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().
Referenced by writer< Type >::writeCoord().
| Foam::point vectorCoord | ( | const label | index ) | const |
Get point according to axis="full" specification.
Definition at line 149 of file coordSet.C.
References p.
Referenced by writer< Type >::writeCoord().
| Foam::Ostream & write | ( | Ostream & | os ) | const |
Reimplemented in sampledSet.
Definition at line 157 of file coordSet.C.
References Foam::endl(), and forAll.
Referenced by sampledSet::write().
Axis write type.
Definition at line 61 of file coordSet.H.
Referenced by coordSet::axis(), and coordSet::hasVectorAxis().
Reference point for "distance" write specifier.
Definition at line 64 of file coordSet.H.
Referenced by coordSet::refPoint().
