Class documentation of Concepts

Loading...
Searching...
No Matches
concepts::VectorFormula< F, dim > Class Template Referenceabstract

#include <vectorFormula.hh>

Inheritance diagram for concepts::VectorFormula< F, dim >:
concepts::Formula< Point< F, dim > > concepts::PiecewiseFormulaBase< F > concepts::ElementFormula< F, concepts::Realtype< F >::type > concepts::Cloneable concepts::OutputOperator

Public Types

typedef Point< F, dim > value_type
 
typedef RCP< const concepts::Formula< F > > EntryFormulaRCP
 
typedef Realtype< Point< F, dim > >::type G
 

Public Member Functions

 VectorFormula (const std::vector< EntryFormulaRCP > &formulas)
 
Point< F, dim > operator() (const Real p, const Real t=0.0) const
 
Point< F, dim > operator() (const Real2d &p, const Real t=0.0) const
 
Point< F, dim > operator() (const Real3d &p, const Real t=0.0) const
 
virtual VectorFormula< F, dim > * clone () const
 Virtual copy constructor.
 
const std::vector< EntryFormulaRCP > & getFormulas ()
 
EntryFormulaRCPoperator[] (int i)
 
virtualoperator() (const ElementWithCell< G > &elm, const Real p, const Real t=0.0) const
 
virtualoperator() (const ElementWithCell< G > &elm, const Real2d &p, const Real t=0.0) const
 
virtualoperator() (const ElementWithCell< G > &elm, const Real3d &p, const Real t=0.0) const
 
virtualoperator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real p, const Real t=0.0) const=0
 
virtualoperator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real2d &p, const Real t=0.0) const=0
 
virtualoperator() (const ElementWithCell< concepts::Realtype< F >::type > &elm, const Real3d &p, const Real t=0.0) const=0
 
virtual const F & dflt_value () const
 Gives default value.
 
virtual F & dflt_value ()
 Gives default value.
 
virtual Point< F, dim > operator() (const Connector &cntr, const Real p, const Real t=0.0) const
 
virtual Point< F, dim > operator() (const Connector &cntr, const Real2d &p, const Real t=0.0) const
 
virtual Point< F, dim > operator() (const Connector &cntr, const Real3d &p, const Real t=0.0) const
 

Protected Member Functions

virtual std::ostream & info (std::ostream &os) const
 Returns information in an output stream.
 

Protected Attributes

std::vector< EntryFormulaRCPformulas_
 

Detailed Description

template<typename F, int dim>
class concepts::VectorFormula< F, dim >

Element formula returning a vector.

Author
Kersten Schmidt, 2010

Definition at line 25 of file vectorFormula.hh.

Member Typedef Documentation

◆ EntryFormulaRCP

template<typename F , int dim>
typedef RCP<const concepts::Formula<F> > concepts::VectorFormula< F, dim >::EntryFormulaRCP

Definition at line 29 of file vectorFormula.hh.

◆ G

typedef Realtype<Point< F, dim > >::type concepts::Formula< Point< F, dim > >::G
inherited

Definition at line 37 of file formula.hh.

◆ value_type

template<typename F , int dim>
typedef Point<F, dim> concepts::VectorFormula< F, dim >::value_type

Definition at line 28 of file vectorFormula.hh.

Constructor & Destructor Documentation

◆ VectorFormula() [1/2]

template<typename F , int dim>
concepts::VectorFormula< F, dim >::VectorFormula ( )
inline

Definition at line 29 of file vectorFormula.hh.

◆ VectorFormula() [2/2]

template<typename F , int dim>
concepts::VectorFormula< F, dim >::VectorFormula ( const std::vector< EntryFormulaRCP > &  formulas)
inline

Combines a vector of dim Formulas to a VectorFormula.

Each Formula is given as a refence counting pointer (see RCP).

Definition at line 29 of file vectorFormula.hh.

◆ ~VectorFormula()

template<typename F , int dim>
virtual concepts::VectorFormula< F, dim >::~VectorFormula ( )
inlinevirtual

Definition at line 90 of file vectorFormula.hh.

Member Function Documentation

◆ clone()

template<typename F , int dim>
virtual VectorFormula< F, dim > * concepts::VectorFormula< F, dim >::clone ( ) const
inlinevirtual

Virtual copy constructor.

Implements concepts::Formula< Point< F, dim > >.

Definition at line 79 of file vectorFormula.hh.

◆ dflt_value() [1/2]

template<typename F >
virtual F & concepts::PiecewiseFormulaBase< F >::dflt_value ( )
inlinevirtualinherited

Gives default value.

Definition at line 83 of file piecewiseFormula.hh.

◆ dflt_value() [2/2]

