Holds list of sampling positions. More...
#include <sampling/coordSet.H>
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 |
![]() | |
Field () | |
Construct null. | |
Field (const label) | |
Construct given size. | |
Field (const label, const vector &) | |
Construct given size and initial value. | |
Field (const UList< vector > &) | |
Construct as copy of a UList<Type> | |
Field (const Xfer< List< vector > > &) | |
Construct by transferring the List contents. | |
Field (const UList< vector > &mapF, const unallocLabelList &mapAddressing) | |
Construct by 1 to 1 mapping from the given field. | |
Field (const tmp< Field< vector > > &tmapF, const unallocLabelList &mapAddressing) | |
Construct by 1 to 1 mapping from the given tmp field. | |
Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given field. | |
Field (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
Construct by interpolative mapping from the given tmp field. | |
Field (const UList< vector > &mapF, const FieldMapper &map) | |
Construct by mapping from the given field. | |
Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map) | |
Construct by mapping from the given tmp field. | |
Field (const Field< vector > &) | |
Construct as copy. | |
Field (Field< vector > &, bool reUse) | |
Construct as copy or re-use as specified. | |
Field (const Xfer< Field< vector > > &) | |
Construct by transferring the Field contents. | |
Field (const typename Field< vector >::subField &) | |
Construct as copy of subField. | |
Field (Istream &) | |
Construct as copy of tmp<Field> | |
Field (const word &keyword, const dictionary &dict, const label size) | |
Construct from a dictionary entry. | |
tmp< Field< vector > > | clone () const |
Clone. | |
void | map (const UList< vector > &mapF, const unallocLabelList &mapAddressing) |
1 to 1 map from the given field | |
void | map (const tmp< Field< vector > > &tmapF, const unallocLabelList &mapAddressing) |
1 to 1 map from the given tmp field | |
void | map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given field. | |
void | map (const tmp< Field< vector > > &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
Interpolative map from the given tmp field. | |
void | map (const UList< vector > &mapF, const FieldMapper &map) |
Map from the given field. | |
void | map (const tmp< Field< vector > > &tmapF, const FieldMapper &map) |
Map from the given tmp field. | |
void | autoMap (const FieldMapper &map) |
Map from self. | |
void | rmap (const UList< vector > &mapF, const unallocLabelList &mapAddressing) |
1 to 1 reverse-map from the given field | |
void | rmap (const tmp< Field< vector > > &tmapF, const unallocLabelList &mapAddressing) |
1 to 1 reverse-map from the given tmp field | |
void | rmap (const UList< vector > &mapF, const unallocLabelList &mapAddressing, const scalarList &weights) |
Interpolative reverse map from the given field. | |
void | rmap (const tmp< Field< vector > > &tmapF, const unallocLabelList &mapAddressing, const scalarList &weights) |
Interpolative reverse map from the given tmp field. | |
void | negate () |
Negate this field. | |
tmp< Field< cmptType > > | component (const direction) const |
Return a component field of the field. | |
void | replace (const direction, const UList< cmptType > &) |
Replace a component field of the field. | |
void | replace (const direction, const tmp< Field< cmptType > > &) |
Replace a component field of the field. | |
void | replace (const direction, const cmptType &) |
Replace a component field of the field. | |
tmp< Field< vector > > | T () const |
Return the field transpose (only defined for second rank tensors) | |
void | writeEntry (const word &keyword, Ostream &os) const |
Write the field as a dictionary entry. | |
void | operator= (const Field< vector > &) |
void | operator= (const UList< vector > &) |
Assignment from UList operator. Takes linear time. | |
void | operator= (const SubField< vector > &) |
void | operator= (const tmp< Field< vector > > &) |
void | operator= (const vector &) |
Assignment of all entries to the given value. | |
void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
void | operator+= (const UList< vector > &) |
void | operator+= (const tmp< Field< vector > > &) |
void | operator+= (const vector &) |
void | operator-= (const UList< vector > &) |
void | operator-= (const tmp< Field< vector > > &) |
void | operator-= (const vector &) |
void | operator*= (const UList< scalar > &) |
void | operator*= (const tmp< Field< scalar > > &) |
void | operator*= (const scalar &) |
void | operator/= (const UList< scalar > &) |
void | operator/= (const tmp< Field< scalar > > &) |
void | operator/= (const scalar &) |
![]() | |
refCount () | |
Construct null with zero count. | |
int | count () const |
Return the reference count. | |
bool | okToDelete () const |
Return true if the reference count is zero. | |
void | resetRefCount () |
Reset the reference count to zero. | |
void | operator++ () |
Increment the reference count. | |
void | operator++ (int) |
Increment the reference count. | |
void | operator-- () |
Decrement the reference count. | |
void | operator-- (int) |
Decrement the reference count. | |
![]() | |
label | size () const |
Return the number of elements in the UList. | |
List () | |
Null constructor. | |
List (const label) | |
Construct with given size. | |
List (const label, const vector &) | |
Construct with given size and value for all elements. | |
List (const List< vector > &) | |
Copy constructor. | |
List (const Xfer< List< vector > > &) | |
Construct by transferring the parameter contents. | |
List (List< vector > &, bool reUse) | |
Construct as copy or re-use as specified. | |
List (const UList< vector > &, const unallocLabelList &mapAddressing) | |
Construct as subset. | |
List (InputIterator first, InputIterator last) | |
Construct given start and end iterators. | |
List (const FixedList< vector, Size > &) | |
Construct as copy of FixedList<T, Size> | |
List (const PtrList< vector > &) | |
Construct as copy of PtrList<T> | |
List (const SLList< vector > &) | |
Construct as copy of SLList<T> | |
List (const IndirectList< vector > &) | |
Construct as copy of IndirectList<T> | |
List (const UIndirectList< vector > &) | |
Construct as copy of UIndirectList<T> | |
List (const BiIndirectList< vector > &) | |
Construct as copy of BiIndirectList<T> | |
List (Istream &) | |
Construct from Istream. | |
~List () | |
void | resize (const label) |
Reset size of List. | |
void | resize (const label, const vector &) |
Reset size of List and value for new elements. | |
void | setSize (const label) |
Reset size of List. | |
void | setSize (const label, const vector &) |
Reset size of List and value for new elements. | |
void | clear () |
Clear the list, i.e. set size to zero. | |
void | append (const UList< vector > &) |
Append a List at the end of this list. | |
void | append (const UIndirectList< vector > &) |
Append a UIndirectList at the end of this list. | |
void | transfer (List< vector > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (DynamicList< vector, SizeInc, SizeMult, SizeDiv > &) |
Transfer the contents of the argument List into this list. | |
void | transfer (SortableList< vector > &) |
Transfer the contents of the argument List into this list. | |
Xfer< List< vector > > | xfer () |
Transfer contents to the Xfer container. | |
vector & | newElmt (const label) |
Return subscript-checked element of UList. | |
void | operator= (const List< vector > &) |
Assignment operator. Takes linear time. | |
void | operator= (const SLList< vector > &) |
Assignment from SLList operator. Takes linear time. | |
void | operator= (const IndirectList< vector > &) |
Assignment from IndirectList operator. Takes linear time. | |
void | operator= (const UIndirectList< vector > &) |
Assignment from UIndirectList operator. Takes linear time. | |
void | operator= (const BiIndirectList< vector > &) |
Assignment from BiIndirectList operator. Takes linear time. | |
![]() | |
UList () | |
Null constructor. | |
UList (vector *__restrict__ v, label size) | |
Construct from components. | |
label | fcIndex (const label i) const |
Return the forward circular index, i.e. the next index. | |
label | rcIndex (const label i) const |
Return the reverse circular index, i.e. the previous index. | |
label | byteSize () const |
Return the binary size in number of characters of the UList. | |
const vector * | cdata () const |
Return a const pointer to the first data element,. | |
vector * | data () |
Return a pointer to the first data element,. | |
void | checkStart (const label start) const |
Check start is within valid range (0 ... size-1). | |
void | checkSize (const label size) const |
Check size is within valid range (0 ... size). | |
void | checkIndex (const label i) const |
Check index i is within valid range (0 ... size-1). | |
void | writeEntry (Ostream &) const |
Write the UList as a dictionary entry. | |
void | assign (const UList< vector > &) |
Assign elements to those from UList. | |
vector & | operator[] (const label) |
Return element of UList. | |
const vector & | operator[] (const label) const |
Return element of constant UList. | |
operator const Foam::List< vector > & () const | |
Allow cast to a const List<T>&. | |
iterator | begin () |
Return an iterator to begin traversing the UList. | |
const_iterator | begin () const |
Return const_iterator to begin traversing the constant UList. | |
iterator | end () |
Return an iterator to end traversing the UList. | |
const_iterator | end () const |
Return const_iterator to end traversing the constant UList. | |
const_iterator | cbegin () const |
Return const_iterator to begin traversing the constant UList. | |
const_iterator | cend () const |
Return const_iterator to end traversing the constant UList. | |
reverse_iterator | rbegin () |
Return reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | rbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
reverse_iterator | rend () |
Return reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | rend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
const_reverse_iterator | crbegin () const |
Return const_reverse_iterator to begin reverse traversing the UList. | |
const_reverse_iterator | crend () const |
Return const_reverse_iterator to end reverse traversing the UList. | |
label | max_size () const |
Return size of the largest possible UList. | |
bool | empty () const |
Return true if the UList is empty (ie, size() is zero). | |
void | swap (UList< vector > &) |
Swap two ULists of the same type in constant time. | |
bool | operator== (const UList< vector > &) const |
Equality operation on ULists of the same type. | |
bool | operator!= (const UList< vector > &) const |
The opposite of the equality operation. Takes linear time. | |
bool | operator< (const UList< vector > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator> (const UList< vector > &) const |
Compare two ULists lexicographically. Takes linear time. | |
bool | operator<= (const UList< vector > &) const |
Return true if !(a > b). Takes linear time. | |
bool | operator>= (const UList< vector > &) const |
Return true if !(a < b). Takes linear time. |
Protected Attributes | |
const word | name_ |
Name. | |
const word | axis_ |
Axis write type. | |
point | refPoint_ |
Reference point for "distance" write specifier. |
Additional Inherited Members | |
![]() | |
typedef pTraits< vector >::cmptType | cmptType |
Component type. | |
typedef SubField< vector > | subField |
Declare type of subField. | |
![]() | |
typedef SubList< vector > | subList |
Declare type of subList. | |
![]() | |
typedef vector | value_type |
Type of values the UList contains. | |
typedef vector & | reference |
Type that can be used for storing into. | |
typedef const vector & | const_reference |
Type that can be used for storing into. | |
typedef label | difference_type |
The type that can represent the difference between any two. | |
typedef label | size_type |
The type that can represent the size of a UList. | |
typedef vector * | iterator |
Random access iterator for traversing UList. | |
typedef const vector * | const_iterator |
Random access iterator for traversing UList. | |
typedef vector * | reverse_iterator |
Reverse iterator for reverse traversal of UList. | |
typedef const vector * | const_reverse_iterator |
Reverse iterator for reverse traversal of constant UList. | |
![]() | |
static const Field< vector > & | null () |
Return a null field. | |
static tmp< Field< vector > > | NewCalculatedType (const Field< Type2 > &f) |
Return a pointer to a new calculatedFvPatchFieldField created on. | |
![]() | |
static const char *const | typeName |
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.
|
inline |
Definition at line 99 of file coordSet.H.
References coordSet::name_.
Referenced by writer< Type >::getBaseName(), sampledSet::iNew::operator()(), gnuplotSetWriter< Type >::write(), xmgraceSetWriter< Type >::write(), and jplotSetWriter< Type >::write().
|
inline |
Definition at line 104 of file coordSet.H.
References coordSet::axis_.
Referenced by xmgraceSetWriter< Type >::write().
|
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().
|
protected |
|
protected |
Axis write type.
Definition at line 61 of file coordSet.H.
Referenced by coordSet::axis(), and coordSet::hasVectorAxis().
|
protected |
Reference point for "distance" write specifier.
Definition at line 64 of file coordSet.H.
Referenced by coordSet::refPoint().