Holds list of sampling positions. More...

Inheritance diagram for coordSet:

Collaboration diagram for coordSet:

Public Types
enum	coordFormat { XYZ, X, Y, Z, DISTANCE }
	Enumeration defining the output format for coordinates. More...

Public Types inherited from Field< vector >
typedef pTraits< vector >::cmptType	cmptType
	Component type. More...

typedef SubField< vector >	subField
	Declare type of subField. More...

Public Member Functions
	coordSet (const word &name, const coordFormat axisType)
	Construct from components. More...

	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)
	Copy construct from components. More...

	coordSet (const word &name, const word &axis, List< point > &&points, scalarList &&curveDist)
	Move construct from components. More...

const word &	name () const

word	axis () const

void	setPoints (const List< point > &newPoints)
	Set the points. More...

void	setPoints (List< point > &&newPoints)
	Set the points. More...

const scalarList &	curveDist () const
	Return the cumulative distance. More...

void	setCurveDist (const scalarList &curveDist)
	Set the cumulative distance. More...

void	setCurveDist (scalarList &&curveDist)
	Set the 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
	Write to stream. More...

Public Member Functions inherited from Field< vector >
constexpr	Field () noexcept
	Default construct. More...

	Field (const label len)
	Construct given size. More...

	Field (const label len, const vector &val)
	Construct given size and initial value. More...

	Field (const label len, const Foam::zero)
	Construct given size and initial values of zero. More...

	Field (const Foam::one, const vector &val)
	Construct with length=1, copying the value as the only content. More...

	Field (const Foam::one, vector &&val)
	Construct with length=1, moving the value as the only content. More...

	Field (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	Field (const Field< vector > &fld)
	Copy construct. More...

	Field (const UList< vector > &list)
	Copy construct from UList<Type> More...

	Field (const IndirectListBase< vector, Addr > &list)
	Copy construct from IndirectList. More...

	Field (Field< vector > &&fld)
	Move construct from Field. More...

	Field (List< vector > &&list)
	Move construct from List. More...

	Field (DynamicList< vector, SizeMin > &&list)
	Move construct from DynamicList. More...

	Field (const UList< vector > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< vector >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< vector > &mapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< vector > &mapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const vector &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const UList< vector > &defaultValues, const bool applyFlip=true)

	Field (Field< vector > &fld, bool reuse)
	Copy construct or re-use as specified. More...

	Field (const tmp< Field< vector >> &tfld)
	Copy or move construct from tmp. More...

	Field (Istream &is)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &dict, const label len)
	Construct from a dictionary entry. More...

tmp< Field< vector > >	clone () const
	Clone. More...

void	map (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< vector > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< vector >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< vector > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< vector >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< vector > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< vector >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Negate this field (negative). 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...

VSForm	block (const label start) const

tmp< Field< vector > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

SubField< vector >	slice (const label pos, label len=-1)
	Return SubField slice (non-const access) - no range checking. More...

const SubField< vector >	slice (const label pos, label len=-1) const
	Return SubField slice (const access) - no range checking. More...

SubField< vector >	slice (const labelRange &range)
	Return SubField slice (non-const access) - with range checking. More...

const SubField< vector >	slice (const labelRange &range) const
	Return SubField slice (const access) - with range checking. More...

void	operator= (const Field< vector > &)
	Copy assignment. More...

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. More...

void	operator= (Field< vector > &&rhs)
	Move assignment. More...

void	operator= (List< vector > &&rhs)

void	operator= (DynamicList< vector, SizeMin > &&rhs)

void	operator= (const vector &val)
	Value assignment. More...

void	operator= (const Foam::zero)

void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator= (const tmp< Field > &rhs)

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 &)

Static Public Attributes
static const Enum< coordFormat >	coordFormatNames
	String representation of coordFormat enum. More...

Protected Attributes
const word	name_
	Name. More...

const coordFormat	axis_
	Axis write type. More...

scalarList	curveDist_
	Cumulative distance "distance" write specifier. More...

Additional Inherited Members
Static Public Member Functions inherited from Field< vector >
static const Field< vector > &	null ()
	Return nullObject reference Field. More...

static autoPtr< Field< vector > >	New (Istream &is)
	Return a pointer to a new Field created on freestore. More...

static tmp< Field< vector > >	NewCalculatedType (const Field< Type2 > &f)

