cideMOD.models.base.base_models

Classes

BaseCellModel(options)

Abstract base class for testing models

class cideMOD.models.base.base_models.BaseCellModel(options)[source]

Bases: BaseCellModelInputs, BaseCellModelOutputs, BaseCellModelPreprocessing, BaseCellModelEquations, ABC

Abstract base class for testing models

Parameters:
  • name (str) – Name of the model. Defaults to ‘Unnamed model’

  • mtype (str) – Type of model. Should be one of ‘PXD’, ‘SPM’, ‘P2D-2D’, ‘PM’. Defaults to ‘Unknown type’

  • time_scheme (str) – Type of time scheme. It must be either ‘implicit’ or ‘explicit’

  • root (bool) – Whether or not is a root model

  • hierarchy (int) – Hierarchy level. The lower the hierarchy the greater its priority. Notice that root model > implicit models > explicit models is always true regardless of its hierarchy level

  • note:: (..) – Notice that some model methods may be overrided by other models with higher hierarchy level

class property hierarchy

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.__int__(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by ‘+’ or ‘-’ and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal. >>> int(‘0b100’, base=0) 4

class property mtype

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

class property name

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

class property root

bool(x) -> bool

Returns True when the argument x is true, False otherwise. The builtins True and False are the only two instances of the class bool. The class bool is a subclass of the class int, and cannot be subclassed.

class property time_scheme

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

Modules

cideMOD.models.base.base_models.equations

cideMOD.models.base.base_models.inputs

cideMOD.models.base.base_models.outputs

cideMOD.models.base.base_models.preprocessing