[docs]
class ForwardModelError(Exception):
"""Exception class for the forward model."""
pass
[docs]
class TemplateCallError(ForwardModelError):
"""Template ForwardModel method called !"""
pass
[docs]
class ForwardModel:
"""A template class for the stochastic forward model.
Implement the core methods required of the forward
model within the TAMS context. Exception are thrown
if those functions are not overritten in actual model.
"""
def __init__(self, params: dict = None, ioprefix: str = None):
"""Might need something here."""
pass
[docs]
def advance(self, dt: float, forcingAmpl: float) -> float:
"""Advance function of the model.
Args:
dt: the time step size over which to advance
forcingAmpl: stochastic multiplicator
Return:
Some model will not do exactly dt (e.g. sub-stepping) return the actual dt
"""
raise TemplateCallError("Calling advance() method !")
[docs]
def getCurState(self):
"""Return the current state of the model."""
raise TemplateCallError("Calling getCurState() method !")
[docs]
def setCurState(self, state):
"""Set the current state of the model."""
raise TemplateCallError("Calling setCurState method !")
[docs]
def score(self):
"""Return the model's current state score."""
raise TemplateCallError("Calling score method !")
[docs]
def clear(self):
"""Destroy internal data."""
pass
@classmethod
[docs]
def name(self):
"""Return a the model name."""
return "TemplateForwardModel"