Holds list of sampling positions. More...

#include <coordSet.H>

Inheritance diagram for coordSet:

[legend]

Collaboration diagram for coordSet:

[legend]

Public Types
enum class	coordFormat { X , Y , Z , RADIUS , DISTANCE , XYZ }
	Enumeration defining the output format for coordinates. More...
Public Types inherited from Field< vector >
typedef pTraits< vector >::cmptType	cmptType
	Component type.
typedef SubField< vector >	subField
	Declare type of subField.
Public Types inherited from List< vector >
typedef SubList< vector >	subList
	Declare type of subList.
Public Types inherited from UList< vector >
typedef vector	value_type
	The value type the list contains.
typedef vector *	pointer
	The pointer type for non-const access to value_type items.
typedef const vector *	const_pointer
	The pointer type for const access to value_type items.
typedef vector &	reference
	The type used for storing into value_type objects.
typedef const vector &	const_reference
	The type used for reading from constant value_type objects.
typedef vector *	iterator
	Random access iterator for traversing a UList.
typedef const vector *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.

Public Member Functions
	coordSet (const word &name, const coordFormat axisType)
	Default construct with name and axis type.
	coordSet (const word &name, const word &axis)
	Default construct with name and axis type.
	coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &dist)
	Copy construct from components.
	coordSet (const word &name, const word &axis, List< point > &&points, scalarList &&dist)
	Move construct from components.
const word &	name () const noexcept
	The coord-set name.
const word &	axis () const
	The sort axis name.
const pointField &	points () const noexcept
	Return the points.
const scalarList &	distance () const noexcept
	Return the cumulative distance.
label	nPoints () const noexcept
	Return the number of points.
void	rename (const word &newName)
	Rename the coordinate set.
void	setPoints (const List< point > &newPoints)
	Copy assign new points.
void	setPoints (List< point > &&newPoints)
	Move assign new points.
void	setDistance (const scalarList &dist, const bool check=true)
	Copy assign the cumulative distance.
void	setDistance (scalarList &&dist, const bool check=true)
	Move assign the cumulative distance.
bool	hasVectorAxis () const noexcept
	True if axis specification is a vector.
scalar	scalarCoord (const label index) const
	Get coordinate of point according to axis specification.
const vector &	vectorCoord (const label index) const
	Get point according to axis="xyz" specification.
Ostream &	write (Ostream &os) const
	Write to stream.
autoPtr< coordSet >	gatherSort (labelList &sortOrder) const
	Gather and sort.
const scalarList &	curveDist () const noexcept
	Return the cumulative distance.
void	setCurveDist (const scalarList &dist)
	Copy assign the cumulative distance.
