coordSet Class Reference

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
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...
typedef SubField< Type >	subField
	Declare type of subField. More...

Public Member Functions
	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
	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 UList< Type > &)
	Construct as copy of a UList<Type> More...
	Field (const Xfer< List< Type > > &)
	Construct by transferring the List contents. 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 (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...
	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...
	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied uniform. More...
	Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given tmp field. Supplied values. More...
	Field (const Field< Type > &)
	Construct as copy. More...
	Field (Field< Type > &, bool reUse)
	Construct as copy or re-use as specified. More...
	Field (const Xfer< Field< Type > > &)
	Construct by transferring the Field contents. More...
	Field (const tmp< Field< Type > > &)
	Construct as copy of 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	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...
void	map (const tmp< Field< Type > > &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< 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...
tmp< Field< Type > >	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...
void	operator= (const Field< Type > &)
void	operator= (const UList< Type > &)
void	operator= (const SubField< Type > &)
void	operator= (const tmp< Field< Type > > &)
void	operator= (const Type &)
template<class Form , class Cmpt , int 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 Field< Type > &rhs)
template<class Type >
void	operator= (const SubField< Type > &rhs)
template<class Type >
void	operator= (const UList< Type > &rhs)
template<class Type >
void	operator= (const tmp< Field > &rhs)
template<class Type >
void	operator= (const Type &t)

Protected Attributes
const word	name_
	Name. More...
const coordFormat	axis_
	Axis write type. More...
scalarList	curveDist_
	Cumulative distance "distance" write specifier. More...

Static Private Attributes
static const NamedEnum< coordFormat, 5 >	coordFormatNames_
	String representation of coordFormat enums. More...

Additional Inherited Members
Static Public Member Functions inherited from Field
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 Attributes inherited from Field
static const char *const	typeName

Detailed Description

Holds list of sampling positions.

Source files

• coordSet.H
• coordSet.C

Definition at line 49 of file coordSet.H.

Member Enumeration Documentation

coordFormat

enum coordFormat

Enumeration defining the output format for coordinates.

Enumerator
XYZ
X
Y
Z
DISTANCE

Definition at line 59 of file coordSet.H.

Constructor & Destructor Documentation

coordSet() [1/2]

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

Construct from components.

Definition at line 56 of file coordSet.C.

coordSet() [2/2]

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

Construct from components.

Definition at line 70 of file coordSet.C.

Member Function Documentation

name()

const word& name ( ) const

inline

Definition at line 111 of file coordSet.H.

References coordSet::name_.

Referenced by sampledSets::combineSampledSets(), and sampledSet::iNew::operator()().

Here is the caller graph for this function:

axis()

word axis ( ) const

inline

Definition at line 116 of file coordSet.H.

References coordSet::axis_, and coordSet::coordFormatNames_.

Referenced by sampledSets::combineSampledSets().

Here is the caller graph for this function:

curveDist()

const scalarList& curveDist ( ) const

inline

Cumulative distance.

Definition at line 122 of file coordSet.H.

References coordSet::curveDist_.

Referenced by sampledSets::combineSampledSets().

Here is the caller graph for this function:

hasVectorAxis()

bool hasVectorAxis

(

)

const

Is axis specification a vector.

Definition at line 86 of file coordSet.C.

References coordSet::axis_, and coordSet::XYZ.

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 93 of file coordSet.C.

References 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 128 of file coordSet.C.

References p.

write()

Foam::Ostream & write

(

Ostream &

os

)

const

Definition at line 136 of file coordSet.C.

References Foam::endl(), and forAll.

Referenced by sampledSet::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

coordFormatNames_

const Foam::NamedEnum< Foam::coordSet::coordFormat, 5 > coordFormatNames_

staticprivate

String representation of coordFormat enums.

Definition at line 72 of file coordSet.H.

Referenced by coordSet::axis().

name_

const word name_

protected

Name.

Definition at line 78 of file coordSet.H.

Referenced by coordSet::name().

axis_

const coordFormat axis_

protected

Axis write type.

Definition at line 81 of file coordSet.H.

Referenced by coordSet::axis(), and coordSet::hasVectorAxis().

curveDist_

scalarList curveDist_

protected

Cumulative distance "distance" write specifier.

Definition at line 84 of file coordSet.H.

Referenced by coordSet::curveDist(), and midPointAndFaceSet::genSamples().

---

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

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