 |
2.0.0b10
catchment modelling framework
|
|
2.0.0b10
catchment modelling framework
|
| ▼Ncmf | The main namespace of the model framework. Contains the other namespaces and the project class |
| ►Natmosphere | Contains classes to describe interactions with the atmosphere |
| Caerodynamic_resistance | Abstract class. Child classes can be used to calculate aerodynamic resistances against turbulent heat fluxes |
| CConstantMeteorology | A primitive implementation of the Meteorology interface |
| CConstantRainSource | A simple implementation of RainSource |
| CIDW_Meteorology | Regionalizes meteorological measurements using a simple inverse distance weighted (IDW) method |
| CIDWRainfall | A RainSource using a spatially interpolated rainfall intensity from all stations |
| Clog_wind_profile | , A logarithmic wind profile |
| CMeteorology | An abstract class, for objects generating Weather records at a specific time |
| CMeteoStation | A meteorological station holding timeseries to create Weather records |
| CMeteoStationList | A list of meteorological stations |
| CMeteoStationReference | A reference to a meteorological station |
| CRainfallStation | RainfallStation describes a rainfall timeseries in mm/day at a certain place |
| CRainfallStationList | A list of rainfall stations |
| CRainfallStationReference | References a single RainfallStation to provide rainfall intensity data |
| CRainSource | An abstract class for different types of rainfall sources |
| CTimeseriesRainSource | A rainsource with a timeseries |
| CWeather | |
| ►Ndraw | |
| ►Ncellmap | |
| CCellMap | |
| CFluxMap | |
| ►Nhillplot | |
| CHillPlot | |
| ►Nshapemap | |
| CShapeMap | |
| ►Ngeometry | Contains geometric features like point (=location) and raster datasets |
| ►Nqtree | |
| CQuadtree | |
| Cpoint | 2D-Point Class |
| Cpoint_vector | Holds three arrays x,y and z for fast access of point coordinates |
| ►Njacobian | |
| CJacobian | |
| ►Nmaps | |
| CMap | |
| CNearestNeighborMap | |
| CPolygonMap | |
| ►Nmath | Contains classes for numerical solving of ODE's |
| CBDF2 | An order 2 BDF-Method with fixed-point iteration and variable step size |
| Ccubicspline | Interpolates points with a cubic spline interpolation |
| CCVodeAdams | Explizit multistep solver using CVode |
| CCVodeBanded | Implicit BDF CVode solver with a banded Jacobian approximation |
| CCVodeBase | Abstract base class for different modes of the CVode solver |
| CCVodeDense | Implicit BDF CVode solver with full Jacobian approximation |
| CCVodeDiag | Implicit BDF CVode solver with a one line diagonal Jacobian approximation |
| CCVodeInfo | Reports the current state of a CVode solver |
| CCVodeKrylov | Implicit BDF CVode solver with a Krylov preconditioner |
| CCVodeOptions | A set of options for all CVode3 solver |
| CDate | An absolute time, not for calculation. Date and Time are interchangable |
| CExplicitEuler_fixed | An explicit Euler integrator, with a fixed time step |
| CHeunIntegrator | A simple predictor - corrector solver |
| CImplicitEuler | An implicit (backward) Euler integrator using fixpoint iteration |
| CIntegrator | Base class for any kind of integrator |
| CMultiIntegrator | The MultiIntegrator is a wrapper for a bunch integrators. The states of the integrators should not have direct connections over integrator boundaries |
| Cnum_array | A valarray kind of vector implementation with OpenMP capabilities |
| CRKFIntegrator | Integrates a vector of cmf::math::StateVariable with the Runge-Kutta-Fehlberg (RKF54) method |
| CSoluteWaterIntegrator | A SoluteWaterIntegrator implements the cmf::math::Integrator interface, but consists of two independent ODE-solvers |
| CStateVariable | Abstract class state variable |
| CTime | A time class, used to pass around current modelling times |
| Ctimeseries | A timeseries is a list of values, equally distributed over time |
| ►Nriver | Contains storages and connection for the simulation of surface water bodies, like rivers, channels, lakes and dams |
| CChannel | A wrapper for channel geometries |
| CCrossSectionReach | Structure for the description of reaches with a freely defined cross section |
| CIChannel | Structure for the description of structural parameters of a reach Abstract base class for different IChannel geometries |
| CIVolumeHeightFunction | Volume height relations are functional objects, which return a height and a crosssectional area of a volume for different geometric bodies |
| CManning | Calculates the flux between two open water bodies, using Manning's equation |
| CManning_Diffusive | Connecting surface water bodies using a diffusive wave |
| CManning_Kinematic | Connecting surface water bodies using a kinematic wave |
| CMeanChannel | A combination of two channel geometries |
| COpenWaterStorage | An open water body |
| CPipeReach | Describes the geometry of a closed pipe |
| CPrism | Height of a volume in a Prism with a defined base area |
| CReach | A reach represents the section of a riover and is a specialization of an open water storage |
| CReachIterator | An iterator over every upstream reach from a start reach |
| CRectangularReach | Describes a IChannel with a rectangular crosssection |
| CSWATReachType | Structure for the description of structural parameters of a reach |
| CTriangularReach | Structure for the description of reaches with a triangular cross section |
| Cvolume_height_function | A wrapper class for volume / height functional relations |
| ►Ntimetools | |
| CStopWatch | |
| Ctimerange | |
| ►Nupslope | Contains the classes to describe the discretization of the soil continuum |
| ►Nconnections | Contains different kinds of connections between the water storages of a cell |
| CCanopyOverflow | Calculates the overflow of a canopy storage using a kinematic wave approach |
| CConceptualInfiltration | Connects the surfacewater and the most upper layer using a simplified infiltration model suitable for conceptional models |
| CDarcy | Calculates the lateral flow using the gravitational potential gradient only |
| CDarcyKinematic | A simple kinemtic wave model for subsurface flux |
| CDiffusiveMacroMicroExchange | A simple first order diffusive water exchange between MacroPore and matrix (SoilLayer) |
| CDiffusiveSurfaceRunoff | A connection to route water from a SurfaceWater storage to another node following the gradient of the water level |
| CEnergyBudgetSnowMelt | Calculates snow melt using the surface energy budget method |
| CFreeDrainagePercolation | Calculates a free drainage (unit gradient) from a layer to somewhere else |
| CGradientMacroFlow | Gradient based flux from macro pore to macro pore |
| CGradientMacroMicroExchange | A gradient based exchange term between macropores and micropores, using a fixed (air-) potential for macropores |
| CGreenAmptInfiltration | Connects the surfacewater and the most upper layer using a Green-Ampt equation like infiltration |
| CJarvisMacroFlow | A physically based macropore to macropore connection according to Jarvis & Leeds-Harrison 1987, JSS |
| CKinematicMacroFlow | Linear storage based flux from macro pore to macro pore |
| CKinematicSurfaceRunoff | A connection to route water from a SurfaceWater storage to another node following a topographic gradient |
| Clateral_sub_surface_flux | An abstract base class for lateral subsurface fluxes |
| CLayerBypass | A simplification of macro pore flux for swelling soils |
| CMACROlikeMacroMicroExchange | This connection models the water exchange between macropores and micropores as in the MACRO Model (Larsbo & Jarvis, 2003), which follows Gerke & van Genuchten 1996 |
| CMatrixInfiltration | Connects the surfacewater and the most upper layer using a Richards equation like infiltration model |
| CRainfall | A connection routing rainfall to surface water and to an eventually existing canopy storage |
| CRichards | Calculates flow according to the Richards equation |
| CRichards_lateral | Calculates the flux using Richard's equation for adjacent layers |
| CRutterInterception | Interception storage overflow according to the Rutter and Morton (1977) model |
| CSnowfall | A connection routing snowfall (precipitation below freezing Temp) to the snow pack |
| CSWATPercolation | A tipping bucket percolation approach similar to the approach in SWAT |
| CTempIndexSnowMelt | Calculates snow melt using a simple degree day method |
| CTOPModelFlow | Calculates a flux from a soil layer using TOPMODELs (Beven & Kirkby 1979) exponential transmissivity concept |
| CTopographicGradientDarcy | Calculates the lateral flow using the topographic gradient |
| ►NET | Contains different flux_connection classes for the description of evaporation and transpiration |
| CCanopyStorageEvaporation | Calculates the evaporation from a canopy storage |
| CconstantETpot | A constant evapotranspiration |
| CContentStress | A simple water content based stress model based on Feddes (1978) |
| CHargreaveET | Calculates the Evapotranspiration using Hargreave's equation |
| COudinET | Calculates ETpot after Oudin et al 2005 |
| CPenmanEvaporation | Calculates evaporation from an open water body |
| CPenmanMonteithET | Calculates the potential evapotranspiration according to FAO(1998) |
| CPriestleyTaylorET | Calculates the Evapotranspiration using Priestley-Taylor equation |
| CRootUptakeStressFunction | An abstract class to calculate the actual transpiration from potential transpiration |
| CShuttleworthWallace | Calculates the sum of soil evaporation and transpiration according to Shuttleworth & Wallace 1985, as implemented in BROOK 90 (Federer 1990) |
| CstressedET | An abstract base class for ET Methods with a WaterStressFunction |
| CSuctionStress | The classical suction depending transpiration Stress curve after Feddes |
| CSW_evap_from_canopy | Connection for Shuttleworth-Wallace canopy interception evaporation |
| CSW_evap_from_layer | Connection for Shuttleworth-Wallace ground evaporation |
| CSW_evap_from_snow | Connection for Shuttleworth-Wallace canopy interception evaporation |
| CSW_evap_from_surfacewater | Connection for Shuttleworth-Wallace canopy interception evaporation |
| CSW_transpiration | Connection for Shuttleworth-Wallace transpiration |
| CtimeseriesETpot | A timeseries driven evapotranspiration |
| CTurcET | Calculates ETpot after Turc (DVWK) |
| CVolumeStress | A WaterStressFunction based on the stored water volume of a layer |
| ►Nvegetation | |
| CVegetation | Holds the vegetation parameters for the calculation of ET and fractionating rainfall. Not every ET method uses all parameters |
| Caquifer | A class to represent large groundwater storages, not bounded to the usual horizontal discretization scheme, the Cell |
| Caquifer_Darcy | Lateral darcy flow between aquifer objects |
| CBrooksCoreyRetentionCurve | Provides the use of the Brooks-Corey retention curve |
| CCell | This class is the basic landscape object |
| Ccell_vector | A cell vector holds a bunch of cells |
| CCellConnector | A helper class to connect cells with flux_connection objects. This is generated by flux_connection classes, intended to connect cells |
| Cconductable | An abstract interface for all classes providing a conductivity (e.g |
| Clayer_list | A vector of layers, with array access to the properties of the layers, for fast data exchange |
| CLinearRetention | The linear retention curve provides a simple linear relationship between storage and head |
| CMacroPore | An additional water storage for a soil layer to model matrix water and macro pore water seperately |
| Cneighbor_iterator | A class to iterate through the neighbors of a cell (const). Not needed from the Python side, use the generator cell.neighbors instead |
| CRetentionCurve | Abstract base class for different types of retention curves |
| CSoilLayer | A representation of a SoilLayer |
| Csubcatchment | A class to structure cells in a project using their main outlets |
| CSurfaceWater | A child class of OpenWaterStorage to model surface water on a cell |
| CTopology | Connectivity of cells to each other |
| CVanGenuchtenMualem | Provides the use of the Van Genuchten - Mualem retention curve (Van Genuchten 1980) |
| ►Nwater | Contains generic classes for solute and water transport |
| CAdsorption | Abstract class to use adsorption process for tracers on surfaces |
| Cconnection_list | A self sorting list of connections |
| CConstantFlux | Produces a constant but changeable flux from a source to a target, if enough water is present in the source |
| CConstantStateFlux | Calculates a flux to or from a water storage to hold it's state at a more or less constant level |
| CConstraintLinearStorageFlux | Calculates flux out of a storage as a linear function of its volume, constraint by the volume stored in the target storage |
| CDirichletBoundary | Dirichlet (constant head) boundary condition |
| CExponentialDeclineConnection | A conceptual TOPmodel inspired connection |
| CExternallyControlledFlux | Flux from one node to another, controlled by the user or an external program, by changing the flux constant |
| Cflux_connection | The connections in cmf hold the processes for the calculation of fluxes between water storages and model boundaries |
| Cflux_node | Base class for everything that can be connected by fluxes |
| CLangmuirAdsorption | This class calculates the adsorption equilibrium between sorbat and sorbent using the Langmuir isotherme |
| Clinear_scale | A linear scaling functor, with slope and displacement |
| CLinearAdsorption | This class calculates the adsorption equilibrium between sorbat and sorbent using the linear (Henry) isotherme |
| CLinearGradientFlux | A generic node-to-node gradient based connection |
| CLinearStorageConnection | Calculates flux out of a storage as a linear function of its volume |
| CNeumannBoundary | A Neumann boundary condition (constant flux boundary condition) |
| CNeumannBoundary_list | Provides fast access to Neumann boundaries for flux update |
| CNeumannFlux | Connection between Neumann-boundary and a flux node |
| Cnode_list | A collection of nodes for fast access of the waterbalance |
| CNullAdsorption | A class for tracers without interaction with the storage container. freesolute returns xt |
| CPartitionFluxRoute | Routes a fraction of the flux calculated from a master flux_connection between source to target1 directly further to target2 without any timelag |
| CPowerLawConnection | Calculates flux out of a storage as a linear function of its volume to a power |
| Csolute | A structure to identify a solute |
| CSolute1stOrderReaction | A solute reaction of 1st order kinetics (linear decline to product) A->B |
| CSolute2ndOrderReaction | A solute reaction of 2nd order kinetics A + B -> C |
| Csolute_vector | Manages the solutes of the model |
| CSoluteConstantFluxReaction | Adds a constant flux to the solute storage |
| CSoluteDecayReaction | Adds a linear decay to solute storages |
| CSoluteDiffusiveTransport | Calculates a diffusive flux between solute storages |
| CSoluteEquilibriumReaction | An equilibrium reaction between two solutes A<->B |
| CSoluteRateReaction | A general solute reaction system to describe multi-species kinetics with a power law |
| CSoluteReaction | Abstract class for a solute reaction |
| CSoluteStorage | A class for the storage of any tracer |
| CSoluteTimeseries | A map of concentration time series for solutes |
| CWaterbalanceFlux | Routes the sum of all other fluxes to a target |
| CWaterStorage | A state variable for the storage of water |
| C_Options | Holds global options for specific cmf behaviour, accessbile via cmf.options |
| Cproject | The study area, holding all cells, outlets and streams |