Logo  0.95.0-final
Finite Element Embedded Library and Language in C++
Feel++ Feel++ on Github Feel++ community
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Feel::Simget Class Referenceabstract

#include <simget.hpp>

Detailed Description

Simulation Object.

A Simget is an object that provides two flavors of run() member function

  • run() without any argument which simulates a blackbox $ F $ whitout any outputs or inputs
  • run( double* X, int P, double* Y, int N ) which simulates a blackbox with input/output relationship $ Y = F(X) $ with $ Y \in \mathbb{R}^N$ and $ X \in \mathbb{R}^P$.
Author
Christophe Prud'homme
See Also
+ Inheritance diagram for Feel::Simget:

Public Member Functions

Constructors, destructor
 Simget ()
 
virtual ~Simget ()
 destructor
 
Operator overloads
Simgetoperator= (Simget const &o)
 copy operator
 
Accessors
virtual std::string name () const
 return the name of the simget
 
mpi::communicator comm () const
 
po::variables_map const & vm () const
 
AboutData const & about () const
 
double meshSize () const
 return the mesh size
 
double meshSizeInit () const
 return the mesh size
 
int level () const
 return the refinement level
 
ptree::ptree const & stats () const
 return the statistics associated to the simget after calling run
 
ptree::ptree & stats ()
 return the statistics associated to the simget after calling run
 
Mutators
void setMeshSize (double h)
 set the mesh size
 
void setMeshSizeInit (double h)
 set the initial mesh size
 
void setLevel (int level)
 set the refinment level if applicable
 
Methods
virtual void run ()=0
 
virtual void run (const double *X, unsigned long P, double *Y, unsigned long N)
 
void print (std::ostream &out, std::vector< ptree::ptree > &stats)
 

Protected Member Functions

SimgetchangeRepository (boost::format fmt)
 

Protected Attributes

int M_level
 
double M_meshSize
 
double M_meshSizeInit
 
ptree::ptree M_stats
 

Friends

class Application
 

Constructor & Destructor Documentation

Feel::Simget::Simget ( )

constructor with a variables_map

Member Function Documentation

AboutData const& Feel::Simget::about ( ) const
inline
Returns
the AboutData object
Simget & Feel::Simget::changeRepository ( boost::format  fmt)
protected

change repository.

mpi::communicator Feel::Simget::comm ( ) const
inline
Returns
the mpi communicator
void Feel::Simget::print ( std::ostream &  out,
std::vector< ptree::ptree > &  stats 
)

print statistics from simget

References Feel::AboutData::appName().

virtual void Feel::Simget::run ( const double *  X,
unsigned long  P,
double *  Y,
unsigned long  N 
)
inlinevirtual

models the input/output relation $ Y=F(X) $

Reimplemented in Diode, Laplacian< Dim >, ResidualEstimator< Dim, Order >, and LShape< Dim >.

References run().

po::variables_map const& Feel::Simget::vm ( ) const
inline
Returns
the variables_map

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

Generated on Sun Oct 20 2013 08:25:09 for Feel++ by doxygen 1.8.4