wmsolverbase.h

Go to the documentation of this file.

#ifndef wmsolverbase_h
#define wmsolverbase_h
 
// Wx includes
#include "lib/wxany.h"
#include "lib/wxobject.h"
#include "solver/wxstepper.h"
 
// Wm includes
#include "warpxm/warpxm_config.h"
 
// STL includes
#include <string>
 
// forward declarations
namespace wxm
{
namespace variable
{
class variable_t;
}
} // namespace wxm
class WmSimulation;
class WmDomain;
class WmSubSolver;
 
class WmSolverBase : public WxStepper, public WxObject
{
public:
    struct solverParameters_t
    {
        solverParameters_t()
            : _tstart(0.), _tend(0.), _numFrames(0), _startFrame(0), _isRestart(false)
        {
        }
 
        real getFrameDt() const
        {
            return (_tend - _tstart) / real(_numFrames);
        }
 
        real _tstart;
        real _tend;
        unsigned int _numFrames;
        unsigned int _startFrame;
        bool _isRestart;
        bool flexible_writeout;
    };
 
    WmSolverBase(const WmSimulation*
            parentSim /*, updateCallbackFunc_t setDt_callback = NULL, updateCallbackFunc_t setCurrentTime_callback = NULL */);
 
    virtual ~WmSolverBase();
 
    virtual void setup(const WxCryptSet& wxc);
 
    std::string runName() const;
 
    std::string getSolverName() const;
 
    virtual void solve() = 0;
 
    virtual const WmDomain& getDomain() const = 0;
 
    virtual WmSubSolver* getSubSolver(const std::string& name) const = 0;
 
    virtual const wxm::variable::variable_t&
    getConstVar(const std::string& name) const = 0;
 
    virtual wxm::variable::variable_t& getVar(const std::string& name) const = 0;
 
    virtual const std::type_info& getVarType(const std::string& name) const = 0;
 
    virtual const solverParameters_t& getSolverParameters() const = 0;
 
    static std::string getSrcDirectory()
    {
        return WARPXM_SRC_DIRECTORY;
    }
 
protected:
    const WmSimulation* _parentSim;
};
 
#endif // wmsolverbase_h