xso.backendcomps.Backend

class xso.backendcomps.Backend(*, solver_type)[source]

Xarray-simlab process initializing and storing model backend and solver.

This is the interface between the solver and model backend of XSO and the model processes, that are decorated as XSO components. As for all Xarray-simlab processes, we can define an initialize and finalize method to execute at different stages of model runtime.

solver_type

a string argument passed at model setup, that defines which solver is used

Type:: xarray-simlab variable

core

stores the XSOCore class initialized with passed solver_type

Type:: xarray-simlab any_object

m

store for math function wrappers supplied with Solver contained in XSOCore

Type:: xarray-simlab any_object

initialize()[source]: Creates model backend objects at the start of model runtime.

finalize()[source]: Calls the cleanup function implemented in XSOCore, relevant to some solvers.

solver_type

Solver type to use for model

Variable properties:

type : variable
intent : in
dimensions : ()

Type:: attr.Attribute

core

Model backend instance is stored here

Variable properties:

type : object
intent : out

Type:: attr.Attribute

m

Math wrapper functions provided by solver

Variable properties:

type : object
intent : out

Type:: attr.Attribute

__init__(*, solver_type) → None: Method generated by attrs for class Backend.

Methods

`__init__`(*, solver_type)	Method generated by attrs for class Backend.
`finalize`()	Runs finally after model solve to call cleanup function in core
`initialize`()	Initializes model backend at the start of model runtime.