template<typename F >
virtual const F & concepts::PiecewiseFormulaBase< F >::dflt_value ( ) const
inlinevirtualinherited

Gives default value.

Definition at line 81 of file piecewiseFormula.hh.

◆ getFormulas()

template<typename F , int dim>
const std::vector< EntryFormulaRCP > & concepts::VectorFormula< F, dim >::getFormulas ( )
inline

Definition at line 92 of file vectorFormula.hh.

◆ info()

template<typename F , int dim>
virtual std::ostream & concepts::VectorFormula< F, dim >::info ( std::ostream &  os) const
inlineprotectedvirtual

Returns information in an output stream.

Reimplemented from concepts::PiecewiseFormulaBase< F >.

Definition at line 107 of file vectorFormula.hh.

◆ operator()() [1/12]

virtual Point< F, dim > concepts::Formula< Point< F, dim > >::operator() ( const Connector cntr,
const Real  p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Convenience implementation, that by default ignores its elm param.

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 53 of file formula.hh.

◆ operator()() [2/12]

virtual Point< F, dim > concepts::Formula< Point< F, dim > >::operator() ( const Connector cntr,
const Real2d p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 56 of file formula.hh.

◆ operator()() [3/12]

virtual Point< F, dim > concepts::Formula< Point< F, dim > >::operator() ( const Connector cntr,
const Real3d p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Implements concepts::PiecewiseFormulaBase< F >.

Definition at line 59 of file formula.hh.

◆ operator()() [4/12]

virtual F concepts::ElementFormula< F, concepts::Realtype< F >::type >::operator() ( const ElementWithCell< concepts::Realtype< F >::type > &  elm,
const Real  p,
const Real  t = 0.0 
) const
pure virtualinherited

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

◆ operator()() [5/12]

virtual F concepts::ElementFormula< F, concepts::Realtype< F >::type >::operator() ( const ElementWithCell< concepts::Realtype< F >::type > &  elm,
const Real2d p,
const Real  t = 0.0 
) const
pure virtualinherited

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

◆ operator()() [6/12]

virtual F concepts::ElementFormula< F, concepts::Realtype< F >::type >::operator() ( const ElementWithCell< concepts::Realtype< F >::type > &  elm,
const Real3d p,
const Real  t = 0.0 
) const
pure virtualinherited

Evaluates the formula.

Parameters
elmElement
pPoint in space in local element coordinates
tPoint in time

◆ operator()() [7/12]

template<typename F >
virtual F concepts::PiecewiseFormulaBase< F >::operator() ( const ElementWithCell< G > &  elm,
const Real  p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Definition at line 52 of file piecewiseFormula.hh.

◆ operator()() [8/12]

template<typename F >
virtual F concepts::PiecewiseFormulaBase< F >::operator() ( const ElementWithCell< G > &  elm,
const Real2d p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Definition at line 57 of file piecewiseFormula.hh.

◆ operator()() [9/12]

template<typename F >
virtual F concepts::PiecewiseFormulaBase< F >::operator() ( const ElementWithCell< G > &  elm,
const Real3d p,
const Real  t = 0.0 
) const
inlinevirtualinherited

Definition at line 63 of file piecewiseFormula.hh.

◆ operator()() [10/12]

template<typename F , int dim>
Point< F, dim > concepts::VectorFormula< F, dim >::operator() ( const Real  p,
const Real  t = 0.0 
) const
inlinevirtual

Evaluates the formula.

Parameters
pPoint in space in physical coordinates
tPoint in time

Implements concepts::Formula< Point< F, dim > >.

Definition at line 51 of file vectorFormula.hh.

◆ operator()() [11/12]

template<typename F , int dim>
Point< F, dim > concepts::VectorFormula< F, dim >::operator() ( const Real2d p,
const Real  t = 0.0 
) const
inlinevirtual

Implements concepts::Formula< Point< F, dim > >.

Definition at line 60 of file vectorFormula.hh.

◆ operator()() [12/12]

template<typename F , int dim>
Point< F, dim > concepts::VectorFormula< F, dim >::operator() ( const Real3d p,
const Real  t = 0.0 
) const
inlinevirtual

Implements concepts::Formula< Point< F, dim > >.

Definition at line 69 of file vectorFormula.hh.

◆ operator[]()

template<typename F , int dim>
EntryFormulaRCP & concepts::VectorFormula< F, dim >::operator[] ( int  i)
inline

Definition at line 97 of file vectorFormula.hh.

Member Data Documentation

◆ formulas_

template<typename F , int dim>
std::vector< EntryFormulaRCP > concepts::VectorFormula< F, dim >::formulas_
protected

Definition at line 105 of file vectorFormula.hh.


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