Specified point samples within patches. More...
Public Member Functions | |
| TypeName ("boundaryPoints") | |
| Runtime type information. More... | |
| boundaryPoints (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) | |
| Construct from dictionary. More... | |
| virtual | ~boundaryPoints () |
| Destructor. More... | |
 Public Member Functions inherited from sampledSet | |
| 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 polyMesh & | mesh () const |
| const meshSearch & | searchEngine () const |
| const labelList & | segments () const |
| const labelList & | cells () const |
| const labelList & | faces () const |
| Ostream & | write (Ostream &) const |
| Output for debugging. More... | |
| Public Member Functions inherited from coordSet | |
| coordSet (const word &name, const word &axis) | |
| Construct from components. More... | |
| coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &curveDist) | |
| Construct from components. More... | |
| const word & | name () const |
| word | axis () const |
| const scalarList & | curveDist () const |
| Cumulative distance. More... | |
| bool | hasVectorAxis () const |
| Is axis specification a vector. More... | |
| scalar | scalarCoord (const label index) const |
| Get coordinate of point according to axis specification. More... | |
| vector | vectorCoord (const label index) const |
| Get point according to axis="xyz" specification. More... | |
| Ostream & | write (Ostream &os) const |
| Public Member Functions inherited from Field< Type > | |
| Field () | |
| Construct null. More... | |
| Field (const label) | |
| Construct given size. More... | |
| Field (const label, const Type &) | |
| Construct given size and initial value. More... | |
| Field (const label, const zero) | |
| Construct given size and initialed to zero. More... | |
| Field (const UList< Type > &) | |
| Copy constructor of a UList<Type> More... | |
| Field (List< Type > &&) | |
| Mover constructor transferring the List contents. More... | |
| Field (const UIndirectList< Type > &) | |
| Copy constructor of a UIndirectList<Type> More... | |
| Field (const Field< Type > &) | |
| Copy constructor. More... | |
| Field (Field< Type > &, bool reuse) | |
| Copy constructor or re-use as specified. More... | |
| Field (Field< Type > &&) | |
| Move constructor transferring the Field contents. More... | |
| Field (const tmp< Field< Type >> &) | |
| Copy constructor of tmp<Field> More... | |
| Field (const UList< Type > &mapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given field. More... | |
| Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given tmp field. More... | |
| Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given field. More... | |
| Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given tmp field. More... | |
| Field (Istream &) | |
| Construct from Istream. More... | |
| Field (const word &keyword, const dictionary &, const label size) | |
| Construct from a dictionary entry. More... | |
| tmp< Field< Type > > | clone () const |
| Clone. More... | |
| void | map (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given field More... | |
| void | map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given tmp field More... | |
| void | map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given field. More... | |
| void | map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given tmp field. More... | |
| void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given field More... | |
| void | rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given tmp field More... | |
| void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given field. More... | |
| void | rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given tmp field. More... | |
| void | negate () |
| Negate this field. More... | |
| tmp< Field< cmptType > > | component (const direction) const |
| Return a component field of the field. More... | |
| void | replace (const direction, const UList< cmptType > &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const tmp< Field< cmptType >> &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const cmptType &) |
| Replace a component field of the field. More... | |
| template<class VSForm > | |
| VSForm | block (const label start) const |
| tmp< Field< Type > > | T () const |
| Return the field transpose (only defined for second rank tensors) More... | |
| void | operator= (const Field< Type > &) |
| void | operator= (Field< Type > &&) |
| void | operator= (const UList< Type > &) |
| void | operator= (List< Type > &&) |
| void | operator= (const SubField< Type > &) |
| void | operator= (const tmp< Field< Type >> &) |
| void | operator= (const Type &) |
| void | operator= (const zero) |
| template<class Form , class Cmpt , direction nCmpt> | |
| void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
| void | operator+= (const UList< Type > &) |
| void | operator+= (const tmp< Field< Type >> &) |
| void | operator-= (const UList< Type > &) |
| void | operator-= (const tmp< Field< Type >> &) |
| void | operator*= (const UList< scalar > &) |
| void | operator*= (const tmp< Field< scalar >> &) |
| void | operator/= (const UList< scalar > &) |
| void | operator/= (const tmp< Field< scalar >> &) |
| void | operator+= (const Type &) |
| void | operator-= (const Type &) |
| void | operator*= (const scalar &) |
| void | operator/= (const scalar &) |
| template<class Type> | |
| void | operator= (const tmp< Field > &rhs) |
| Public Member Functions inherited from refCount | |
| int | count () const |
| Return the current reference count. More... | |
| bool | unique () const |
| Return true if the reference count is zero. More... | |
| void | operator++ () |
| Increment the reference count. More... | |
| void | operator++ (int) |
| Increment the reference count. More... | |
| void | operator-- () |
| Decrement the reference count. More... | |
| void | operator-- (int) |
| Decrement the reference count. More... | |
| Public Member Functions inherited from List< Type > | |
| List () | |
| Null constructor. More... | |
| List (const label) | |
| Construct with given size. More... | |
| List (const label, const Type &) | |
| Construct with given size and value for all elements. More... | |
| List (const label, const zero) | |
| Construct with given size initialising all elements to zero. More... | |
| List (const List< Type > &) | |
| Copy constructor. More... | |
| List (const List< T2 > &) | |
| Copy constructor from list containing another type. More... | |
| List (List< Type > &&) | |
| Move constructor. More... | |
| List (List< Type > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< Type > &, const labelUList &mapAddressing) | |
| Construct as subset. More... | |
| List (InputIterator first, InputIterator last) | |
| Construct given start and end iterators. More... | |
| List (const FixedList< Type, Size > &) | |
| Construct as copy of FixedList<T, Size> More... | |
| List (const PtrList< Type > &) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< Type > &) | |
| Construct as copy of SLList<T> More... | |
| List (const UIndirectList< Type > &) | |
| Construct as copy of UIndirectList<T> More... | |
| List (const BiIndirectList< Type > &) | |
| Construct as copy of BiIndirectList<T> More... | |
| List (std::initializer_list< Type >) | |
| Construct from an initialiser list. More... | |
| List (Istream &) | |
| Construct from Istream. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| autoPtr< List< Type > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | resize (const label, const Type &) |
| Alias for setSize(const label, const T&) More... | |
| void | setSize (const label) |
| Reset size of List. More... | |
| void | setSize (const label, const Type &) |
| Reset size of List and value for new elements. More... | |
| void | clear () |
| Clear the list, i.e. set size to zero. More... | |
| void | append (const Type &) |
| Append an element at the end of the list. More... | |
| void | append (const UList< Type > &) |
| Append a List at the end of this list. More... | |
| void | append (const UIndirectList< Type > &) |
| Append a UIndirectList at the end of this list. More... | |
| void | transfer (List< Type > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (SortableList< Type > &) |
| Transfer the contents of the argument List into this list. More... | |
| Type & | newElmt (const label) |
| Return subscript-checked element of UList. More... | |
| void | shallowCopy (const UList< Type > &)=delete |
| Disallow implicit shallowCopy. More... | |
| void | operator= (const UList< Type > &) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< Type > &) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (List< Type > &&) |
| Move assignment operator. More... | |
| void | operator= (const SLList< Type > &) |
| Assignment to SLList operator. Takes linear time. More... | |
| void | operator= (const UIndirectList< Type > &) |
| Assignment to UIndirectList operator. Takes linear time. More... | |
| void | operator= (const BiIndirectList< Type > &) |
| Assignment to BiIndirectList operator. Takes linear time. More... | |
| void | operator= (std::initializer_list< Type >) |
| Assignment to an initialiser list. More... | |
| void | operator= (const Type &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| Public Member Functions inherited from UList< Type > | |
| void | operator= (const Type &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| UList () | |
| Null constructor. More... | |
| UList (Type *__restrict__ v, label size) | |
| Construct from components. More... | |
| label | fcIndex (const label i) const |
| Return the forward circular index, i.e. the next index. More... | |
| label | rcIndex (const label i) const |
| Return the reverse circular index, i.e. the previous index. More... | |
| std::streamsize | byteSize () const |
| Return the binary size in number of characters of the UList. More... | |
| const Type * | cdata () const |
| Return a const pointer to the first data element,. More... | |
| Type * | data () |
| Return a pointer to the first data element,. More... | |
| Type & | first () |
| Return the first element of the list. More... | |
| const Type & | first () const |
| Return first element of the list. More... | |
| Type & | last () |
| Return the last element of the list. More... | |
| const Type & | last () const |
| Return the last element of the list. More... | |
| void | checkStart (const label start) const |
| Check start is within valid range (0 ... size-1) More... | |
| void | checkSize (const label size) const |
| Check size is within valid range (0 ... size) More... | |
| void | checkIndex (const label i) const |
| Check index i is within valid range (0 ... size-1) More... | |
| void | shallowCopy (const UList< Type > &) |
| Copy the pointer held by the given UList. More... | |
| void | deepCopy (const UList< Type > &) |
| Copy elements of the given UList. More... | |
| Type & | operator[] (const label) |
| Return element of UList. More... | |
| const Type & | operator[] (const label) const |
| Return element of constant UList. More... | |
| const bool & | operator[] (const label i) const |
| operator const Foam::List< Type > & () const | |
| Allow cast to a const List<T>&. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UList. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | end () const |
| Return const_iterator to end traversing the constant UList. More... | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | cend () const |
| Return const_iterator to end traversing the constant UList. More... | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| label | max_size () const |
| Return size of the largest possible UList. More... | |
| bool | empty () const |
| Return true if the UList is empty (ie, size() is zero) More... | |
| void | swap (UList< Type > &) |
| Swap two ULists of the same type in constant time. More... | |
| bool | operator== (const UList< Type > &) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< Type > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< Type > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< Type > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< Type > &) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< Type > &) const |
| Return true if !(a < b). Takes linear time. More... | |
Additional Inherited Members | |
| Public Types inherited from coordSet | |
| enum | coordFormat { XYZ, X, Y, Z, DISTANCE } |
| Enumeration defining the output format for coordinates. More... | |
| Public Types inherited from Field< Type > | |
| typedef pTraits< Type >::cmptType | cmptType |
| Component type. More... | |
| typedef SubField< Type > | subField |
| Declare type of subField. More... | |
| Public Types inherited from List< Type > | |
| typedef SubList< Type > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< Type > | |
| typedef Type | value_type |
| Type of values the UList contains. More... | |
| typedef Type & | reference |
| Type that can be used for storing into. More... | |
| typedef const Type & | const_reference |
| Type that can be used for storing into. More... | |
| typedef label | difference_type |
| The type that can represent the difference between any two. More... | |
| typedef label | size_type |
| The type that can represent the size of a UList. More... | |
| typedef Type * | iterator |
| Random access iterator for traversing UList. More... | |
| typedef const Type * | const_iterator |
| Random access iterator for traversing UList. More... | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator for reverse traversal of UList. More... | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator for reverse traversal of constant UList. More... | |
| Static Public Member Functions inherited from sampledSet | |
| static autoPtr< sampledSet > | New (const word &name, const polyMesh &mesh, const meshSearch &searchEngine, const dictionary &dict) |
| Return a reference to the selected sampledSet. More... | |
| Static Public Member Functions inherited from Field< Type > | |
| static const Field< Type > & | null () |
| Return a null field. More... | |
| template<class Type2 > | |
| static tmp< Field< Type > > | NewCalculatedType (const Field< Type2 > &f) |
| Return a pointer to a new calculatedFvPatchFieldField created on. More... | |
| Static Public Member Functions inherited from List< Type > | |
| static const List< Type > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< Type > | |
| static const UList< Type > & | null () |
| Return a null UList. More... | |
| Static Public Attributes inherited from Field< Type > | |
| static const char *const | typeName |
| Protected Member Functions inherited from sampledSet | |
| void | setSamples (const List< point > &samplingPts, const labelList &samplingCells, const labelList &samplingFaces, const labelList &samplingSegments, const scalarList &samplingCurveDist) |
| Sets sample data. More... | |
| Protected Member Functions inherited from refCount | |
| refCount () | |
| Construct null initialising count to 0. More... | |
| Protected Member Functions inherited from List< Type > | |
| void | size (const label) |
| Override size to be inconsistent with allocated storage. More... | |
| Protected Attributes inherited from sampledSet | |
| labelList | segments_ |
| Segment numbers. More... | |
| labelList | cells_ |
| Cell numbers. More... | |
| labelList | faces_ |
| Face numbers (-1 if not known) More... | |
| Protected Attributes inherited from coordSet | |
| const word | name_ |
| Name. More... | |
| const coordFormat | axis_ |
| Axis write type. More... | |
| scalarList | curveDist_ |
| Cumulative distance "distance" write specifier. More... | |
Specified point samples within patches.
| Property | Description | Req'd? | Default |
|---|---|---|---|
patches | The patches on which to sample | yes | |
points | The points to sample | yes | |
maxDistance | The maximum distance from patch to point | yes | |
axis | The coordinate axis that is written | yes |
Example specification:
{
type boundaryPoints;
patches (inlet1 inlet2);
points
(
(0 -0.05 0.05)
(0 -0.05 0.15)
(0 0.05 0.15)
(0 0.05 0.05)
);
maxDistance 0.01;
axis x;
}Definition at line 103 of file boundaryPoints.H.
| boundaryPoints | ( | const word & | name, |
| const polyMesh & | mesh, | ||
| const meshSearch & | searchEngine, | ||
| const dictionary & | dict | ||
| ) |
Construct from dictionary.
Definition at line 234 of file boundaryPoints.C.
References Foam::Info, and sampledSets::write().
|
virtual |
Destructor.
Definition at line 257 of file boundaryPoints.C.
| TypeName | ( | "boundaryPoints" | ) |
Runtime type information.
1.8.13