Public Member Functions inherited from Field< vector >
constexpr	Field () noexcept
	Default construct.
	Field (const label len)
	Construct given size.
	Field (const label len, const vector &val)
	Construct given size and initial value.
	Field (const label len, Foam::zero)
	Construct given size and initial values of zero.
	Field (Foam::one, const vector &val)
	Construct with length=1, copying the value as the only content.
	Field (Foam::one, vector &&val)
	Construct with length=1, moving the value as the only content.
	Field (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	Field (const Field< vector > &fld)
	Copy construct.
	Field (const UList< vector > &list)
	Copy construct from UList<Type>.
	Field (const IndirectListBase< vector, Addr > &list)
	Copy construct from IndirectList.
	Field (Field< vector > &&fld) noexcept
	Move construct from Field.
	Field (List< vector > &&list) noexcept
	Move construct from List.
	Field (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList.
	Field (const UList< vector > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const labelUList &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, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field.
	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field.
	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied uniform value for unmapped items.
	Field (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Uses supplied values for unmapped items.
	Field (Field< vector > &fld, bool reuse)
	Copy construct or re-use as specified.
	Field (const tmp< Field< vector > > &tfld)
	Copy or move construct from tmp.
	Field (Istream &is)
	Construct from Istream.
	Field (const entry &e, const label len)
	Construct from a dictionary (primitive) entry.
	Field (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup of a primitive dictionary entry by (literal) name and assign its contents to this. The behaviour largely as described in assign():
tmp< Field< vector > >	clone () const
	Clone.
void	assign (const entry &e, const label len)
	Assign from a primitive dictionary entry with the following behaviour:
bool	assign (const word &key, const dictionary &dict, const label len, IOobjectOption::readOption readOpt=IOobjectOption::MUST_READ)
	Lookup a primitive dictionary entry by (literal) name and assign its contents to this (behaviour as described above).
void	map (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field
void	map (const tmp< Field< vector > > &tmapF, const labelUList &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, const bool applyFlip=true)
	Map from the given field.
void	map (const tmp< Field< vector > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field.
void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self.
void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field
void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field
void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field.
void	rmap (const tmp< Field< vector > > &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field.
void	negate ()
	Inplace negate this field (negative).
void	normalise ()
	Inplace normalise this field. Generally a no-op except for vector fields.
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.
void	clamp_min (const vector &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_min (const UList< vector > &lower)
	Impose lower (floor) clamp on the field values (in-place).
void	clamp_max (const vector &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_max (const UList< vector > &upper)
	Impose upper (ceiling) clamp on the field values (in-place).
void	clamp_range (const vector &lower, const vector &upper)
	Clamp field values (in-place) to the specified range.
void	clamp_range (const MinMax< vector > &range)
	Clamp field values (in-place) to the specified range.
VSForm	block (const label start) const
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.
SubField< vector >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking.
const SubField< vector >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking.
SubField< vector >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking.
const SubField< vector >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking.
void	operator= (const Field< vector > &)
	Copy assignment.
void	operator= (const tmp< Field< vector > > &)
void	operator= (const UList< vector > &rhs)
void	operator= (const SubField< vector > &rhs)
void	operator= (const IndirectListBase< vector, Addr > &rhs)
	Copy assign from IndirectList.
void	operator= (Field< vector > &&rhs)
	Move assignment.
void	operator= (List< vector > &&rhs)
void	operator= (DynamicList< vector, SizeMin > &&rhs)
void	operator= (const vector &val)
	Assign entries to the given value.
void	operator= (Foam::zero)
	Assign entries to zero.
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)
void	operator+= (const UList< vector > &)
void	operator+= (const tmp< Field< vector > > &)
void	operator-= (const UList< vector > &)
void	operator-= (const tmp< Field< vector > > &)
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 vector &)
void	operator-= (const vector &)
void	operator*= (const scalar &)
void	operator/= (const scalar &)
	Field (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	operator= (const tmp< Field > &rhs)
void	normalise ()
void	normalise ()
void	normalise ()
	Inplace normalise (float) vector field.
void	normalise ()
	Inplace normalise (double) vector field.
Public Member Functions inherited from FieldBase
constexpr	FieldBase () noexcept
	Default construct.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.
Public Member Functions inherited from List< vector >
constexpr	List () noexcept
	Default construct.
	List (const label len)
	Construct with given size.
	List (const label len, const vector &val)
	Construct with given size and value for all elements.
	List (const label len, Foam::zero)
	Construct with given size initializing all elements to zero.
	List (Foam::one, const vector &val)
	Construct with length=1, copying the value as the only content.
	List (Foam::one, vector &&val)
	Construct with length=1, moving the value as the only content.
	List (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	List (const List< vector > &list)
	Copy construct from list.
	List (const UList< vector > &list)
	Copy construct contents from list.
	List (List< vector > &list, bool reuse)
	Construct as copy or re-use as specified.
	List (const UList< vector > &list, const labelUList &indices)
	Copy construct subset of list.
	List (const UList< vector > &list, const FixedList< label, N > &indices)
	Copy construct subset of list.
	List (const FixedList< vector, N > &list)
	Construct as copy of FixedList<T, N>.
	List (const UPtrList< vector > &list)
	Construct as copy of UPtrList<T> content.
	List (const IndirectListBase< vector, Addr > &list)
	Construct as copy of IndirectList contents.
	List (std::initializer_list< vector > list)
	Construct from an initializer list.
	List (List< vector > &&list) noexcept
	Move construct from List.
	List (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList.
	List (Istream &is)
	Construct from Istream.
autoPtr< List< vector > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize (const label len)
	Adjust allocated size of list.
void	resize (const label len, const vector &val)
	Adjust allocated size of list and set val for new elements.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const vector &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< vector > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
void	transfer (DynamicList< vector, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
vector &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
vector &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const vector &val)
	Append an element at the end of the list.
void	push_back (vector &&val)
	Move append an element at the end of the list.
void	push_back (const UList< vector > &list)
	Append a List to the end of this list.
void	push_back (const IndirectListBase< vector, Addr > &list)
	Append IndirectList contents at the end of this list.
label	push_uniq (const vector &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< vector > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (const List< vector > &list)
	Assignment operator. Takes linear time.
void	operator= (const IndirectListBase< vector, Addr > &list)
	Assignment from IndirectList. Takes linear time.
void	operator= (const FixedList< vector, N > &list)
	Copy assignment from FixedList.
void	operator= (std::initializer_list< vector > list)
	Assignment to an initializer list.
void	operator= (const vector &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
void	operator= (List< vector > &&list)
	Move assignment. Takes constant time.
void	operator= (DynamicList< vector, SizeMin > &&list)
	Move assignment. Takes constant time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< vector > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const vector &val)
	Append an element at the end of the list.
void	append (vector &&val)
	Move append an element at the end of the list.
void	append (const UList< vector > &list)
	Append a List to the end of this list.
void	append (const IndirectListBase< vector, Addr > &list)
	Append IndirectList contents at the end of this list.
label	appendUniq (const vector &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
void	setSize (label n, const vector &val)
	Alias for resize().
	List (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	resize (const label len)
Public Member Functions inherited from UList< vector >
	UList (const UList< vector > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< vector > &&) noexcept=default
	Move construct, shallow copy.
UList< vector > &	operator= (const UList< vector > &)=delete
	No copy assignment (default: shallow copy).
UList< vector > &	operator= (UList< vector > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (vector *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< vector > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const vector &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
vector &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const vector &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
vector &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const vector *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
vector *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
vector &	front ()
	Access first element of the list, position [0].
const vector &	front () const
	Access first element of the list.
vector &	back ()
	Access last element of the list, position [size()-1].
const vector &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const vector &val) const
	True if the value is contained in the list.
bool	contains (const vector &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const vector &val) const
	Find index of the first occurrence of the value.
label	find (const vector &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const vector &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (vector *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< vector > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< vector > &list)
	Copy elements of the given UList. Sizes must match!
void	deepCopy (const IndirectListBase< vector, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< vector >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< vector >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< vector >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< vector >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
vector &	operator[] (const label i)
	Return element of UList.
const vector &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< vector > & () const
	Allow cast to a const List<T>&.
void	operator= (const vector &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return 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.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< vector > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< vector > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< vector > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< vector > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< vector > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< vector > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< vector > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
vector &	first ()
	Access first element of the list, position [0].
const vector &	first () const
	Access first element of the list.
vector &	last ()
	Access last element of the list, position [size()-1].
const vector &	last () const
	Access last element of the list, position [size()-1].
bool	found (const vector &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
	operator const Foam::List< vector > & () const
	Allow cast to a const List<T>&.

Static Public Attributes
static const Enum< coordFormat >	coordFormatNames
	String representation of coordFormat enum.
Static Public Attributes inherited from FieldBase
static const char *const	typeName
	Typename for Field.
static bool	allowConstructFromLargerSize = false
	Permit read construct from a larger size.
static bool	unifiedGeometricField
	GeometricField with extra capacity for flattened boundary fields. Uses opt-switch "unifiedGeometricField".
static int	localBoundaryConsistency_
	Local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency".
static scalar	localBoundaryTolerance_
	Tolerance for local boundary field consistency checks. Uses opt-switch "localBoundaryConsistency::tolerance".

Protected Member Functions
void	checkDimensions () const
	Check for consistent dimensions of points and curve distance.
Protected Member Functions inherited from UList< vector >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const vector &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

Protected Attributes
word	name_
	Name.
scalarList	distance_
	Cumulative distance for "distance" write specifier.
coordFormat	axis_
	Axis type.

Additional Inherited Members
Static Public Member Functions inherited from Field< vector >
static const Field< vector > &	null () noexcept
	Return a null Field (reference to a nullObject). Behaves like an empty Field.
static autoPtr< Field< vector > >	New (Istream &is)
	Return a pointer to a new Field created on freestore.
static tmp< Field< vector > >	NewCalculatedType (const Field< Type2 > &f)
	Return a pointer to a new calculatedFvPatchFieldField created on freestore without setting patchField values.
Static Public Member Functions inherited from FieldBase
static void	warnLocalBoundaryConsistencyCompat (const dictionary &)
	Warn about keyword changes for local boundary consistency checks.
static int	localBoundaryConsistency () noexcept
	Get flag for local boundary consistency checks.
static int	localBoundaryConsistency (int val) noexcept
	Set flag for local boundary consistency checks.
Static Public Member Functions inherited from List< vector >
static const List< vector > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< vector >
static const UList< vector > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.

Detailed Description

Holds list of sampling positions.

Source files

Definition at line 49 of file coordSet.H.

Member Enumeration Documentation

◆ coordFormat

enum class coordFormat

strong

Enumeration defining the output format for coordinates.

Enumerator
X	Use 'x' component of points for (scalar) axis.
Y	Use 'y' component of points for (scalar) axis.
Z	Use 'z' component of points for (scalar) axis.
RADIUS	Use mag of points for (scalar) axis.
DISTANCE	Use additional distance field for (scalar) axis.
XYZ	Use x,y,z point values

Definition at line 60 of file coordSet.H.

Constructor & Destructor Documentation

◆ coordSet() [1/4]

coordSet	(	const word &	name,
		const coordFormat	axisType )

Default construct with name and axis type.

//- Default construct coordSet();

Definition at line 69 of file coordSet.C.

References axis_, distance_, name(), and name_.

Referenced by coordSet(), sampledSet::sampledSet(), sampledSet::sampledSet(), and sampledSet::sampledSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ coordSet() [2/4]

coordSet	(	const word &	name,
		const word &	axis )

Default construct with name and axis type.

Definition at line 82 of file coordSet.C.

References axis(), coordFormatNames, coordSet(), UList< vector >::get(), and name().

Here is the call graph for this function:

◆ coordSet() [3/4]

coordSet	(	const word &	name,
		const word &	axis,
		const List< point > &	points,
		const scalarList &	dist )

Copy construct from components.

Definition at line 92 of file coordSet.C.

References axis(), axis_, checkDimensions(), coordFormatNames, distance_, name(), name_, and points().

Here is the call graph for this function:

◆ coordSet() [4/4]

coordSet	(	const word &	name,
		const word &	axis,
		List< point > &&	points,
		scalarList &&	dist )

Move construct from components.

Definition at line 109 of file coordSet.C.

References axis(), axis_, checkDimensions(), coordFormatNames, distance_, UList< vector >::get(), name(), name_, and points().

Here is the call graph for this function:

Member Function Documentation

◆ checkDimensions()

void checkDimensions ( ) const

protected

Check for consistent dimensions of points and curve distance.

Definition at line 45 of file coordSet.C.

References Foam::abort(), distance(), Foam::FatalError, FatalErrorInFunction, Foam::nl, points(), UList< T >::size(), and UList< vector >::size().

Referenced by coordSet(), coordSet(), setDistance(), and setDistance().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name()

const word & name ( ) const

inlinenoexcept

The coord-set name.

Definition at line 152 of file coordSet.H.

References name_, and Foam::noexcept.

Referenced by abaqusMeshSet::abaqusMeshSet(), arraySet::arraySet(), arraySet::arraySet(), cellCentreSet::cellCentreSet(), cellCentreSet::cellCentreSet(), searchableSurfaces::checkIntersection(), circleSet::circleSet(), circleSet::circleSet(), cloudSet::cloudSet(), cloudSet::cloudSet(), coordSet(), coordSet(), coordSet(), coordSet(), sampledSet::declareRunTimeSelectionTable(), faceOnlySet::faceOnlySet(), faceOnlySet::faceOnlySet(), sampledSet::New(), sampledSet::iNew::operator()(), sampledSet::iNewCapture::operator()(), patchCloudSet::patchCloudSet(), patchCloudSet::patchCloudSet(), patchEdgeSet::patchEdgeSet(), patchSeedSet::patchSeedSet(), polyLineSet::polyLineSet(), polyLineSet::polyLineSet(), sampledSet::sampledSet(), sampledSet::sampledSet(), sampledSet::sampledSet(), shortestPathSet::shortestPathSet(), shortestPathSet::shortestPathSet(), triSurfaceMeshPointSet::triSurfaceMeshPointSet(), abaqusMeshSet::TypeName(), arraySet::TypeName(), cellCentreSet::TypeName(), circleSet::TypeName(), cloudSet::TypeName(), patchCloudSet::TypeName(), patchEdgeSet::TypeName(), patchSeedSet::TypeName(), shortestPathSet::TypeName(), triSurfaceMeshPointSet::TypeName(), uniformSet::TypeName(), uniformSet::uniformSet(), uniformSet::uniformSet(), regionSizeDistribution::write(), and xmgraceWriter::writeTemplate().

Here is the caller graph for this function:

◆ axis()

const word & axis ( ) const

inline

The sort axis name.

Definition at line 160 of file coordSet.H.

References axis_, and coordFormatNames.

Referenced by arraySet::arraySet(), cellCentreSet::cellCentreSet(), circleSet::circleSet(), cloudSet::cloudSet(), coordSet(), coordSet(), coordSet(), faceOnlySet::faceOnlySet(), gatherSort(), midPointAndFaceSet::midPointAndFaceSet(), midPointSet::midPointSet(), patchCloudSet::patchCloudSet(), polyLineSet::polyLineSet(), sampledSet::sampledSet(), shortestPathSet::shortestPathSet(), arraySet::TypeName(), cellCentreSet::TypeName(), circleSet::TypeName(), cloudSet::TypeName(), midPointAndFaceSet::TypeName(), midPointSet::TypeName(), patchCloudSet::TypeName(), shortestPathSet::TypeName(), uniformSet::TypeName(), uniformSet::uniformSet(), Foam::writeCoordHeader(), and xmgraceWriter::writeTemplate().

Here is the caller graph for this function:

◆ points()

const pointField & points ( ) const

inlinenoexcept

Return the points.

Definition at line 168 of file coordSet.H.

References Foam::noexcept.

Referenced by checkDimensions(), coordSet(), and coordSet().

Here is the caller graph for this function:

◆ distance()

const scalarList & distance ( ) const

inlinenoexcept

Return the cumulative distance.

Definition at line 176 of file coordSet.H.

References distance_, and Foam::noexcept.

Referenced by checkDimensions().

Here is the caller graph for this function:

◆ nPoints()

label nPoints ( ) const

inlinenoexcept

Return the number of points.

Definition at line 184 of file coordSet.H.

References Foam::noexcept, and UList< vector >::size().

Referenced by uniformSet::TypeName(), and uniformSet::uniformSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rename()

void rename ( const word & newName )

inline

Rename the coordinate set.

Definition at line 195 of file coordSet.H.

References name_.

◆ setPoints() [1/2]

void setPoints ( const List< point > & newPoints )

inline

Copy assign new points.

Definition at line 203 of file coordSet.H.

Referenced by sampledSet::setSamples(), and sampledSet::setSamples().

Here is the caller graph for this function:

◆ setPoints() [2/2]

void setPoints ( List< point > && newPoints )

inline

Move assign new points.

Definition at line 211 of file coordSet.H.

◆ setDistance() [1/2]

void setDistance	(	const scalarList &	dist,
		const bool	check = true )

inline

Copy assign the cumulative distance.

Definition at line 219 of file coordSet.H.

References Foam::check(), checkDimensions(), and distance_.

Referenced by setCurveDist(), sampledSet::setSamples(), and sampledSet::setSamples().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDistance() [2/2]

void setDistance	(	scalarList &&	dist,
		const bool	check = true )

inline

Move assign the cumulative distance.

Definition at line 228 of file coordSet.H.

References Foam::check(), checkDimensions(), and distance_.

Here is the call graph for this function:

◆ hasVectorAxis()

bool hasVectorAxis ( ) const

noexcept

True if axis specification is a vector.

Definition at line 128 of file coordSet.C.

References axis_, Foam::noexcept, and XYZ.

Referenced by coordSetWriter::getBufferLine(), Foam::writeCoordHeader(), and coordSetWriter::writeTable().

Here is the caller graph for this function:

◆ scalarCoord()

Foam::scalar scalarCoord ( const label index ) const

Get coordinate of point according to axis specification.

If axis="distance" is the distance[index]

Definition at line 134 of file coordSet.C.

References Foam::abort(), axis_, coordFormatNames, DISTANCE, Foam::distance(), UList< vector >::empty(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), name_, points, RADIUS, X, Y, and Z.

Referenced by coordSetWriter::getBufferLine(), and coordSetWriter::writeTable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vectorCoord()

const Foam::point & vectorCoord ( const label index ) const

Get point according to axis="xyz" specification.

Definition at line 181 of file coordSet.C.

References points.

Referenced by coordSetWriter::getBufferLine(), and coordSetWriter::writeTable().

Here is the caller graph for this function:

◆ write()

Foam::Ostream & write ( Ostream & os ) const

Write to stream.

Definition at line 187 of file coordSet.C.

References axis_, coordFormatNames, name_, Foam::nl, os(), and p.

Referenced by sampledSet::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherSort()

Foam::autoPtr< Foam::coordSet > gatherSort ( labelList & sortOrder ) const

Gather and sort.

Returns: (on master) gathered set and overall sort order

Definition at line 202 of file coordSet.C.

References axis(), Foam::distance(), UList< T >::empty(), Foam::endl(), globalIndex::gatherOp(), UPstream::master(), name, autoPtr< T >::New(), points, Foam::sortedOrder(), and WarningInFunction.

Here is the call graph for this function:

◆ curveDist()

const scalarList & curveDist ( ) const

inlinenoexcept

Return the cumulative distance.

Definition at line 275 of file coordSet.H.

References curveDist(), distance_, and Foam::noexcept.

Referenced by curveDist().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCurveDist()

void setCurveDist ( const scalarList & dist )

inline

Copy assign the cumulative distance.

Definition at line 283 of file coordSet.H.

References setDistance().

Here is the call graph for this function:

Member Data Documentation

◆ coordFormatNames

const Foam::Enum< Foam::coordSet::coordFormat > coordFormatNames

static

String representation of coordFormat enum.

Definition at line 74 of file coordSet.H.

Referenced by axis(), coordSet(), coordSet(), coordSet(), scalarCoord(), and write().

◆ name_

word name_

protected

Name.

Definition at line 84 of file coordSet.H.

Referenced by coordSet(), coordSet(), coordSet(), name(), rename(), scalarCoord(), and write().

◆ distance_

scalarList distance_

protected

Cumulative distance for "distance" write specifier.

Definition at line 89 of file coordSet.H.

Referenced by sampledSet::checkDimensions(), coordSet(), coordSet(), coordSet(), curveDist(), distance(), setDistance(), and setDistance().

◆ axis_

coordFormat axis_

protected

Axis type.

Definition at line 94 of file coordSet.H.

Referenced by axis(), coordSet(), coordSet(), coordSet(), hasVectorAxis(), scalarCoord(), and write().

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

src/meshTools/coordSet/coordSet.H
src/meshTools/coordSet/coordSet.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ coordFormat

Constructor & Destructor Documentation

◆ coordSet() [1/4]

◆ coordSet() [2/4]

◆ coordSet() [3/4]

◆ coordSet() [4/4]

Member Function Documentation

◆ checkDimensions()

◆ name()

◆ axis()

◆ points()

◆ distance()

◆ nPoints()

◆ rename()

◆ setPoints() [1/2]

◆ setPoints() [2/2]

◆ setDistance() [1/2]

◆ setDistance() [2/2]

◆ hasVectorAxis()

◆ scalarCoord()

◆ vectorCoord()

◆ write()

◆ gatherSort()

◆ curveDist()

◆ setCurveDist()

Member Data Documentation

◆ coordFormatNames

◆ name_

◆ distance_

◆ axis_