OpenFCST: The open-source Fuel Cell Simulation Toolbox
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim > Class Template Reference

This class is a means to make variable initial or boundary data. More...

#include <initial_and_boundary_data.h>

Inheritance diagram for FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >:
Inheritance graph
[legend]
Collaboration diagram for FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >:
Collaboration graph
[legend]

Protected Member Functions

Constructors, destructor, and initialization
 InitialOrBoundaryDataBase (boost::shared_ptr< ApplicationData > data, const unsigned int n_components=1)
 Constructor. More...
 
 ~InitialOrBoundaryDataBase ()
 Destructor. More...
 
Minor functions
void print_caller_name (const std::string &caller_name) const
 This function is used to print out the name of another function that has been declared in the scope of this class, but not yet been implemented. More...
 

Protected Attributes

GENERIC DATA
boost::shared_ptr
< ApplicationData
data
 Data of the application serves to exchange the information between YourApplication<dim> and children of this class. More...
 

Service functions

virtual double value (const Point< dim > &point, const unsigned int no_component=0) const
 This function calls the math_expression() function of this class and has NOT to be overriden in the derived classes. More...
 
virtual double math_expression (const Point< dim > &point, const unsigned int no_component=0) const
 This function implements the main functionality of this class and has to be overriden in the derived classes. More...
 

Detailed Description

template<int dim>
class FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >

This class is a means to make variable initial or boundary data.

Author
Valentin N. Zingan, 2013

Constructor & Destructor Documentation

template<int dim>
FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >::InitialOrBoundaryDataBase ( boost::shared_ptr< ApplicationData data,
const unsigned int  n_components = 1 
)
protected

Constructor.

Parameters
data- data of the application,
n_components- the total number of the solution components.

Destructor.

Member Function Documentation

template<int dim>
virtual double FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >::math_expression ( const Point< dim > &  point,
const unsigned int  no_component = 0 
) const
protectedvirtual

This function implements the main functionality of this class and has to be overriden in the derived classes.

Reimplemented in FuelCell::InitialAndBoundaryData::ExactSolutionAppIncompressibleFlows< dim >, and FuelCell::InitialAndBoundaryData::InitialDataAppIncompressibleFlows< dim >.

template<int dim>
void FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >::print_caller_name ( const std::string &  caller_name) const
protected

This function is used to print out the name of another function that has been declared in the scope of this class, but not yet been implemented.

template<int dim>
virtual double FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >::value ( const Point< dim > &  point,
const unsigned int  no_component = 0 
) const
virtual

This function calls the math_expression() function of this class and has NOT to be overriden in the derived classes.

Member Data Documentation

template<int dim>
boost::shared_ptr<ApplicationData> FuelCell::InitialAndBoundaryData::InitialOrBoundaryDataBase< dim >::data
protected

Data of the application serves to exchange the information between YourApplication<dim> and children of this class.


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