Procedures

compute accumulated growing degree day (GDD), sum of growing degree day over days. Start accumulate when daily GDD > 0

count number of observations different from missing data Can optionally return network containing actual measurements.

Adds the specified number of days to the value of this instance.

Adds the specified number of hours to the value of this instance.

Adds the specified number of minutes to the value of this instance.

Adds the specified number of seconds to the value of this instance. If number of seconds is a negative number, the amount is subtracted

Adjust the varying string to the left

Subroutine to adjust the actual evaporation to the intercepted rainfall. The amount of water intercepted by the canopy is going to contribute to the evaporation rate. When calculating the evaporation within a forest, the model tends to remove as much as possible from the water intercepted by the canopy. This step will be carried out before the adjustement of the evapotranspiration to soil moisture.

Adjust the varying string to the right

compute the age modifier. It modulates the maximum potential growth during the different stages of the vegetation life cycle as trees in the early stages are not as vigorous as mature trees

Initialize air relative humidity

Read air relative humidity data

Initialize air temperature

Read air temperature data

Initialize air temperature

Read air temperature data

Initialize air temperature

Read air temperature data

Computes the absorbed photosynthetically active radiation. The amount of light available for the plant that is going to define its growth rate. The light that the plant could absorb is determined according to the canopy cover. The amount of absorbed photosynthetically active radiation is usually computed following Lambert-Beer law .

Set variables and options to manage plants. Basically two options are available:

assign data to a network from grid_real

assign value of mask integer to mat integer

assign value of mask integer to mat real

assign value of mask real to mat real

assign value of mask real to mat integer. real numbers are truncated to integer part.

assign value to mat

assign value to mat

The method constructs a grid of size determined by the distribution of the two dimensional data points. Using this grid, the function values are calculated at each grid point. To do this the method utilises a series of Gaussian functions, given a distance weighting in order to determine the relative importance of any given measurement on the determination of the function values. Correction passes are then made to optimise the function values, by accounting for the spectral response of the interpolated points.

compute basin area (m2)

cumulate variable along stream network

compute mask of river basin given map of flow direction and the coordinate of the outlet point

search for cells included in the river basin

delineate and export basin mask

Find the bearing angle (radians) between two points in a 2D space, as the angle measured in the clockwise direction from the north line with A as the origin to the line segment AB. Assume radians as input unit for geodetic reference system.

returns the correction factor to be used in MCT algorithm (-)

Build reaches that compose the river network

compute canopy cover (0-1)

Compute shadow grid

exception handler

returns the celerity (m/s)

Description compute area (m2) of a cell of a grid as a function of latitude defined by the position of cell in local coordinate system (row, column). Input grid of type grid_real

Description compute area (m2) of a cell of a grid as a function of latitude defined by the position of cell in local coordinate system (row, column). Input grid of type grid_integer

return true if cell of grid_real contains no data value

returns true if cell of grid_integer contains no data value

find the cells that are springs, defined as those cells that have not any other cells upstream

return false if cell is out of grid either contains nodata value, true otherwise.

return false if cell is out of grid either contains nodata value, true otherwise.

Description compute average length (m) of a cell of a grid as the squareroot of area Input grid of type grid_real

Description compute average length (m) of a cell of a grid as the squareroot of area Input grid of type grid_integer

returns the coordinate of the centroid given a grid_integer mask, in the same coordinate reference system of grid_integer

returns the coordinate of the centroid given a grid_integer mask, in the same coordinate reference system of grid_integer

compute sediment detachment rate per second in channel element (kg/s) using simplified approach by Sun et al. (2002).

Define channel cells. Two methods are possible:

Convert a varying string into a character string (automatic length)

Convert a varying string into a character string (fixed length)

check if section and subsection still opened

if the downstream cell is a nodata value or out of grid space, or points toward the current cell, the current cell is the basin outlet.

check properties for each ET model

compute CO₂2 modifier.

Compute net radiation

Compute spatial average of soil water balance variables

Compute spatial average of canopy interception variables

Compute spatial average of glaciers variables

Compute spatial average of meteorological variables

Compute spatial average of plants variables

Compute spatial average of sediment variables

Compute spatial average of snow variables

Configure extents for computing and storing spatial average values

Scan the eigth cells surrounding the center cell (row,col) (neglecting the upstream cell (i,j) ) to find if a confluence is present. The confluence cell must be of the same order or not yet defined.

The subroutine converts the current input coordinates in the coordinate system defined by the current input coordinate system parameters and input datum, into output coordinates in the coordinate system defined by the output coordinate system parameters and output datum.

The subroutine converts Gauss Boaga projection for Italy (easting and northing) coordinates to geodetic (latitude and longitude) coordinates

The subroutine converts geodetic(latitude and longitude) coordinates to Gauss Boaga (easting and northing) coordinates, according to ROME40 datum for Italy (MonteMario) coordinates.

The subroutine converts geodetic (latitude and longitude) coordinates to Hotine Oblique Mercator projection (easting and northing)

The subroutine converts geodetic (latitude and longitude) to Swiss Oblique Cylindrical projection(easting and northing) coordinates

The subroutine converts geodetic(latitude and longitude) coordinates to Transverse Mercator projection (easting and northing) coordinates, according to the current ellipsoid and Transverse Mercator projection coordinates.

The subroutine converts geodetic(latitude and longitude) coordinates to UTM projection (easting and northing) coordinates, according to the current ellipsoid and UTM projection coordinates.

The subroutine converts Hotine Oblique Mercator projection (easting and northing) coordinates to geodetic (latitude and longitude) coordinates

The subroutine converts Swiss Oblique Cylindrical projection (easting and northing) coordinates to geodetic (latitude and longitude) coordinates

The subroutine converts Transverse Mercator projection (easting and northing) coordinates to geodetic (latitude and longitude) coordinates, according to the current ellipsoid and Transverse Mercator projection parameters.

