solver_nb
=========

.. py:module:: solver_nb

.. autoapi-nested-parse::

   This module contains functions used to solve the various heat/surface energy balance equations,
   using the NumbaMinpack implementation.
   This is rather unwieldy, but allows us to select a solver conditionally, and do so both in the main model code
   using the relevant flag in ``model_setup.py``, but also in our test suite.
   This is in part a tradeoff between usability of the model, and code clarity. This approach was chosen to maximise
   usability, so that the different solvers can be generated according to the value of a single Boolean.



Attributes
----------

.. autoapisummary::

   solver_nb.dev_eqn_cfunc
   solver_nb.dev_eqnaddress
   solver_nb.form_eqn_cfunc
   solver_nb.form_eqnaddress
   solver_nb.heq
   solver_nb.heqlid
   solver_nb.sfc_energy_lid
   solver_nb.sfc_energy_lid_address
   solver_nb.sfc_energy_virtual_lid
   solver_nb.sfc_energy_vlid_address


Functions
---------

.. toctree::
   :hidden:

   /autoapi/solver_nb/args_array
   /autoapi/solver_nb/firn_heateqn_solver
   /autoapi/solver_nb/lake_development_eqn
   /autoapi/solver_nb/lake_formation_eqn
   /autoapi/solver_nb/lake_solver
   /autoapi/solver_nb/lid_heateqn_solver
   /autoapi/solver_nb/lid_seb_solver
   /autoapi/solver_nb/sfc_energy_lid
   /autoapi/solver_nb/sfc_energy_virtual_lid

.. autoapisummary::

   solver_nb.args_array
   solver_nb.firn_heateqn_solver
   solver_nb.lake_development_eqn
   solver_nb.lake_formation_eqn
   solver_nb.lake_solver
   solver_nb.lid_heateqn_solver
   solver_nb.lid_seb_solver
   solver_nb.sfc_energy_lid
   solver_nb.sfc_energy_virtual_lid


Module Contents
---------------

.. py:data:: dev_eqn_cfunc

.. py:data:: dev_eqnaddress

.. py:data:: form_eqn_cfunc

.. py:data:: form_eqnaddress

.. py:data:: heq

.. py:data:: heqlid

.. py:data:: sfc_energy_lid

.. py:data:: sfc_energy_lid_address

.. py:data:: sfc_energy_virtual_lid

.. py:data:: sfc_energy_vlid_address