coordSet Class Reference

Holds list of sampling positions. More...

Inheritance diagram for coordSet:

[legend]

Collaboration diagram for coordSet:

[legend]

List of all members.

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
Protected Attributes
const word	name_
	Name.
const word	axis_
	Axis write type.
point	refPoint_
	Reference point for "distance" write specifier.

---

Detailed Description

Holds list of sampling positions.

Source files

• coordSet.H
• coordSet.C

Definition at line 45 of file coordSet.H.

---

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 27 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 41 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 57 of file coordSet.C.

---

Member Function Documentation

const word& name

(

)

const [inline]

Definition at line 94 of file coordSet.H.

const word& axis

(

)

const [inline]

Definition at line 99 of file coordSet.H.

References coordSet::name_.

const point& refPoint

(

)

const [inline]

Definition at line 104 of file coordSet.H.

References coordSet::axis_.

bool hasVectorAxis

(

)

const

Is axis specification a vector.

Definition at line 98 of file coordSet.C.

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

References coordSet::axis_.

Foam::point vectorCoord

(

const label

index

)

const

Get point according to axis="full" specification.

Definition at line 142 of file coordSet.C.

Foam::Ostream & write

(

Ostream &

os

)

const

Reimplemented in sampledSet.

Definition at line 150 of file coordSet.C.

---

Member Data Documentation

const word name_ [protected]

Name.

Definition at line 53 of file coordSet.H.

Referenced by coordSet::axis().

const word axis_ [protected]

Axis write type.

Definition at line 56 of file coordSet.H.

Referenced by coordSet::refPoint(), and coordSet::scalarCoord().

point refPoint_ [protected]

Reference point for "distance" write specifier.

Definition at line 59 of file coordSet.H.

---

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

• src/sampling/sampledSet/coordSet/coordSet.H
• src/sampling/sampledSet/coordSet/coordSet.C