PanNDE
All Classes Namespaces Functions Pages
Public Member Functions | List of all members
PanNDE::Model Class Referenceabstract

#include "modules/PanNDE/include/Model.hpp"

Inheritance diagram for PanNDE::Model:
HostSolver::HostRSGTDUT

Public Member Functions

virtual double solve (int nsteps=1)=0
 
virtual std::shared_ptr< PanNDE::FieldBundlegetStates ()=0
 

Detailed Description

defines expected interactions for model/solver implementations. Currently, the class contains a minimal set of methods, as are minimally necessary for the execution of a model. As future model implementations are derived from this interface, new methods likely will be added for improved general functionality of this interface (adherence to: Open-Closed Principle).

Member Function Documentation

◆ getStates()

virtual std::shared_ptr<PanNDE::FieldBundle> PanNDE::Model::getStates ( )
pure virtual

get current solution variables for the simulation

Implemented in HostSolver::HostRSGTDUT.

◆ solve()

virtual double PanNDE::Model::solve ( int  nsteps = 1)
pure virtual

execute a model step. The return value should be a meaningful indicator of model progress, e.g.:

  • residual for implicit schemes
  • timing information for adaptive schemes
    Parameters
    nstepsnumber of model steps to take

Implemented in HostSolver::HostRSGTDUT.


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