cmf Namespace Reference

The main namespace of the model framework. Contains the other namespaces and the project class. More...

Detailed Description

The main namespace of the model framework. Contains the other namespaces and the project class.

Namespaces
namespace	atmosphere
	Contains classes to describe interactions with the atmosphere.
namespace	convert_1_to_2
namespace	describe
namespace	fit_retention_curve
namespace	geometry
	Contains geometric features like point (=location) and raster datasets.
namespace	math
	Contains classes for numerical solving of ODE's.
namespace	river
	Contains storages and connection for the simulation of surface water bodies, like rivers, channels, lakes and dams.
namespace	upslope
	Contains the classes to describe the discretization of the soil continuum.
namespace	water
	Contains generic classes for solute and water transport.

Classes
struct	_Options
	Holds global options for specific cmf behaviour, accessbile via cmf.options. More...
class	project
	The study area, holding all cells, outlets and streams. More...

Functions
	connect_cells_with_flux (cells, connection, start_at_layer=0)

Variables
_Options	options
	The global options storage.

Function Documentation

connect_cells_with_flux()

connect_cells_with_flux	(		cells,
			connection,
			start_at_layer = 0 )

Connects all cells in cells (sequence or generator) with a flux connection
connection is an subclass of cmf.FluxConnection which exposes the cell_connector callable
                (e.g. lateral subsurface fluxes and surface manning flux)
start_at_layer : if the flux connection should only be used for deeper layers