oomph::SolutionFunctor Class Reference

#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
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)

Detailed Description

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

Constructor & Destructor Documentation

SolutionFunctor() [1/4]

oomph::SolutionFunctor::SolutionFunctor ( )

inline

    {
      Solution_fpt = 0;
      Derivative_fpt = 0;
    }

SolutionFunctor() [2/4]

oomph::SolutionFunctor::SolutionFunctor ( TimeSpaceToDoubleVectFctPt  solution_fpt )

inline

    {
      Solution_fpt = solution_fpt;
      Derivative_fpt = 0;
    }

SolutionFunctor() [3/4]

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

inline

    {
      Solution_fpt = solution_fpt;
      Derivative_fpt = derivative_fpt;
    }

~SolutionFunctor()

virtual oomph::SolutionFunctor::~SolutionFunctor ( )

inlinevirtual

{}

SolutionFunctor() [4/4]

oomph::SolutionFunctor::SolutionFunctor ( const SolutionFunctor &  that )

inline

    {
      Solution_fpt = that.Solution_fpt;
      Derivative_fpt = that.Derivative_fpt;
    }

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.

    {
#ifdef PARANOID
      if (Derivative_fpt == 0)
      {
        std::string err = "Derivative_fpt is null!";
        throw OomphLibError(
          err, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      return Derivative_fpt(t, x, u);
    }

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::Global_string_for_annotation::string(), plotPSD::t, and plotDoE::x.

operator()()

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

inlinevirtual

Call the function.

Implements oomph::SolutionFunctorBase.

    {
#ifdef PARANOID
      if (Solution_fpt == 0)
      {
        std::string err = "Solution_fpt is null!";
        throw OomphLibError(
          err, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
      }
#endif
      return Solution_fpt(t, x);
    }

References OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::Global_string_for_annotation::string(), plotPSD::t, and plotDoE::x.

operator=()

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

inline

    {
      this->Solution_fpt = that.Solution_fpt;
      this->Derivative_fpt = that.Derivative_fpt;
    }

References Derivative_fpt, and Solution_fpt.

Member Data Documentation

Derivative_fpt

TimeSpaceValueToDoubleVectFctPt oomph::SolutionFunctor::Derivative_fpt

Storage for derivative.

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

Solution_fpt

TimeSpaceToDoubleVectFctPt oomph::SolutionFunctor::Solution_fpt

Storage for solution.

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

---

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

• oomph_utilities.h