vectorAndError Class Reference

Vector of scalarAndError-s. More...

Inheritance diagram for vectorAndError:
Collaboration diagram for vectorAndError:

Public Member Functions

Vector< scalar > value () const
 Return the value. More...
 
Vector< scalar > error () const
 Return the error. More...
 
- Public Member Functions inherited from Vector< scalarAndError >
 Vector ()
 Construct null. More...
 
 Vector (const Foam::zero)
 Construct initialised to zero. More...
 
 Vector (const VectorSpace< Vector< Cmpt2 >, Cmpt2, 3 > &)
 Construct given VectorSpace of the same rank. More...
 
 Vector (const scalarAndError &vx, const scalarAndError &vy, const scalarAndError &vz)
 Construct given three components. More...
 
 Vector (Istream &)
 Construct from Istream. More...
 
const scalarAndErrorx () const
 
scalarAndErrorx ()
 
const scalarAndErrory () const
 
scalarAndErrory ()
 
const scalarAndErrorz () const
 
scalarAndErrorz ()
 
const Vector< scalarAndError > & centre (const Foam::List< Vector< scalarAndError >> &) const
 Return *this (used for point which is a typedef to Vector<scalar>. More...
 
- Public Member Functions inherited from VectorSpace< Form, Cmpt, Ncmpts >
 VectorSpace ()
 Construct null. More...
 
 VectorSpace (const Foam::zero)
 Construct initialised to zero. More...
 
 VectorSpace (Istream &)
 Construct from Istream. More...
 
template<class Form2 , class Cmpt2 >
 VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
 Construct as copy of a VectorSpace with the same size. More...
 
const Cmpt & component (const direction) const
 
Cmpt & component (const direction)
 
void component (Cmpt &, const direction) const
 
void replace (const direction, const Cmpt &)
 
template<class SubVector , direction BStart>
const ConstBlock< SubVector, BStart > block () const
 
const Cmpt & operator[] (const direction) const
 
Cmpt & operator[] (const direction)
 
void operator+= (const VectorSpace< Form, Cmpt, Ncmpts > &)
 
void operator-= (const VectorSpace< Form, Cmpt, Ncmpts > &)
 
void operator= (const Foam::zero)
 
template<class Type , class Enable = EnableRank0<Type>>
void operator*= (const Type)
 
template<class Type , class Enable = EnableRank0<Type>>
void operator/= (const Type)
 
template<class SubVector , direction BStart>
const VectorSpace< Form, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart > block () const
 

Additional Inherited Members

- Public Types inherited from Vector< scalarAndError >
enum  components
 Component labeling enumeration. More...
 
typedef Vector< labellabelType
 Equivalent type of labels used for valid component indexing. More...
 
- Public Types inherited from VectorSpace< Form, Cmpt, Ncmpts >
typedef VectorSpace< Form, Cmpt, Ncmpts > vsType
 VectorSpace type. More...
 
typedef Cmpt cmptType
 Component type. More...
 
- Static Public Member Functions inherited from VectorSpace< Form, Cmpt, Ncmpts >
static direction size ()
 Return the number of elements in the VectorSpace = Ncmpts. More...
 
static Form uniform (const Cmpt &s)
 Return a VectorSpace with all elements = s. More...
 
- Public Attributes inherited from VectorSpace< Form, Cmpt, Ncmpts >
Cmpt v_ [Ncmpts]
 The components of this vector space. More...
 
- Static Public Attributes inherited from Vector< scalarAndError >
static const direction rank
 Rank of Vector is 1. More...
 
- Static Public Attributes inherited from VectorSpace< Form, Cmpt, Ncmpts >
static const direction dim = 3
 Dimensionality of space. More...
 
static const direction nComponents = Ncmpts
 Number of components in this vector space. More...
 
static const direction mRows = Ncmpts
 
static const direction nCols = 1
 
static const char *const typeName = "vectorVector"
 
static const char *const componentNames [] = {"x", "y", "z"}
 
static const Form zero
 
static const Form one
 
static const Form max
 
static const Form min
 
static const Form rootMax
 
static const Form rootMin
 
static const Form nan
 

Detailed Description

Vector of scalarAndError-s.

Definition at line 46 of file vectorAndError.H.

Member Function Documentation

◆ value()

Vector<scalar> value ( ) const
inline

Return the value.

Definition at line 61 of file vectorAndError.H.

References Vector< scalarAndError >::x(), Vector< scalarAndError >::y(), and Vector< scalarAndError >::z().

Referenced by face::areaAndCentreStabilised().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ error()

Vector<scalar> error ( ) const
inline

Return the error.

Definition at line 67 of file vectorAndError.H.

References Vector< scalarAndError >::x(), Vector< scalarAndError >::y(), and Vector< scalarAndError >::z().

Here is the call graph for this function:

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