The subroutine converts Universal Transverse Mercator projection (easting and northing) coordinates to geodetic (latitude and longitude) coordinates, according to the current ellipsoid and UTM projection parameters.

Create an exact copy of DateTime

copy the content of a CRS variable in another CRS variable

Create an exact copy of a datum.

Create an exact copy of an ellipsoid.

make a copy of one observational network

count number of cells different from nodata

count number of cells different from nodata

count number of reservoirs in a list

Subroutine to calculate a covariance vector from a semivariogram model and a vector of separation distances.

Subroutine to calculate a covariance matrix of observations from a semivariogram model and a vector of separation distances.

compute critical velocity for incipient motion (m/s)

returns true if it is time to start a process

returns the next time to start a process given the current time

parse cron string

compute crown doameter (m)

return .TRUE. if the two coordinate reference systems are equal

return .TRUE. if the two grids have the same Coordinate Reference System, and the same spatial reference (cellsize, xllxorner, yllcorner, idim, jdim) If checkCells is given the function checks that grid has the same active cells of mask.

return .TRUE. if the two grids have the same Coordinate Reference System, and the same spatial reference (cellsize, xllxorner, yllcorner, idim, jdim) If checkCells is given the function checks that grid has the same active cells of mask.

return .TRUE. if the two grids have the same Coordinate Reference System, and the same spatial reference (cellsize, xllxorner, yllcorner, idim, jdim) If checkCells is given the function checks that grid has the same active cells of mask.

return .TRUE. if the two grids have the same Coordinate Reference System, and the same spatial reference (cellsize, xllxorner, yllcorner, idim, jdim) If checkCells is given the function checks that grid has the same active cells of mask.

return current directory

Calculate curvature according to method implemented in MICROMET

check that date do not contain errors.

Check if datetime is set to default

return .TRUE. if the two datums are equal

Gets the day of the year represented by this instance. Returns 366 for leap years

Returns the number of days in the specified month. It accounts for leap years

Compute the actual ratio DBH-crown diameter: crown/dbh (m/cm)

relationship between DBH (Diameter at Brest Height) and stem biomass.

get EPSG code as input and set coordinate reference system

compute melt rate (m/s) using degreeday temperature based model

returns water depth given wetted area (m) using Newton-Raphson.

Return which division corresponds to given depth

Aspect identifies the downslope direction of the maximum rate of change in value from each cell to its neighbors. Aspect can be thought of as the slope direction. The values of the output raster will be the compass direction of the aspect. A moving window visits each cell in the input raster and for each cell in the center of the window, an aspect value is calculated using an algorithm that incorporates the values of the cell's eight neighbors. If any neighborhood cells are NoData, they are first assigned the value of the center cell, then the aspect is computed. The cells are identified as letters 'a' to 'i', with 'e' representing the cell for which the aspect is being calculated. The rate of change in the x direction for cell 'e' is calculated with the following algorithm:

Calculates the curvature [1/m] of a raster surface, optionally including profile and plan curvature. If any neighborhood cells are NoData, they are first assigned the value of the center cell. It calculates the second derivative value of the input surface on a cell-by-cell basis. For each cell, a fourth-order polynomial of the form:

For each cell, the routine calculates the maximum rate of change in value from that cell to its neighbors. Basically, the maximum change in elevation over the distance between the cell and its eight neighbors identifies the steepest downhill descent from the cell. Conceptually, the routine fits a plane to the z-values of a 3 x 3 cell neighborhood around the processing or center cell. The slope value of this plane is calculated using the average maximum technique. The direction the plane faces is the aspect for the processing cell. If there is a cell location in the neighborhood with a NoData z-value, the z-value of the center cell will be assigned to the location.

deallocate space

delete a directory

Find the direction angle (radians) between two points in a 2D space, measured in the clockwise direction. Formula gives values 0°<θ<90° for lines with positive slope and values 90°<θ<180° for lines with negative slope. The result does depend on which point is point 1 and which is point 2. Assume radians as input unit for geodetic reference system.

returns TRUE if directory exists

return a list of files in a directory

create a new directory

rename a directory

returns the normal discharge (m3/s) with Chezy equation.

Export of point site data

Initialize export of point site data

route discharge in surface network

compute distance between two points in, either, projected or geodetic coordinate reference system

A subroutine to assemble the global distance. This operation is only carried out once; kriging observations matricies are subsetted from this lookup table to speed up processing.

save diversion state variables on file

Discharge routing through diversion. Discharge is split between river and diversion channel

Load domain properties

Converts a double precision number in a string Arguments: number number to be converted Result: string

returns the position (is,js) of the downstream cell and, optionally, the flow path length, considering cardinal and diagonal direction

Drainage Density (1/m) of a basin is the total line length of all streams divided by basin area. If flow accumulation is not given, it is computed from flow direction. If coordinate of closing section is not given drainage density is computed for the entire grid.

return .TRUE. if the two ellipsoids are equal

return true if time1 is equal to time2. Before comparison, dates are converted to UTC

Compute actual evapotranspiration from ground by solving energy balance Original code written by Chiara Corbari and Jacopo Martinelli

Initialize evapotranspiration computation

Export basin averaged values

export grid_real to a ESRI ASCII file.

export grid_real to a ESRI BINARY file.

export grid_real to file. List of supported format:

export grid into netcdf file. Two actions are possible:

export grid_integer to a ESRI ASCII file.

export grid_integer to a ESRI BINARY file.

export grid_integer to file. List of supported format:

export grid into netcdf file. Two actions are possible:

Update and export maps

Export reaches on file

export shape file of river network

Export spatial average of soil balance variables

Export spatial average of canopy interception variables

Export spatial average of glaciers variables

Export spatial average of meteorological variables

Export spatial average of plants variables

Export spatial average of sediment variables

Export spatial average of snow variables

