Public Member Functions | List of all members
Roots< N > Class Template Reference

Templated storage for the roots of polynomial equations, plus flags to indicate the nature of the roots. More...

Inheritance diagram for Roots< N >:
Inheritance graph
[legend]
Collaboration diagram for Roots< N >:
Collaboration graph
[legend]

Public Member Functions

 Roots ()
 
 Roots (const roots::type t, const scalar x)
 
 Roots (const roots::type t, const scalar x, const Roots< N - 1 > &xs)
 
 Roots (const Roots< N - 1 > &xs, const roots::type t, const scalar x)
 
template<direction M>
 Roots (const Roots< M > &xs, const Roots< N - M > &ys)
 
void type (const direction i, const roots::type t)
 
roots::type type (const direction i) const
 
- Public Member Functions inherited from VectorSpace< Roots< N >, scalar, N >
 VectorSpace ()=default
 
 VectorSpace (const Foam::zero)
 
 VectorSpace (const VectorSpace< Form, Cmpt, Ncmpts > &vs)
 
 VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
 
 VectorSpace (Istream &is)
 
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
 
Cmpt * data () noexcept
 
const ConstBlock< SubVector, BStart > block () const
 
const Foam::VectorSpace< Form, Cmpt, Ncmpts >::template 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 Foam::zero)
 
void operator+= (const VectorSpace< Form, Cmpt, Ncmpts > &)
 
void operator-= (const VectorSpace< Form, Cmpt, Ncmpts > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 
iterator begin () noexcept
 
const_iterator begin () const noexcept
 
iterator end () noexcept
 
const_iterator end () const noexcept
 
const_iterator cbegin () const noexcept
 
const_iterator cend () const noexcept
 

Additional Inherited Members

- Public Types inherited from VectorSpace< Roots< N >, scalar, N >
typedef VectorSpace< Form, Cmpt, Ncmpts > vsType
 
typedef Cmpt cmptType
 
typedef Cmpt magType
 
typedef Cmpt * iterator
 
- Static Public Member Functions inherited from VectorSpace< Roots< N >, scalar, N >
static constexpr direction size () noexcept
 
static Form uniform (const Cmpt &s)
 
- Public Attributes inherited from VectorSpace< Roots< N >, scalar, N >
const typedef Cmpt * const_iterator
 
Cmpt v_ [Ncmpts]
 
- Static Public Attributes inherited from VectorSpace< Roots< N >, scalar, N >
static constexpr direction dim
 
static constexpr direction nComponents
 
static constexpr direction mRows
 
static constexpr direction nCols
 
static const char *const typeName
 
static const char *const componentNames []
 
static const Form zero
 
static const Form one
 
static const Form max
 
static const Form min
 
static const Form rootMax
 
static const Form rootMin
 

Detailed Description

template<direction N>
class Foam::Roots< N >

Templated storage for the roots of polynomial equations, plus flags to indicate the nature of the roots.

Source files

Definition at line 68 of file Roots.H.

Constructor & Destructor Documentation

◆ Roots() [1/5]

Roots
inline

Definition at line 24 of file RootsI.H.

References forAll, Foam::roots::nan, and Roots< N >::type().

Here is the call graph for this function:

◆ Roots() [2/5]

Roots ( const roots::type  t,
const scalar  x 
)
inline

Definition at line 36 of file RootsI.H.

References forAll, Roots< N >::type(), VectorSpace< Roots< N >, scalar, N >::v_, and x.

Here is the call graph for this function:

◆ Roots() [3/5]

Roots ( const roots::type  t,
const scalar  x,
const Roots< N - 1 > &  xs 
)
inline

Definition at line 50 of file RootsI.H.

References forAll, Roots< N >::type(), Foam::type(), and x.

Here is the call graph for this function:

◆ Roots() [4/5]

Roots ( const Roots< N - 1 > &  xs,
const roots::type  t,
const scalar  x 
)
inline

Definition at line 70 of file RootsI.H.

References forAll, N(), Roots< N >::type(), Foam::type(), and x.

Here is the call graph for this function:

◆ Roots() [5/5]

Roots ( const Roots< M > &  xs,
const Roots< N - M > &  ys 
)
inline

Definition at line 91 of file RootsI.H.

References forAll, M, Roots< N >::type(), and Foam::type().

Here is the call graph for this function:

Member Function Documentation

◆ type() [1/2]

void type ( const direction  i,
const roots::type  t 
)
inline

Definition at line 115 of file RootsI.H.

References Foam::type().

Referenced by Foam::eigenValues(), Roots< N >::Roots(), and cubicEqn::roots().

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

◆ type() [2/2]

Foam::roots::type type ( const direction  i) const
inline

Definition at line 125 of file RootsI.H.


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