Public Member Functions | Public Attributes | List of all members
oomph::SolutionFunctor Class Reference

Function class for a simple function with no external parameters (just stores a function pointer, only needed for compatability). More...

#include <oomph_utilities.h>

+ Inheritance diagram for oomph::SolutionFunctor:

Public Member Functions

 SolutionFunctor ()
 
 SolutionFunctor (TimeSpaceToDoubleVectFctPt solution_fpt)
 
 SolutionFunctor (TimeSpaceToDoubleVectFctPt solution_fpt, TimeSpaceValueToDoubleVectFctPt derivative_fpt)
 
virtual ~SolutionFunctor ()
 
 SolutionFunctor (const SolutionFunctor &that)
 
void operator= (const SolutionFunctor &that)
 
virtual Vector< double > operator() (const double &t, const Vector< double > &x) const
 Call the function. More...
 
virtual Vector< double > derivative (const double &t, const Vector< double > &x, const Vector< double > &u) const
 Call the derivative function. More...
 
- Public Member Functions inherited from oomph::SolutionFunctorBase
virtual ~SolutionFunctorBase ()
 Virtual destructor. More...
 
virtual void jacobian (const double &t, const Vector< double > &x, const Vector< double > &u, DenseMatrix< double > &jacobian) const
 The derivatives of the derivative function with respect to u (note that this is not quite the jacobian of the residuals for an ODE problem defined by this solution: you also need the time derivative part there). Broken virtual function because not often needed. More...
 
virtual bool have_jacobian () const
 Is a jacobian function implemented? More...
 
virtual void initialise_from_problem (const Problem *problem_pt)
 Overload to grab data from the problem. More...
 

Public Attributes

TimeSpaceToDoubleVectFctPt Solution_fpt
 Storage for solution. More...
 
TimeSpaceValueToDoubleVectFctPt Derivative_fpt
 Storage for derivative. More...
 

Additional Inherited Members

- Public Types inherited from oomph::SolutionFunctorBase
typedef double(* TimeSpaceToDoubleFctPt) (const double &t, const Vector< double > &x)
 General function of space and time which returns a double. More...
 
typedef Vector< double >(* TimeSpaceToDoubleVectFctPt) (const double &t, const Vector< double > &x)
 General function of space and time which returns a vector of doubles. More...
 
typedef Vector< double >(* TimeSpaceValueToDoubleVectFctPt) (const double &t, const Vector< double > &x, const Vector< double > &u)
 General function of time, space and a value vector which returns a vector of doubles. More...
 

Detailed Description

Function class for a simple function with no external parameters (just stores a function pointer, only needed for compatability).

Definition at line 1165 of file oomph_utilities.h.

Constructor & Destructor Documentation

◆ SolutionFunctor() [1/4]

oomph::SolutionFunctor::SolutionFunctor ( )
inline

Definition at line 1175 of file oomph_utilities.h.

References Derivative_fpt, and Solution_fpt.

◆ SolutionFunctor() [2/4]

oomph::SolutionFunctor::SolutionFunctor ( TimeSpaceToDoubleVectFctPt  solution_fpt)
inline

Definition at line 1181 of file oomph_utilities.h.

References Derivative_fpt, and Solution_fpt.

◆ SolutionFunctor() [3/4]

oomph::SolutionFunctor::SolutionFunctor ( TimeSpaceToDoubleVectFctPt  solution_fpt,
TimeSpaceValueToDoubleVectFctPt  derivative_fpt 
)
inline

Definition at line 1187 of file oomph_utilities.h.

References Derivative_fpt, and Solution_fpt.

◆ ~SolutionFunctor()

virtual oomph::SolutionFunctor::~SolutionFunctor ( )
inlinevirtual

Definition at line 1194 of file oomph_utilities.h.

◆ SolutionFunctor() [4/4]

oomph::SolutionFunctor::SolutionFunctor ( const SolutionFunctor that)
inline

Definition at line 1196 of file oomph_utilities.h.

References Derivative_fpt, and Solution_fpt.

Member Function Documentation

◆ derivative()

virtual Vector< double > oomph::SolutionFunctor::derivative ( const double &  t,
const Vector< double > &  x,
const Vector< double > &  u 
) const
inlinevirtual

Call the derivative function.

Implements oomph::SolutionFunctorBase.

Definition at line 1224 of file oomph_utilities.h.

References Derivative_fpt, oomph::Global_string_for_annotation::string(), and t.

◆ operator()()

virtual Vector< double > oomph::SolutionFunctor::operator() ( const double &  t,
const Vector< double > &  x 
) const
inlinevirtual

Call the function.

Implements oomph::SolutionFunctorBase.

Definition at line 1209 of file oomph_utilities.h.

References Solution_fpt, oomph::Global_string_for_annotation::string(), and t.

◆ operator=()

void oomph::SolutionFunctor::operator= ( const SolutionFunctor that)
inline

Definition at line 1202 of file oomph_utilities.h.

References Derivative_fpt, and Solution_fpt.

Member Data Documentation

◆ Derivative_fpt

TimeSpaceValueToDoubleVectFctPt oomph::SolutionFunctor::Derivative_fpt

Storage for derivative.

Definition at line 1243 of file oomph_utilities.h.

Referenced by derivative(), operator=(), and SolutionFunctor().

◆ Solution_fpt

TimeSpaceToDoubleVectFctPt oomph::SolutionFunctor::Solution_fpt

Storage for solution.

Definition at line 1240 of file oomph_utilities.h.

Referenced by operator()(), operator=(), and SolutionFunctor().


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