Extract a varying substring from a character string

Extract a varying substring from a varying string

Extracts only the cells on the external border. Other cells are assigned nodata. Border cell is the one that has at least a nodata value in the neighbouring 8 cells.

Extracts only the cells on the external border. Other cells are assigned nodata. Border cell is the one that has at least a nodata value in the neighbouring 8 cells. If cardinal is passed the routine checks only the four cells in the cardinal direction. This option is used to obtain border without duplicates. Default is check all the cells.

compute fall velocity of sediment (m/s)

Compute potential evapotranspiration with FAO56 Penman-Monteith model for a reference grass "A hypothetical reference crop with an assumed crop height of 0.12 m, a fixed surface resistance of 70 s m-1 and an albedo of 0.23."

function called by Simplex

delete a file

returns TRUE if file exists

create a new text file

rename a file. If renamed file already exists it is not overwritten and warning is raised.

synchronize to the last line of formatted file

Converts a real number in a string Arguments: number number to be converted Result: string

compute map of flow accumulation (m2) Input grid: flow direction

evaluation of the objective function

fill in a grid with state variable values in forest stands

shifts geodetic coordinates relative to WGS84 to geodetic coordinates relative to a given local datum.

shifts geodetic coordinates relative to a given source datum to geodetic coordinates relative to WGS84.

Initialize parameters for conversion

Read from the default unit into a varying string

Read from the default unit into a varying string, with a custom character-string separator

Read from the default unit into a varying string, with a custom varying-string separator

Read from the specified unit into a varying string

Read from the default unit into a varying string, with a custom character-string separator

Read from the specified unit into a varying string, with a custom varying-string separator

Description compute area (m2) of grid excluding nodata

compute mean Bias between two grids real optional argument: mask: compute Bias only on assigned mask rbias: compute relative Bias

compute coefficient of variation of grid_real eventually constrained to a mask

Gets the day of the datetime represented by this instance