Detailed Description

Holds list of sampling positions.

Source files

Definition at line 53 of file coordSet.H.

Member Enumeration Documentation

◆ coordFormat

enum coordFormat

strong

Enumeration defining the output format for coordinates.

Enumerator
XYZ
X
Y
Z
DISTANCE

Definition at line 62 of file coordSet.H.

Constructor & Destructor Documentation

◆ coordSet() [1/4]

coordSet	(	const word &	name,
		const coordFormat	axisType
	)

Construct from components.

Note: curveDist will be empty

Definition at line 65 of file coordSet.C.

◆ coordSet() [2/4]

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

Construct from components.

Note: curveDist will be empty

Definition at line 78 of file coordSet.C.

◆ coordSet() [3/4]

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

Copy construct from components.

Definition at line 91 of file coordSet.C.

◆ coordSet() [4/4]

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

Move construct from components.

Definition at line 108 of file coordSet.C.

Member Function Documentation

◆ name()

const word& name ( ) const

inline

Definition at line 125 of file coordSet.H.

References coordSet::name_.

Referenced by sampledSet::iNew::operator()().

Here is the caller graph for this function:

◆ axis()

word axis ( ) const

inline

Definition at line 130 of file coordSet.H.

References coordSet::axis_, and coordSet::coordFormatNames.

◆ setPoints() [1/2]

void setPoints ( const List< point > & newPoints )

inline

Set the points.

Definition at line 136 of file coordSet.H.

◆ setPoints() [2/2]

void setPoints ( List< point > && newPoints )

inline

Set the points.

Definition at line 142 of file coordSet.H.

◆ curveDist()

const scalarList& curveDist ( ) const

inline

Return the cumulative distance.

Definition at line 148 of file coordSet.H.

References coordSet::curveDist_.

Referenced by coordSet::setCurveDist().

Here is the caller graph for this function:

◆ setCurveDist() [1/2]

void setCurveDist ( const scalarList & curveDist )

inline

Set the cumulative distance.

Definition at line 154 of file coordSet.H.

References coordSet::curveDist(), and coordSet::curveDist_.

Here is the call graph for this function:

◆ setCurveDist() [2/2]

void setCurveDist ( scalarList && curveDist )

inline

Set the cumulative distance.

Definition at line 161 of file coordSet.H.

References coordSet::curveDist(), and coordSet::curveDist_.

Here is the call graph for this function:

◆ hasVectorAxis()

bool hasVectorAxis ( ) const

Is axis specification a vector.

Definition at line 126 of file coordSet.C.

◆ scalarCoord()

Foam::scalar scalarCoord ( const label index ) const

Get coordinate of point according to axis specification.

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

Definition at line 132 of file coordSet.C.

References Foam::abort(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, p, and Y.

Here is the call graph for this function:

◆ vectorCoord()

Foam::point vectorCoord ( const label index ) const

Get point according to axis="xyz" specification.

Definition at line 178 of file coordSet.C.

References p.

◆ write()

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

Write to stream.

Definition at line 186 of file coordSet.C.

References Foam::endl(), Foam::nl, and os().

Referenced by sampledSet::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ coordFormatNames

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

static

String representation of coordFormat enum.

Definition at line 72 of file coordSet.H.

Referenced by coordSet::axis(), and meshRefinement::findRegions().

◆ name_

const word name_

protected

Name.

Definition at line 83 of file coordSet.H.

Referenced by coordSet::name().

◆ axis_

const coordFormat axis_

protected

Axis write type.

Definition at line 86 of file coordSet.H.

Referenced by coordSet::axis().

◆ curveDist_

scalarList curveDist_

protected

Cumulative distance "distance" write specifier.

Definition at line 89 of file coordSet.H.

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

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

src/fileFormats/coordSet/coordSet.H
src/fileFormats/coordSet/coordSet.C

Public Types

Public Member Functions

Static Public Attributes

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

◆ name()

◆ axis()

◆ setPoints() [1/2]

◆ setPoints() [2/2]

◆ curveDist()

◆ setCurveDist() [1/2]

◆ setCurveDist() [2/2]

◆ hasVectorAxis()

◆ scalarCoord()

◆ vectorCoord()

◆ write()

Member Data Documentation

◆ coordFormatNames

◆ name_

◆ axis_

◆ curveDist_