Barycentric< Cmpt > Class Template Reference

Templated 3D Barycentric derived from VectorSpace. Has 4 components, one of which is redundant. More...

Inheritance diagram for Barycentric< Cmpt >:
[legend]
Collaboration diagram for Barycentric< Cmpt >:
[legend]

Public Types

enum  components { A , B , C , D }
 Component labeling enumeration. More...
 
typedef Barycentric< label > labelType
 Equivalent type of labels used for valid component indexing. More...
 
- Public Types inherited from VectorSpace< Barycentric< Cmpt >, Cmpt, 4 >
typedef VectorSpace< Barycentric< Cmpt >, Cmpt, Ncmpts > vsType
 VectorSpace type. More...
 
typedef Cmpt cmptType
 Component type. More...
 
typedef Cmpt magType
 Magnitude type. More...
 
typedef Cmpt * iterator
 Random access iterator for traversing VectorSpace. More...
 
typedef const Cmpt * const_iterator
 Random access iterator for traversing VectorSpace. More...
 

Public Member Functions

 Barycentric ()=default
 Default construct. More...
 
 Barycentric (const Foam::zero)
 Construct initialized to zero. More...
 
 Barycentric (const Cmpt &va, const Cmpt &vb, const Cmpt &vc, const Cmpt &vd)
 Construct from components. More...
 
const Cmpt & a () const
 
const Cmpt & b () const
 
const Cmpt & c () const
 
const Cmpt & d () const
 
Cmpt & a ()
 
Cmpt & b ()
 
Cmpt & c ()
 
Cmpt & d ()
 
- Public Member Functions inherited from VectorSpace< Barycentric< Cmpt >, Cmpt, 4 >
 VectorSpace ()=default
 Default construct. More...
 
 VectorSpace (const Foam::zero)
 Construct initialized to zero. More...
 
 VectorSpace (const VectorSpace< Barycentric< Cmpt >, Cmpt, Ncmpts > &vs)
 Copy construct. More...
 
 VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
 Copy construct of a VectorSpace with the same size. More...
 
 VectorSpace (Istream &is)
 Construct from Istream. More...
 
const Cmpt & component (const direction) const
 
Cmpt & component (const direction)
 
void component (Cmpt &, const direction) const
 
void replace (const direction, const Cmpt &)
 
const Cmpt * cdata () const noexcept
 Return const pointer to the first data element. More...
 
Cmpt * data () noexcept
 Return pointer to the first data element. More...
 
const ConstBlock< SubVector, BStart > block () const
 
const Foam::VectorSpace< Barycentric< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart > block () const
 
const Cmpt & operator[] (const direction) const
 
Cmpt & operator[] (const direction)
 
void operator= (const VectorSpace< Barycentric< Cmpt >, Cmpt, Ncmpts > &)
 
void operator= (const Foam::zero)
 
void operator+= (const VectorSpace< Barycentric< Cmpt >, Cmpt, Ncmpts > &)
 
void operator-= (const VectorSpace< Barycentric< Cmpt >, Cmpt, Ncmpts > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 
iterator begin () noexcept
 Return an iterator to begin of VectorSpace. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin of VectorSpace. More...
 
iterator end () noexcept
 Return an iterator to end of VectorSpace. More...
 
const_iterator end () const noexcept
 Return const_iterator to end of VectorSpace. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin of VectorSpace. More...
 
const_iterator cend () const noexcept
 Return const_iterator to end of VectorSpace. More...
 

Static Public Attributes

static constexpr direction rank = 1
 Rank of Barycentric is 1. More...
 
- Static Public Attributes inherited from VectorSpace< Barycentric< Cmpt >, Cmpt, 4 >
static constexpr direction dim
 Dimensionality of space. More...
 
static constexpr direction nComponents
 Number of components in this vector space. More...
 
static constexpr direction mRows
 
static constexpr direction nCols
 
static const char *const typeName
 
static const char *const componentNames []
 
static const Barycentric< Cmpt > zero
 
static const Barycentric< Cmpt > one
 
static const Barycentric< Cmpt > max
 
static const Barycentric< Cmpt > min
 
static const Barycentric< Cmpt > rootMax
 
static const Barycentric< Cmpt > rootMin
 

Additional Inherited Members

- Static Public Member Functions inherited from VectorSpace< Barycentric< Cmpt >, Cmpt, 4 >
static constexpr direction size () noexcept
 The number of elements in the VectorSpace = Ncmpts. More...
 
static Barycentric< Cmpt > uniform (const Cmpt &s)
 Return a VectorSpace with all elements = s. More...
 
- Public Attributes inherited from VectorSpace< Barycentric< Cmpt >, Cmpt, 4 >
Cmpt v_ [Ncmpts]
 The components of this vector space. More...
 

Detailed Description

template<class Cmpt>
class Foam::Barycentric< Cmpt >

Templated 3D Barycentric derived from VectorSpace. Has 4 components, one of which is redundant.

Source files

Definition at line 54 of file Barycentric.H.

Member Typedef Documentation

◆ labelType

typedef Barycentric<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 63 of file Barycentric.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator

Definition at line 73 of file Barycentric.H.

Constructor & Destructor Documentation

◆ Barycentric() [1/3]

Barycentric ( )
default

Default construct.

◆ Barycentric() [2/3]

Barycentric ( const Foam::zero  )
inline

Construct initialized to zero.

Definition at line 31 of file BarycentricI.H.

◆ Barycentric() [3/3]

Barycentric ( const Cmpt &  va,
const Cmpt &  vb,
const Cmpt &  vc,
const Cmpt &  vd 
)
inline

Construct from components.

Definition at line 38 of file BarycentricI.H.

References A, B, and D.

Member Function Documentation

◆ a() [1/2]

const Cmpt & a
inline

Definition at line 56 of file BarycentricI.H.

References A.

Referenced by BarycentricTensor< Cmpt >::BarycentricTensor(), and Foam::operator&().

Here is the caller graph for this function:

◆ b() [1/2]

const Cmpt & b
inline

Definition at line 63 of file BarycentricI.H.

References B.

Referenced by BarycentricTensor< Cmpt >::BarycentricTensor(), and Foam::operator&().

Here is the caller graph for this function:

◆ c() [1/2]

const Cmpt & c
inline

Definition at line 70 of file BarycentricI.H.

Referenced by BarycentricTensor< Cmpt >::BarycentricTensor(), and Foam::operator&().

Here is the caller graph for this function:

◆ d() [1/2]

const Cmpt & d
inline

Definition at line 77 of file BarycentricI.H.

References D.

Referenced by BarycentricTensor< Cmpt >::BarycentricTensor(), and Foam::operator&().

Here is the caller graph for this function:

◆ a() [2/2]

Cmpt & a
inline

Definition at line 84 of file BarycentricI.H.

◆ b() [2/2]

Cmpt & b
inline

Definition at line 91 of file BarycentricI.H.

References B.

◆ c() [2/2]

Cmpt & c
inline

Definition at line 98 of file BarycentricI.H.

◆ d() [2/2]

Cmpt & d
inline

Definition at line 105 of file BarycentricI.H.

Member Data Documentation

◆ rank

constexpr direction rank = 1
staticconstexpr

Rank of Barycentric is 1.

Definition at line 69 of file Barycentric.H.


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