Gets the day of week (0 - 6) (Sunday to Saturday The formula is:

given a list of diversion channels, returns a pointer to one diversion by id

given filename of a multidimensional net-cdf file the GetFirstDate function returns the date and time of first grid

read and calculate georeferencing informations from netCDF file.

get grid mapping for a floating point grid

get grid mapping for a floating point grid

Gets the month of the datetime represented by this instance

returns X and Y coordinate given i and j position in grid(i,j)

returns X and Y coordinate given i and j position in grid(i,j)

compute maximum of grid_real eventually constrained to a mask

compute maximum of grid_integer eventually constrained to a mask

compute mean of a vector of real numbers. If nodata is passed numbers are filetered before computing mean

compute mean of grid_real eventually constrained to a mask

compute mean of grid_integer eventually constrained to a mask

compute minimum of grid_real eventually constrained to a mask

compute minimum of grid_integer eventually constrained to a mask

Gets the minute of the datetime represented by this instance

Gets the month of the datetime represented by this instance

count sections in a ini db

return number of subsections within a section of a ini db

compute Nash and Sutcliffe efficiency index, equivalent to coefficient of determination. optional argument: mask: compute RMSE only on assigned mask nrmse: compute normalized Nash efficiency

get operating system

return the position in practices array given practice id

compute R2, square of the Pearson correlation coefficient optional argument: mask: compute RMSE only on assigned mask

given a list of reservoirs, returns a pointer to one reservoir by id

compute Root Mean Square Error between two grids real optional argument: mask: compute RMSE only on assigned mask nrmse: compute Normalizes Root Mean Square Error

Gets the second of the datetime represented by this instance

compute unbiased standard deviation of grid_real optionally constrained to a mask

compute unbiased standard deviation of grid_integer optionally constrained to a mask

compute sum of grid_real eventually constrained to a mask

compute sum of grid_integer eventually constrained to a mask

given filename of a multidimensional net-cdf file the GetTimeStepsFromFile function returns the number of time steps

given ncId of a multidimensional net-cdf file the GetTimeStepsFromNCid function returns the number of time steps

Gets the string representing time zone of the datetime represented by this instance. Example: '+02:00'

returns a free FORTRAN unit number Discussion: A "free" FORTRAN unit number is an integer between 1 and 999 which is not currently associated with an I/O device. A free FORTRAN unit number is needed in order to open a file with the OPEN command. If IUNIT = 0, then no free FORTRAN unit could be found, although all 999 units were checked (except for units 5 and 6). Otherwise, IUNIT is an integer between 1 and 99, representing a free FORTRAN unit. Note that GetUnit assumes that units 5 and 6 are special, and will never return those values. Adapted from John Burkardt

returns a free FORTRAN unit number Discussion: A "free" FORTRAN unit number is an integer between 1 and 99 which is not currently associated with an I/O device. A free FORTRAN unit number is needed in order to open a file with the OPEN command. If IUNIT = 0, then no free FORTRAN unit could be found, although all 99 units were checked (except for units 5 and 6). Otherwise, IUNIT is an integer between 1 and 99, representing a free FORTRAN unit. Note that GetUnit assumes that units 5 and 6 are special, and will never return those values. Adapted from John Burkardt

returns X and Y coordinate given i and j position in grid(i,j)

returns X and Y coordinate given i and j position in grid(i,j)

extraxt the number of columns (x) and rows (y) from netCDF file.

Gets the year of the datetime represented by this instance

Initialize glacier model

update parameter map that change in time

Export of point site data

Initialize export of point site data

compute accumulation and ablation and update water equivalent

return true if time1 is greater than time2

return true if time1 is greater than time2 or time1 is equal to time2

calculates the actual rate of infiltration (m/s) according to Green-Ampt equation for unsteady rainfall.

return an array 1D of numbers different than nodata in a grid_real

return an array 1D of numbers different than nodata in a grid_integer

read a grid_real using information stored in ini configuration file

read a grid_real using information stored in ini configuration file defined in subsection [[...]]

read a grid_integer using information stored in ini configuration file

read a grid_integer using information stored in ini configuration file defined in subsection [[.. ]]

coordinate conversion of a grid_real definition of corner points:

coordinate conversion of a grid_integer definition of corner points:

deallocate float grid

deallocate integer grid

Initialize groundwater

Initialize files for exporting output results

update boundary condition map that change in time

Export of point site data

Initialize export of point site data

Configure river-groundwater interaction

Update river-groundwater exchange fluxes

update groundwater head with Darcy law and mass conservation in two dimensions, with a macrocopic cellular automata approach

update DBH and height tree every new year

update DBH and height tree according to ech2o model by Maneta

update leaf biomass and leaf area index

Compute potential evapotranspiration with Hargreaves Samani model at daily time scale

Compute potential evapotranspiration at daily time scale with Hargreaves Samani model modified by Ravazzani et al. (2012) to include an elevation correction factor

relationship between tree height and DBH (Diameter at Brest Height). Implements Chapman-Richards relationship

returns a grid_integer containing Horton orders. Horton orders are computed on the entire space-filled basin.

Get the position in the ISO 646 collating sequence of a varying string character

Get the position in the processor collating sequence of a varying string character

Inverse Distance Weighted interpolation. Accept as optional argument the power parameter and the number of near observations to included in interpolation. Can use Shepard's method (Shepard 1968) or Franke & Nielson, 1980

Get the index of a varying substring within a character string

Get the index of a character substring within a varying string

Get the index of a varying substring within a varying string

return true if time1 is different from time2

Initialize evapotranspiration computation

add a new Key-Val pair

close a ini file

count Key-Val pair in a file

open and read a ini file

read a ini file already open

read an double precision number corresponding to Key

read an integer corresponding to Key

read a logical value corresponding to Key

read a real number corresponding to Key

read a string corresponding to Key

Initialization of basin average

Initialize surface routing

Initialize diversions

Initialization of raster export

Initialize reservoirs

Initialize soil water balance

Initialization of spatial average of soil balance variables

Initialization of spatial average of canopy interception variables

Initialization of spatial average of glaciers variables

Initialization of spatial average of meteorological variables

Initialization of spatial average of plants dynamic variables

Initialization of spatial average of sediment variables

Initialization of spatial average of snow variables

Insert a character substring into a character string

Insert a varying substring into a character string

Insert a character substring into a varying string

Insert a varying substring into a varying string

initialize variables for computing rainfall interception

interpolate site data to space

A subroutine to predict the data value of an unsampled location, using geostatistical methods. Interpolation is carried out using the 'Ordinary Kriging' method.

compute sediment detachment rate (kg/s). Interril area detachment is considered to be due to the raindrop impact, which breaks the cohesive bonds between particles, making them available for transport.

Inverse matrix Method: Based on Doolittle LU factorization for Ax=b

configure irrigation

update irrigation and write output

Returns true if the specified year is a leap year

calculates if cell is out of grid space limits

calculates if cell is out of grid space limits

Returns true if datetime object is expressed in UTC

read new Kc values

Erase lines except the number specified as argument. pos defines wheter kept lines are counted starting from the beginning or from the end of file. Optional argument header defines number of lines at the beginning of the file to be considered as header. Header lines are never deleted. Manipulated file is supposed to be already opened.

return true if key is present, false otherwise

the number of trees is updated considering the mortality of the plants. for each tree that dies, a fraction mi of the mean biomass three types of mortality are considered:

Interpolate irregularly spaced data using Kriging. The subroutine generates an empirical semivariogram (anisotropy is assumed), fits the best model among spherical, exponential and gaussian.

Initialize variables for kriging

Get the length of a varying string

Get the trimmed length of a varying string

return true if time1 is less than time2

return true if time1 is less than time2 or time1 is equal to time2

Discharge routing through reservoir. Given Qin, find Qout and stage References:

Compare (LGE) a character string and a varying string

Compare (LGE) a varying string and a character string

Compare (LGE) two varying strings

Compare (LGT) a character string and a varying string

Compare (LGT) a varying string and a character string

Compare (LGT) two varying strings

calculates linear interpolation between real numbers. Output is a double real

calculates linear interpolation between real numbers.

calculates linear interpolation between integer numbers with output real.

compute slope of linear regression between vector x and y

Compare (LLE) a character string and a varying string

Compare (LLE) a varying string and a character string

Compare (LLE) two varying strings

Compare (LLT) a character string and a varying string

Compare (LLT) a varying string and a character string

Compare (LLT) two varying strings

initialize global parameters

write a formatted string on specified unit- It is called by Catch routine

stop logging. If open, close the log file

compute longest flow length (m)

compute slope of longest flow path (m/m)

Converts a long integer number in a string Arguments: number number to be converted Result: string

Define cells where the beginning of a reach of different order takes place.

A generic subroutine to invert a square 2D matrix by pivoting ("Gauss-Jordan" method). An n*2,n work array is assembled, with the array of interest on the left half, and the identity matrix on the right half. A check is made to ensure the matrix is invertable, and the matrix inverse is returned, providing the matrix is not singular. The matrix is invertable if, after pivoting and row reduction, the identity matrix shifts to the left half of the work array. Initially the code was written in integer form to avoid fractions in the work array, but numbers rapidly become inconcevably large. The implemented solution therefore works on fractional pivot rows, with pivots factored to leading ones. Double precision arrays have been used to maintain numerical stability.

Compute the distance in meters along a meridian from equator to given latitude.

Initialize meteorological forcings

Export of point site data

Initialize export of point site data

Read meteorological forcings

performs a linear transformation on the original data values. Suppose that minX and maxX are the minimum and maximum of feature X. We would like to map interval [minX, maxX] into a new interval [new_minX, new_maxX]. Consequently, every value v from the original interval will be mapped into value new_v following formula:

shifts geodetic coordinates using the Molodensky method

Initialize morphological properties

Solve Muskingum-Cunge equation.

Solve Muskingum-Cunge-Todini equation. When parameters k and x are passed, C1, C2, and C3 are computed using the passed values. When x = 0, linear reservoir model. When x = 0.5 and k = dt translation only

Handle errors from netcdf related operation

The nearest neighbor algorithm selects the value of the nearest point and does not consider the values of neighboring points at all, yielding a piecewise-constant interpolant

create a new grid_real using an existing grid_real as template

create a new grid_real using an existing grid_integer as template

read a float grid from a ESRI BINARY file.

read a grid from a file. List of supported format: ESRI_ASCII: ESRI ASCII GRID ESRI_BINARY: ESRI BINARY GRID NET_CDF: NetCDF CF compliant

create a new raster_real reading data from NetCDF file The variable to read can be defined by its current name or the standard_name. The dimensions x and y of the variable is calculated searching from the dimensions of the couple of variables with 'standard_name' equal to 'projection_x_coordinate' and 'projection_y_coordinate' for projected reference systems or 'longitude' and 'latitude' for geographic reference systems or 'grid_longitude' and 'grid_latitude' for rotated pole systems If a comprehensible reference systems is not found a geodetic reference system is supposed. Once the variable is retrieved, offset and scale factor are applied and a check on minimum and maximum valid value is performed.

create a new grid_integer using an existing grid_real as template

create a new grid_integer using an existing grid_integer as template

read a integer grid from a ESRI ASCII file.

read a integer grid from a ESRI BINARY file.

read a grid from a file.

create a new grid_integer reading data from NetCDF file The variable to read can be defined by its current name or the standard_name. The dimensions x and j of the variable is calculated searching from the dimensions of the couple of variables with 'standard_name' equal to 'projection_x_coordinate' and 'projection_y_coordinate' for projected reference systems or 'longitude' and 'latitude' for geographic reference systems or 'grid_longitude' and 'grid_latitude' for rotated pole systems If a comprehensible reference systems is not found a geodetic reference system is supposed. Once the variable is retrieved, offset and scale factor are applied and a check on minimum and maximum valid value is performed.

Description returns the time of the next grid in netcdf dataset

returns the normal depth (m) using Newton-Raphson.

Gets a DateTime object that is set to the current date and time on this computer, expressed as the local time.

Compute the radius of curvature of the ellipsoid perpendicular to the meridian at given latitude

apply offset to a grid_real

Assign a varying string to a character string

Assign a character string to a varying string

Concatenate a character string and a varying string

Concatenate a varying string and a character string

Concatenate two varying strings

Compare (==) a character string and a varying string

Compare (==) a varying string and a character string

Compare (==) two varying strings

Compare (>=) a character string and a varying string

Compare (>=) a varying string and a character string

Compare (>=) two varying strings

Compare (>) a character string and a varying string

Compare (>) a varying string and a character string

Compare (>) two varying strings

Compare (<=) a character string and a varying string

Compare (<=) a varying string and a character string

Compare (<=) two varying strings

Compare (<) a character string and a varying string

Compare (<) a varying string and a character string

Compare (<) two varying strings

Compare (/=) a character string and a varying string

Compare (/=) a varying string and a character string

Compare (/=) two varying strings

Compute tthe atmospheric optical depth

write results on files

initialise files for output

write results on files

initialise files for output

Compute direction angle between pairs (radians) measured from the x axis anti-clockwise

Compute distance between pairs

Converts the specified string representation of a date and time to its DateTime equivalent.

Parse units attribute of time variable Limits: string representing date and time must not contain blanks

Compute potential evapotranspiration with Penman-Monteith model

compute percolation and capilalry rise

find the cells that are springs, defined as those cells that have not any other cells upstream

Compute potential evapotranspiration

calculates the actual rate of infiltration (m/s) according to Philip's equation. Use time compression approximation.

Initialize Plants module

Update plants state variables

update parameter map that change in time

Initialize precipitation

Read precipitation data

Initialize precipitation

Read precipitation data

Compute potential evapotranspiration with Priestley-Taylor model

Compute matric potential (m)

Append a character string to the current record of the default unit

Append a varying string to the current record of the default unit, terminating the record

Append a varying string to the current record of the specified unit, terminating the record

Append a varying string to the current record of the specified unit, terminating the record

Append a varying string to the current record of the default unit, terminating the record

Append a character string to the current record of the specified unit

Append a varying string to the current record of the specified unit

Append a varying string to the current record of the default unit

read data from file unit. Data spanned on multiple time steps can be aggregated computing average, cumulated, maximum or minimum. Aggregated value is considered as missing if number of actual available observations is less than a given percentage (tresh)

read a time varying field from a netcdf file

read geometry table

read metadata section from file

read metadata section from open unit

Read network for groundwater-surface interaction from file

Read network for sediment routing from file

Read network for surface flow routing from file

Read point file

read soil types from external file

read species parameters

read weir table

read weir table

compute refreezing rate (m/s) of the water retained in snowpack

Remove a substring from a character string

Remove a substring from a varying string

Concatenate several copies of a varying string

Replace part of a character string with a character substring

Handle special cases when LEN(target) == 0. Such instances are prohibited by the standard, but since this function is elemental, no error can be thrown. Therefore, it makes sense to handle them in a sensible manner

Replace part of a character string with a character substring

Replace part of a character string with a varying substring, at a location matching a character- string target

Replace part of a character string with a varying substring

Replace part of a character string with a character substring, at a location matching a varying- string target

Replace part of a character string with a varying substring

Replace part of a character string with a varying substring, at a location matching a varying- string target

Replace part of a varying string with a character substring

Replace part of a varying string with a character substring, at a location matching a character- string target

Replace part of a varying string with a character substring

Replace part of a character string with a varying substring, at a location matching a character- string target

Replace part of a varying string with a varying substring

Replace part of a varying string with a character substring, at a location matching a varying- string target

Replace part of a varying string with a varying substring

Replace part of a varying string with a varying substring, at a location matching a varying- string target

char is replaced with rep

Create a new grid_real with cellsize different from input grid The content of the created grid is filled in with nearest neighbor method

Create a new grid_integer with cellsize different from input grid The content of the created grid is filled in with nearest neighbor method

Read reservoir stage and diversion discharge from file

Save reservoirs status into file

Compute the radius of curvature of the ellipsoid in the plane of the meridian at given latitude

solve mass continuity of reservoir using runge kutta method

compute actual soil retention capacity S of the SCS-CN method
given soil saturation

Save state variables for starting a new simulation from the current condition

apply scale factor to a grid_real

Scan a character string for occurrences of characters in a varying-string set

Scan a varying string for occurrences of characters in a character-string set

Scan a varying string for occurrences of characters in a varying-string set

return datum numeric code given a string

scan a string to extract time information as character strings: year, month, day, hour, minute, second, timezone supported formats:

calculates the actual rate of infiltration (m/s) according to Curve Number model modified for continuous simulation

Search for datum parameters using a code.

Search for ellipsoid parameters using a code.

Gets the second of the year represented by this instance.

Gets the second to the end of the year represented by this instance.

return true if section is present, false otherwise

Initialize sediment related variables

compute sediment routing in channelized drainage network using Muskingum-Cunge method. Interrill erosion is supposed to act as suspended sediment so deposition is not contemplated. Bedload sediment is divided in different grainsize classes and routing is performed for each class separately. Deposition is contemplated comparing sediment discharge to transport capacity. Flow Routing method code remind: 0 --> hillslope, water flow rate is not defined 1,2,3,11,30 --> channel routing, water flow is computed according to different schemes 5 --> Instantaneous mass transferring inside lakes (infinitive celerity) 1000:2000 --> reservoir

generate a Semivariogram from a given sample. The sample point pairs are ordered into even-width bin, separated by the euclidean distance of the point pairs. The Semivariance in the bin is calculated by the Matheron estimator. If number of lags and lag max distance are not given they are automatically computed or set to default value.

Subroutine to find the distances between prediction point and observations. Also returns angles if anisotropy present

assign easting and northing coordinates

Initialize Coordinate Reference System, allocate memory and set parameters to default value if necessary. subroutine receives as input a Coordinate type argument

Initialize Coordinate Reference System, allocate memory and set parameters to default value if necessary. Subroutine receives as input a CRS type argument

set the current time of a float grid

set the current time of a integer grid

populate array of daily values

populate array of daily values

populate array of daily values

Set the day of the datetime represented by this instance

set the esri pe string of a float grid

set the esri pe string of a integer grid

Set flow direction convention:

Set parameters for Gauss Boaga reference system

Set parameters for Gauss Boaga reference system

Set parameters for Geodetic reference system

Set parameters for Geodetic reference system

Set parameters for Hotine Oblique Mercator reference system

Set parameters for Hotine Oblique Mercator reference system

Set the hour of the datetime represented by this instance

set initial condition

set initial condition for soilwater balance

set the long name of a float grid

set the long name of a integer grid

Set the minute of the datetime represented by this instance

Set the month of the datetime represented by this instance

set parameter maps from soil database

set parameter maps from separate files

Set variables and options to manage plants. Basically two options are available:

Set management practices to single plant stand

set the reference time of a float grid

set the reference time of a integer grid

Set the second of the datetime represented by this instance

set properties and initialize variables for each interpolation method

set properties and initialize variables for each interpolation method

set properties and initialize variables for each interpolation method

set properties and initialize variables for each interpolation method

set properties and initialize variables for each interpolation method

set properties and initialize variables for each interpolation method

set properties and initialize variables for each interpolation method

set the standard name of a float grid

set the standard name of a integer grid

Set parameters for Swiss Oblique Cylindrical reference system

Set parameters for Swiss Oblique Cylindrical reference system

Set the timezone of the datetime represented by this instance

Set parameters for Transverse Mercator reference system

Set parameters for Transverse Mercator reference system

set the units of a float grid

set the units of a integer grid

Set parameters for Universal Transverse Mercator reference system

Set parameters for Universal Transverse Mercator reference system

set the varying mode of a float grid Possible values:

set the varying mode of a integer grid

set wetland for soilwater balance

Set the year of the datetime represented by this instance

compute shear velocity (m/s)

Shift back interpolated field to terrain surface

Apply a shift togrid_integer. Creates a new grid with xllcorner and yllcorner modified

shift meteo observations to reference elevation applying lapse rate

Apply a shift to grid_real. Modifies xllcorner and yllcorner

Converts a short integer number in a string Arguments: number number to be converted Result: string

This subroutine implements the simplex method of function minimization of Nelder and Mead (1965). This ingenious method is efficient for non-linear mini- mization in a multiparameter space but is still easy to program and only requires evaluations of the objective function. The program stops the iterations whenever one of the two following criteria is reached: 1. Convergence is reached 2. The maximum number of iterations is reached.

Users may call this function once to ensure that the kind parameters the module defines are available with the current compiler. We can't ensure that the two REAL kinds are actually four and eight bytes long, but we can ensure that they are distinct. Early Fortran 90 compilers would sometimes report incorrect results for the bit_size intrinsic, but I haven't seen this in a long time.

Compute the maximum angle of sky obstruction along 16 directions

Initialize snow model

update parameter map that change in time

Export of point site data

Initialize export of point site data

compute accumulation and melting and update snow water equivalent

Compute azimuth angle of the Sun's position in the north-clockwise convention

Compute solar declination. The declination of the sun is the angle between the equator and a line drawn from the centre of the Earth to the centre of the sun.

Compute the hour angle. the solar hour angle is an expression of time, hour angle is 0.000 degree, with the time before solar noon expressed as negative degrees, and the local time after solar noon expressed as positive degrees. For example, at 10:30 AM local apparent time the hour angle is -22.5 degree (15 degree per hour times 1.5 hours before noon).

Initialize solar radiation

Read radiation data

Solve soil water balance

Sort distances in increasing order

Subroutine to sort a vector of points using the Heap-sort algorithm. Data are sorted by value if flag =1, or by separation distance if flag = 0. Actually, only a pointer is sorted, as this is more efficient. Subroutine Adapted from Numerical Recipes in Fortran 90: Press, Teukolsky, Vetterling and Flannery (1996) pg. 1171

A subroutine to retrieve the nearest neighbors of the estimation location referred to as control points. The observations separation matrix is returned (as a precursor to producing the observations covariance matrix) along with the vector of nearest neighbbors.

Split a varying string into two verying strings

Split a varying string into two verying strings

Split channel network where a confluence of two different horton order channels occurs

relationship between stem biomass andDBH (Diameter at Brest Height).

Converts multiple spaces and tabs to single spaces; deletes control characters; removes initial spaces. Arguments: string String to be treated Result: String compacted

Return a string that has all characters in reverse order Arguments: string String to be reversed Result: Reversed string

Finds the first instance of a character from 'delims' in the the string 'string'. The characters before the found delimiter are output in 'before'. The characters after the found delimiter are output in 'string'. The optional output character 'sep' contains the found delimiter. Arguments: string String to be treated Result: The characters before the found delimiter, the remainder is output in string

Converts number string to a double precision real number Arguments: string String to be converted Result: double precision real number

Converts number string to a real number Arguments: string String to be converted Result: float number

It is often useful to represent a text as a list of tokens. The process of breaking a text up into its constituent tokens is known as tokenization. The subroutine parses the string in input into arguments args(1), ..., args(nargs) based on the delimiters contained in the string delims. Preceding a delimiter in string by a backslash \ makes this particular instance not a delimiter. The integer output variable nArgs contains the number of arguments found.

Converts number string to a long integer Arguments: string String to be converted Result: long integer

! Description: Return a string that has all letters in lower case Arguments: string String to be treated Result: String with letters turned into lower case

Converts number string to a short integer Arguments: string String to be converted Result: short integer

Return a string that has all letters in upper case Arguments: string String to be treated Result: String with letters turned into upper case

return true if subsection is present in section, false otherwise

Compute the sun elevation angle

transport matrix from grid_integer to netcdf format

transport matrix from netcdf format to grid_integer

transport matrix from grid_real to netcdf format

transport matrix from netcdf format to grid_real

soil water content modifier

synchronize the window in which searching for the key

Description returns lower bounding time step of a given datetime

Count the number of columns in a table stored in a collection of lines. Method: count the number of tokens included in parentheses []. Arguments: lines collections of lines Result: Return number of columns

Count the number of rowss in a table stored in a collection of lines. Method: count the number of non blank lines that have not a keyword. Arguments: lines collections of lines Result: Return number of rows

create a new table from scratch and initialize variables Arguments: tab returned table

search the file for beginning of next table defined by keyword Table Start Arguments: unit file in which operate search id optional, table id line optional, line of file to begin search Result: Return -1 when table is not found line of beginning of a table

set row content Arguments: tab returned table row column to be changed content string array to fill in row

returns a double from column defined by keyOut corresponding to valueIn contained in column defined by keyIn. Arguments: valueIn input value tab table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value match method to match input value. Possible values are: 'exact' = column must contain exact input value 'linear' = calculates linear interpolation between two bounding values 'nearest' = search for the nearest value in input column bound method to manage bounds. Possible values are: 'fixed' = extreme values are treated as a wall 'extendlinear' = extend bounds with linear interpolation of last two extreme values 'extendconstant' = extend bounds preserving extreme value constant

returns a float from column defined by keyOut corresponding to valueIn contained in column defined by keyIn. Arguments: valueIn input value tab table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value match method to match input value. Possible values are: 'exact' = column must contain exact input value 'linear' = calculates linear interpolation between two bounding values 'nearest' = search for the nearest value in input column bound method to manage bounds. Possible values are: 'fixed' = extreme values are treated as a wall 'extendlinear' = extend bounds with linear interpolation of last two extreme values 'extendconstant' = extend bounds preserving extreme value constant

returns a float from column defined by keyOut corresponding to
valueIn (string) contained in column defined by keyIn. Arguments: valueIn input value tab table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value

read a table from specified file. File is not yet open. If id is not specified, in a file containing multiple tables, the first table is read Arguments: file file in which table is contained tab returned table id optional, id of table to read

read a table from specified file unit. File is already open. Arguments: unit file in which table is contained tab returned table id optional, id of table to read

return the number of rows in a table

returns a string from column defined by keyOut corresponding to valueIn contained in column defined by keyIn. Arguments: valueIn input value tab table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value

read the content of the table. Arguments: lines collection of strings that contain table information tab table to update

read header of the columns of the table. Arguments: lines collection of strings that contain table information tab table to update

Read the Id of the table. Id is mandatory and must be unique. Arguments: lines collections of lines Result: Return Id

Read the title of the table. Title is optional. Arguments: lines collections of lines Result: Return title if exists

read unit of the columns of the table. Arguments: lines collection of strings that contain table information tab table to update

set header of a specified column Arguments: tab returned table col column to be changed header header string

set unit of a specified column Arguments: tab returned table col column to be changed unit unit string

set table id Arguments: tab returned table id table id

set number of rows and columns and allocate variables Arguments: tab returned table nrow number of rows ncol number of columns

set table title Arguments: tab returned table title table title

returns a double from column defined by keyOut corresponding to valueIn contained in column defined by keyIn. Table is identified by its id. Arguments: valueIn input value tables collection of tables to search in id id of the table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value match method to match input value. Possible values are: 'exact' = column must contain exact input value 'linear' = calculates linear interpolation between two bounding values 'nearest' = search for the nearest value in input column bound method to manage bounds. Possible values are: 'fixed' = extreme values are treated as a wall 'extendlinear' = extend bounds with linear interpolation of last two extreme values 'extendconstant' = extend bounds preserving extreme value constant

returns a float from column defined by keyOut corresponding to valueIn contained in column defined by keyIn. Table is identified by its id. Arguments: valueIn input value tables collection of tables to search in id id of the table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value match method to match input value. Possible values are: 'exact' = column must contain exact input value 'linear' = calculates linear interpolation between two bounding values 'nearest' = search for the nearest value in input column bound method to manage bounds. Possible values are: 'fixed' = extreme values are treated as a wall 'extendlinear' = extend bounds with linear interpolation of last two extreme values 'extendconstant' = extend bounds preserving extreme value constant

returns a float from column defined by keyOut corresponding to valueIn (string) contained in column defined by keyIn. Table is identified by its id. Arguments: valueIn input value tables collection of tables to search in id id of the table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value

read a collection of tables from specified file. Arguments: file file in which table is contained tables returned collection of tables

read a collection of tables from specified unit. File is already open. Arguments: unit unit of file in which table is contained tables returned collection of tables

Return a list of Ids from TableCollection Arguments: tables collections of tbles Result: Return Ids

return the number of rows of a table in a table collection

returns a string from column defined by keyOut corresponding to valueIn contained in column defined by keyIn. Table is identified by its id. Arguments: valueIn input value tables collection of tables to search in id id of the table to search in keyIn defines header of the column of the input value keyOut defines header of the column of the output value

read the lines of a table which are stored in an array of strings. Non significative lines (i.e. comments or blank lines) are ignored. Subroutine supposes that the cursor is sync to the first line after the keyword 'Table Start'. hence it is must benn called after a call to tableFileSync. Arguments: unit file in which table is contained lines returned collection of linestable

write a collection of tables on file. If id is present, only the table corresponding to that id is written. Arguments: tables collection of tables to be exported file file to whom write the table

write a collection of tables on file already open. If id is present, only the table corresponding to that id is written. Arguments: tables collection of tables to be exported iunit unit to whom write the table

returns the position of table in collection of tables identified by id. Arguments: tables collection of tables to search in id id of the table

write a table on file. Arguments: tab table to export file file to whom write the table

write a table on file taht is already open. Arguments: tab table to export iunit unit of file to whom write the table

Tab character is substituted by one blank character Arguments: string String to be processed Result: processed string

compute air temperature modifier. The growth and dormant stages of vegetation are related to the annual cycle of air temperature. Maximum growth will happen at optimal temperatures Topt and will stop when temperatures drop below or exceed certain temperature thresholds, Tmin and Tmax, respectively.

calculate the effective rainfall through canopy

Description returns time given time index

calculate the difference in seconds between two date: time1 - time2

Calculate the index to extract the corresponding slice from netcdf file.

prints the current YMDHMS date as a time stamp. Cursor remains on the same line. Example: 2008-09-29T21:00:25.624+0200

prints the current YMDHMS date as a time stamp. Example: 2008-09-29T21:00:25.624+0200 Adapted from John Burkardt

Converts the value of the current DateTime object to its equivalent string representation

Topographic index TI takes into account both a local slope geometry and site location in the landscape combining data on slope steepness S and specific catchment area As:

returns the topwidth of a triangular, rectangular or trapezoidal cross section

Converts the value of the current DateTime object to Coordinated Universal Time (UTC).

Remove trailing blanks from a varying string

Description return a vector of distinct values from a grid_integer

Compute hydraulic conductivity of partially saturated soil (m/s)

update soil moisture

returns the position (is,js) of the upstream cell and, optionally, the flow path length, considering cardinal and diagonal direction

Gets a DateTime object that is set to the current date and time on this computer, expressed as the Coordinated Universal Time (UTC).

function called by Simplex

Convert a character string to a varying string

Fit model to experimental variogram

calculation of the variogram value in 2D

returns the normal velocity (m/s) with Chezy equation

Verify a character string for occurrences of characters in a varying-string set

Verify a varying string for occurrences of characters in a character-string set

Verify a varying string for occurrences of characters in a varying-string set

compute vapor pressure deficit modifier.

return .TRUE. if wetland is flooded

returns the wetted area of a triangular, rectangular or trapezoidal cross section

returns the wetted perimeter of a triangular, rectangular or trapezoidal cross section

Initialize air temperature

Read wind speed data

This subroutine implements the method presented by Gonzalez-Longatt et al. (2015). Zonal and meridional components are computed and then orographic correction is applied. The two components are then re-composed to provide final result.

This subroutine implements the method used in the MICROMET program (see reference). Wind speed is interpolated accounting for wind direction and an empirical weigth that considers slope and curvature (topographic effect)

write data from file unit. if optional argument init is true a string to initialize data section of file is written

write metadata section to file TODO: full CRS support

write metadata section to open file unit TODO: full CRS support

compute sediment transport capacity using Yang (1973) approach (kg/s) limitation: Yang1973 equation can be applied for noncohesive natural beds with particle sizes between 0.062 mm and 2 mm, a specific gravity of 2.65 g/cm3, and a shape factor of 0.7

compute sediment transport capacity using Yang (1979) approach (kg/s) limitation: Yang1979 equation can be applied when the dimensionless unit stream power is relatively small with respect to the prevailing value of unit stream power. Used for finer suspended sediment trasnport in the Yellow River with median particle diameter of 0.067 mm.

also called zero-mean normalization. The values of attribute X are normalized using the mean and standard deviation of X. A new value new_v is obtained using the following expression: