Public Types | Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
coordSet Class Reference

Holds list of sampling positions. More...

Inheritance diagram for coordSet:
Inheritance graph
[legend]
Collaboration diagram for coordSet:
Collaboration graph
[legend]

Public Types

enum  coordFormat {
  XYZ, X, Y, Z,
  DISTANCE
}
 
- Public Types inherited from Field
typedef pTraits< Type >::cmptType cmptType
 
typedef SubField< Type > subField
 

Public Member Functions

 coordSet (const word &name, const coordFormat axisType)
 
 coordSet (const word &name, const word &axis)
 
 coordSet (const word &name, const word &axis, const List< point > &points, const scalarList &curveDist)
 
 coordSet (const word &name, const word &axis, List< point > &&points, scalarList &&curveDist)
 
const word & name () const
 
word axis () const
 
void setPoints (const List< point > &newPoints)
 
void setPoints (List< point > &&newPoints)
 
const scalarList & curveDist () const
 
void setCurveDist (const scalarList &curveDist)
 
void setCurveDist (scalarList &&curveDist)
 
bool hasVectorAxis () const
 
scalar scalarCoord (const label index) const
 
vector vectorCoord (const label index) const
 
Ostream & write (Ostream &os) const
 
- Public Member Functions inherited from Field
constexpr Field () noexcept
 
 Field (const label len)
 
 Field (const label len, const Type &val)
 
 Field (const label len, const Foam::zero)
 
 Field (const Foam::one, const Type &val)
 
 Field (const Foam::one, Type &&val)
 
 Field (const Foam::one, const Foam::zero)
 
 Field (const Field< Type > &fld)
 
 Field (const UList< Type > &list)
 
template<class Addr >
 Field (const IndirectListBase< Type, Addr > &list)
 
 Field (Field< Type > &&fld)
 
 Field (List< Type > &&list)
 
template<int SizeMin>
 Field (DynamicList< Type, SizeMin > &&list)
 
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 
 Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 
 Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
 
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
 
 Field (Field< Type > &fld, bool reuse)
 
 Field (const tmp< Field< Type >> &tfld)
 
 Field (Istream &is)
 
 Field (const word &keyword, const dictionary &dict, const label len)
 
tmp< Field< Type > > clone () const
 
void map (const UList< Type > &mapF, const labelUList &mapAddressing)
 
void map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 
void map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
 
void map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
 
void map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
 
void map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
 
void autoMap (const FieldMapper &map, const bool applyFlip=true)
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 
void rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 
void rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
 
void negate ()
 
tmp< Field< cmptType > > component (const direction) const
 
void replace (const direction, const UList< cmptType > &)
 
void replace (const direction, const tmp< Field< cmptType >> &)
 
void replace (const direction, const cmptType &)
 
template<class VSForm >
VSForm block (const label start) const
 
tmp< Field< Type > > T () const
 
void writeEntry (const word &keyword, Ostream &os) const
 
SubField< Type > slice (const label pos, label len=-1)
 
const SubField< Type > slice (const label pos, label len=-1) const
 
SubField< Type > slice (const labelRange &range)
 
const SubField< Type > slice (const labelRange &range) const
 
void operator= (const Field< Type > &)
 
void operator= (const tmp< Field< Type >> &)
 
void operator= (const UList< Type > &rhs)
 
void operator= (const SubField< Type > &rhs)
 
template<class Addr >
void operator= (const IndirectListBase< Type, Addr > &rhs)
 
void operator= (Field< Type > &&rhs)
 
void operator= (List< Type > &&rhs)
 
template<int SizeMin>
void operator= (DynamicList< Type, SizeMin > &&rhs)
 
void operator= (const Type &val)
 
void operator= (const Foam::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 >
 Field (const UList< Type > &mapF, const labelUList &mapAddressing)
 
template<class Type >
 Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
 
template<class Type >
 Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &mapWeights)
 
template<class Type >
 Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &mapWeights)
 
template<class Type >
 Field (const UList< Type > &mapF, const FieldMapper &mapper, const bool applyFlip)
 
template<class Type >
 Field (const UList< Type > &mapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)
 
template<class Type >
 Field (const UList< Type > &mapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)
 
template<class Type >
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const bool applyFlip)
 
template<class Type >
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const Type &defaultValue, const bool applyFlip)
 
template<class Type >
 Field (const tmp< Field< Type >> &tmapF, const FieldMapper &mapper, const UList< Type > &defaultValues, const bool applyFlip)
 
template<class Type >
 Field (const word &keyword, const dictionary &dict, const label len)
 
template<class Type >
void operator= (const Field< Type > &rhs)
 
template<class Type >
void operator= (const tmp< Field > &rhs)
 
template<class Type >
constexpr Field () noexcept
 
template<class Type >
 Field (const label len)
 
template<class Type >
 Field (const label len, const Type &val)
 
template<class Type >
 Field (const label len, const Foam::zero)
 
template<class Type >
 Field (const Foam::one, const Type &val)
 
template<class Type >
 Field (const Foam::one, Type &&val)
 
template<class Type >
 Field (const Foam::one, const Foam::zero)
 
template<class Type >
 Field (const Field< Type > &fld)
 
template<class Type >
 Field (const UList< Type > &list)
 
template<class Type >
 Field (Field< Type > &&fld)
 
template<class Type >
 Field (List< Type > &&list)
 
template<class Type >
 Field (Field< Type > &fld, bool reuse)
 
template<class Type >
 Field (const tmp< Field< Type >> &tfld)
 
template<class Type >
 Field (Istream &is)
 
template<class Type >
void operator= (const UList< Type > &rhs)
 
template<class Type >
void operator= (const SubField< Type > &rhs)
 
template<class Type >
void operator= (Field< Type > &&rhs)
 
template<class Type >
void operator= (List< Type > &&rhs)
 
template<class Type >
void operator= (const Type &val)
 
template<class Type >
void operator= (const Foam::zero)
 

Static Public Attributes

static const Enum< coordFormat > coordFormatNames
 

Protected Attributes

const word name_
 
const coordFormat axis_
 
scalarList curveDist_
 

Additional Inherited Members

- Static Public Member Functions inherited from Field
static const Field< Type > & null ()
 
static autoPtr< Field< Type > > New (Istream &is)
 
template<class Type2 >
static tmp< Field< Type > > NewCalculatedType (const Field< Type2 > &f)
 

Detailed Description

Holds list of sampling positions.

Source files

Definition at line 49 of file coordSet.H.

Member Enumeration Documentation

◆ coordFormat

enum coordFormat
strong
Enumerator
XYZ 
X 
Y 
Z 
DISTANCE 

Definition at line 58 of file coordSet.H.

Constructor & Destructor Documentation

◆ coordSet() [1/4]

coordSet ( const word &  name,
const coordFormat  axisType 
)

Definition at line 58 of file coordSet.C.

◆ coordSet() [2/4]

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

Definition at line 71 of file coordSet.C.

◆ coordSet() [3/4]

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

Definition at line 84 of file coordSet.C.

◆ coordSet() [4/4]

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

Definition at line 101 of file coordSet.C.

Member Function Documentation

◆ name()

const word& name ( ) const
inline

Definition at line 121 of file coordSet.H.

References coordSet::name_.

Referenced by meshRefinement::findRegions(), and sampledSet::iNew::operator()().

Here is the caller graph for this function:

◆ axis()

word axis ( ) const
inline

Definition at line 126 of file coordSet.H.

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

Referenced by meshRefinement::findRegions().

Here is the caller graph for this function:

◆ setPoints() [1/2]

void setPoints ( const List< point > &  newPoints)
inline

Definition at line 132 of file coordSet.H.

◆ setPoints() [2/2]

void setPoints ( List< point > &&  newPoints)
inline

Definition at line 138 of file coordSet.H.

◆ curveDist()

const scalarList& curveDist ( ) const
inline

Definition at line 144 of file coordSet.H.

References coordSet::curveDist_.

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

Here is the caller graph for this function:

◆ setCurveDist() [1/2]

void setCurveDist ( const scalarList &  curveDist)
inline

Definition at line 150 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

Definition at line 157 of file coordSet.H.

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

Here is the call graph for this function:

◆ hasVectorAxis()

bool hasVectorAxis ( ) const

Definition at line 119 of file coordSet.C.

◆ scalarCoord()

Foam::scalar scalarCoord ( const label  index) const

Definition at line 125 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

Definition at line 171 of file coordSet.C.

References p.

◆ write()

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

Definition at line 179 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

Definition at line 68 of file coordSet.H.

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

◆ name_

const word name_
protected

Definition at line 79 of file coordSet.H.

Referenced by coordSet::name().

◆ axis_

const coordFormat axis_
protected

Definition at line 82 of file coordSet.H.

Referenced by coordSet::axis().

◆ curveDist_

scalarList curveDist_
protected

Definition at line 85 of file coordSet.H.

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

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17