Procedures

ProcedureLocationProcedure TypeDescription
AccGrowingDegreeDayPlantsPhenologySubroutine

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

ActualObservationsObservationalNetworksSubroutine

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

AddDaysChronosFunction

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

AddHoursChronosFunction

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

AddMinutesChronosFunction

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

AddSecondsChronosFunction

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

adjustliso_varying_stringInterface
adjustl_iso_varying_stringFunction

Adjust the varying string to the left

AdjustPTPlantsInterceptionSubroutine

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.

adjustriso_varying_stringInterface
adjustr_iso_varying_stringFunction

Adjust the varying string to the right

AGEmodPlantsModifiersFunction

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

Read more…
AirRelativeHumidityInitAirRelativeHumiditySubroutine

Initialize air relative humidity

AirRelativeHumidityReadAirRelativeHumiditySubroutine

Read air relative humidity data

AirTemperatureDailyMaxInitAirTemperatureDailyMaxSubroutine

Initialize air temperature

AirTemperatureDailyMaxReadAirTemperatureDailyMaxSubroutine

Read air temperature data

AirTemperatureDailyMeanInitAirTemperatureDailyMeanSubroutine

Initialize air temperature

AirTemperatureDailyMeanReadAirTemperatureDailyMeanSubroutine

Read air temperature data

AirTemperatureDailyMinInitAirTemperatureDailyMinSubroutine

Initialize air temperature

AirTemperatureDailyMinReadAirTemperatureDailyMinSubroutine

Read air temperature data

AirTemperatureInitAirTemperatureSubroutine
AirTemperatureReadAirTemperatureSubroutine
AparCalcPlantsFunction

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 .

Read more…
ApplyPlantsManagementPlantsManagementSubroutine

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

Read more…
AssignDataFromGridObservationalNetworksInterface
AssignDataFromGridRealObservationalNetworksSubroutine

assign data to a network from grid_real

AssignGridIntegerGridOperationsSubroutine

assign value of mask integer to mat integer

AssignGridIntegerRealGridOperationsSubroutine

assign value of mask integer to mat real

AssignGridRealGridOperationsSubroutine

assign value of mask real to mat real

AssignGridRealIntegerGridOperationsSubroutine

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

AssignIntegerGridOperationsSubroutine

assign value to mat

ASSIGNMENT( = )ChronosInterface
ASSIGNMENT( = )GeoLibInterface
ASSIGNMENT(=)GridOperationsInterface
assignment(=)iso_varying_stringInterface
AssignRealGridOperationsSubroutine

assign value to mat

BarnesOISpatialInterpolationSubroutine

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.

Read more…
BasinAreaMorphologySubroutine

compute basin area (m2)

BasinCumulateBasinAverageSubroutine

cumulate variable along stream network

BasinDelineateMorphologySubroutine

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

BasinMaskMorphologySubroutine

search for cells included in the river basin

BasinRasterExportBasinAverageSubroutine

delineate and export basin mask

BearingAngleGeoLibFunction

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.

Read more…
BetaRoutingModelsFunction

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

Read more…
BuildReachNetworkRiverDrainageSubroutine

Build reaches that compose the river network

CanopyCoverPlantsAllometricsFunction

compute canopy cover (0-1)

Read more…
CastShadowSolarRadiationSubroutine

Compute shadow grid

CatchLogLibSubroutine

exception handler

CelerityRoutingModelsFunction

returns the celerity (m/s)

Read more…
CellAreaGridOperationsInterface
CellAreaFloatGridOperationsFunction

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

Read more…
CellAreaIntegerGridOperationsFunction

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

Read more…
CellIsNoDataGridOperationsInterface
CellIsNoDataFloatGridOperationsFunction

return true if cell of grid_real contains no data value

CellIsNoDataIntegerGridOperationsFunction

returns true if cell of grid_integer contains no data value

CellIsSpringMorphologyFunction

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

CellIsValidGridOperationsInterface
CellIsValidFloatGridOperationsFunction

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

CellIsValidIntegerGridOperationsFunction

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

CellLengthGridOperationsInterface
CellLengthFloatGridOperationsFunction

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

CellLengthIntegerGridOperationsFunction

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

CentroidMorphologyInterface
CentroidGridIntegerMorphologySubroutine

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

CentroidGridRealMorphologySubroutine

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

ChannelDetachmentRateSedimentFunction

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

Read more…
ChannelInitiationRiverDrainageSubroutine

Define channel cells. Two methods are possible:

Read more…
chariso_varying_stringInterface
char_autoiso_varying_stringFunction

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

char_fixediso_varying_stringFunction

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

CheckClosureIniLibSubroutine

check if section and subsection still opened

CheckIdTableLibSubroutine
CheckOutletMorphologyFunction

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.

CheckSpecificPropertiesEvapotranspirationSubroutine

check properties for each ET model

CO2modPlantsModifiersFunction

compute CO22 modifier.

Read more…
ComputeNetRadiationSolarRadiationSubroutine

Compute net radiation

Read more…
ComputeSlopeFactorSedimentSubroutine
ComputeSpatialAverageBalanceSpatialAverageSubroutine

Compute spatial average of soil water balance variables

ComputeSpatialAverageCanopySpatialAverageSubroutine

Compute spatial average of canopy interception variables

ComputeSpatialAverageGlaciersSpatialAverageSubroutine

Compute spatial average of glaciers variables

ComputeSpatialAverageMeteoSpatialAverageSubroutine

Compute spatial average of meteorological variables

ComputeSpatialAveragePlantsSpatialAverageSubroutine

Compute spatial average of plants variables

ComputeSpatialAverageSedimentSpatialAverageSubroutine

Compute spatial average of sediment variables

ComputeSpatialAverageSnowSpatialAverageSubroutine

Compute spatial average of snow variables

ConfigureExtentsSpatialAverageSubroutine

Configure extents for computing and storing spatial average values

ConfluenceIsAroundMorphologySubroutine

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.

ConvertGeoLibSubroutine

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.

ConvertGaussBoagaToGeodeticGeoLibSubroutine

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

ConvertGeodeticToGaussBoagaGeoLibSubroutine

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

ConvertGeodeticToHotineGeoLibSubroutine

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

ConvertGeodeticToSwissGeoLibSubroutine

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

Read more…
ConvertGeodeticToTransverseMercatorGeoLibSubroutine

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.

ConvertGeodeticToUTMGeoLibSubroutine

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

ConvertHotineToGeodeticGeoLibSubroutine

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

ConvertSwissToGeodeticGeoLibSubroutine

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

Read more…
ConvertTransverseMercatorToGeodeticGeoLibSubroutine

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.

ConvertUTMtoGeodeticGeoLibSubroutine

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.

CopyChronosSubroutine

Create an exact copy of DateTime

CopyCRSGeoLibSubroutine

copy the content of a CRS variable in another CRS variable

CopyDatumGeoLibSubroutine

Create an exact copy of a datum.

CopyEllipsoidGeoLibSubroutine

Create an exact copy of an ellipsoid.

CopyNetworkObservationalNetworksSubroutine

make a copy of one observational network

CountCellsGridStatisticsInterface
CountCellsFloatGridStatisticsFunction

count number of cells different from nodata

CountCellsIntegerGridStatisticsFunction

count number of cells different from nodata

CountReservoirsReservoirsFunction

count number of reservoirs in a list

CovarianceKrigingSubroutine

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

Covariance2DKrigingSubroutine

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

CriticalVelocitySedimentFunction

compute critical velocity for incipient motion (m/s)

Read more…
CronIsTimeCronScheduleFunction

returns true if it is time to start a process

CronNextTimeCronScheduleFunction

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

CronParseStringCronScheduleSubroutine

parse cron string

CrownDiameterPlantsAllometricsFunction

compute crown doameter (m)

Read more…
CRSisEqualGeoLibFunction

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

CRSisEqualGridOperationsInterface
CRSisEqualFloatFloatGridOperationsFunction

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.

CRSisEqualFloatIntGridOperationsFunction

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.

CRSisEqualIntFloatGridOperationsFunction

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.

CRSisEqualIntIntGridOperationsFunction

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.

CurrentDirFileSysFunction

return current directory

CurvatureMicroMetMorphologySubroutine

Calculate curvature according to method implemented in MICROMET

Read more…
DateCheckChronosSubroutine

check that date do not contain errors.

DateTimeIsDefaultChronosFunction

Check if datetime is set to default

DatumIsEqualGeoLibFunction

return .TRUE. if the two datums are equal

DayOfYearChronosFunction

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

DaysInMonthChronosFunction

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

DBHDCeffPlantsAllometricsFunction

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

DBHvsStemBiomassPlantsAllometricsFunction

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

Read more…
DecodeEPSGGeoLibFunction

get EPSG code as input and set coordinate reference system

DegreeDaySnowFunction

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

DepthFromAreaRoutingModelsFunction

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

Read more…
DepthToDivSoilPropertiesFunction

Return which division corresponds to given depth

DeriveAspectMorphologySubroutine

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:

Read more…
DeriveCurvatureMorphologySubroutine

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:

Read more…
DeriveSlopeMorphologySubroutine

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.

Read more…
DestroyNetworkObservationalNetworksSubroutine

deallocate space

DirDeleteFileSysSubroutine

delete a directory

DirectionAngleGeoLibFunction

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.

Read more…
DirExistsFileSysFunction

returns TRUE if directory exists

DirListFileSysSubroutine

return a list of files in a directory

DirNewFileSysSubroutine

create a new directory

DirRenameFileSysSubroutine

rename a directory

DischargeRoutingModelsFunction

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

Read more…
DischargePointExportDischargeRoutingSubroutine

Export of point site data

DischargePointInitDischargeRoutingSubroutine

Initialize export of point site data

DischargeRouteDischargeRoutingSubroutine

route discharge in surface network

DistanceGeoLibFunction

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

DistMatrixKrigingSubroutine

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.

DivertFlowRoutingModelsSubroutine

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

DomainInitDomainPropertiesSubroutine

Load domain properties

DoubleToStringStringManipulationFunction

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

DownstreamCellMorphologySubroutine

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

DrainageDensityMorphologyFunction

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.

EllipsoidIsEqualGeoLibFunction

return .TRUE. if the two ellipsoids are equal

EqualityChronosFunction

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

etEnergyBalanceGroundEvapotranspirationSubroutine

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

ETinitEvapotranspirationSubroutine

Initialize evapotranspiration computation

ExportBasinAverageBasinAverageSubroutine

Export basin averaged values

ExportGridGridLibInterface
ExportGridFloatToESRI_ASCIIGridLibSubroutine

export grid_real to a ESRI ASCII file.

ExportGridFloatToESRI_BINARYGridLibSubroutine

export grid_real to a ESRI BINARY file.

ExportGridFloatToFileGridLibSubroutine

export grid_real to file. List of supported format:

Read more…
ExportGridFloatToNetCDFGridLibSubroutine

export grid into netcdf file. Two actions are possible:

Read more…
ExportGridIntegerToESRI_ASCIIGridLibSubroutine

export grid_integer to a ESRI ASCII file.

ExportGridIntegerToESRI_BINARYGridLibSubroutine

export grid_integer to a ESRI BINARY file.

ExportGridIntegerToFileGridLibSubroutine

export grid_integer to file. List of supported format:

Read more…
ExportGridIntegerToNetCDFGridLibSubroutine

export grid into netcdf file. Two actions are possible:

Read more…
ExportMapsRasterExportSubroutine

Update and export maps

ExportReachesRiverDrainageSubroutine

Export reaches on file

ExportShapeRiverDrainageSubroutine

export shape file of river network

Read more…
ExportSpatialAverageBalanceSpatialAverageSubroutine

Export spatial average of soil balance variables

ExportSpatialAverageCanopySpatialAverageSubroutine

Export spatial average of canopy interception variables

ExportSpatialAverageGlaciersSpatialAverageSubroutine

Export spatial average of glaciers variables

ExportSpatialAverageMeteoSpatialAverageSubroutine

Export spatial average of meteorological variables

ExportSpatialAveragePlantsSpatialAverageSubroutine

Export spatial average of plants variables

ExportSpatialAverageSedimentSpatialAverageSubroutine

Export spatial average of sediment variables

ExportSpatialAverageSnowSpatialAverageSubroutine

Export spatial average of snow variables

extractiso_varying_stringInterface
extract_CHiso_varying_stringFunction

Extract a varying substring from a character string

extract_VSiso_varying_stringFunction

Extract a varying substring from a varying string

ExtractBorderGridOperationsInterface
ExtractBorderFloatGridOperationsSubroutine

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.

ExtractBorderIntegerGridOperationsSubroutine

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.

FallVelocitySedimentFunction

compute fall velocity of sediment (m/s)

Read more…
FAO56PenmanMonteithEvapotranspirationSubroutine

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."

Read more…
FconvKrigingFunction

function called by Simplex

FileDeleteFileSysSubroutine

delete a file

FileExistsFileSysFunction

returns TRUE if file exists

FileNewFileSysSubroutine

create a new text file

FileRenameFileSysSubroutine

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

FloatToStringStringManipulationFunction

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

FlowAccumulationMorphologySubroutine

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

FluxRichardsSubroutine

Gets flux and partial derivs for specified flow path.

FocompuKrigingSubroutine

evaluation of the objective function

ForestToGridPlantsSubroutine

fill in a grid with state variable values in forest stands

GeodeticShiftFromWGS84GeoLibSubroutine

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

GeodeticShiftToWGS84GeoLibSubroutine

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

GeoInitGeoLibSubroutine

Initialize parameters for conversion

getiso_varying_stringInterface
get_iso_varying_stringSubroutine

Read from the default unit into a varying string

get_set_CHiso_varying_stringSubroutine

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

get_set_VSiso_varying_stringSubroutine

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

get_unitiso_varying_stringSubroutine

Read from the specified unit into a varying string

get_unit_set_CHiso_varying_stringSubroutine

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

get_unit_set_VSiso_varying_stringSubroutine

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

GetAreaGridOperationsInterface
GetAreaOfGridFloatGridOperationsFunction

Description compute area (m2) of grid excluding nodata

GetAreaOfGridIntegerGridOperationsFunction
GetBiasGridStatisticsInterface
GetBiasFloatGridStatisticsFunction

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

GetCVGridStatisticsInterface
GetCVofGridFloatGridStatisticsFunction

compute coefficient of variation of grid_real eventually constrained to a mask

GetDayChronosFunction

Gets the day of the datetime represented by this instance

GetDayOfWeekChronosFunction

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

Read more…
GetDiversionByIdDiversionsFunction

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

GetDtGridGridLibFunction
GetFirstDateGridLibFunction

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

GetFluxesRichardsSubroutine
GetGeoreferenceFromNCdataSetGridLibSubroutine

read and calculate georeferencing informations from netCDF file.

GetGridMappingGridLibInterface
GetGridMappingFloatGridLibFunction

get grid mapping for a floating point grid

GetGridMappingIntegerGridLibFunction

get grid mapping for a floating point grid

GetHourChronosFunction

Gets the month of the datetime represented by this instance

GetIJGridOperationsInterface
GetIJfloatGridOperationsSubroutine

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

GetIJintegerGridOperationsSubroutine

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

GetMaxGridStatisticsInterface
GetMaxOfGridFloatGridStatisticsFunction

compute maximum of grid_real eventually constrained to a mask

GetMaxOfGridIntegerGridStatisticsFunction

compute maximum of grid_integer eventually constrained to a mask

GetMeanGridStatisticsInterface
GetMeanFloatStatisticsFunction

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

GetMeanOfGridFloatGridStatisticsFunction

compute mean of grid_real eventually constrained to a mask

GetMeanOfGridIntegerGridStatisticsFunction

compute mean of grid_integer eventually constrained to a mask

GetMeanVectorStatisticsInterface
GetMinGridStatisticsInterface
GetMinOfGridFloatGridStatisticsFunction

compute minimum of grid_real eventually constrained to a mask

GetMinOfGridIntegerGridStatisticsFunction

compute minimum of grid_integer eventually constrained to a mask

GetMinuteChronosFunction

Gets the minute of the datetime represented by this instance

GetMonthChronosFunction

Gets the month of the datetime represented by this instance

GetNofSectionsIniLibFunction

count sections in a ini db

GetNofSubSectionsIniLibFunction

return number of subsections within a section of a ini db

GetNSEGridStatisticsInterface
GetNSEfloatGridStatisticsFunction

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

Read more…
GetOSFileSysFunction

get operating system

GetPosPlantsManagementFunction

return the position in practices array given practice id

getqaRichardsSubroutine
GetR2GridStatisticsInterface
GetR2floatGridStatisticsFunction

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

Read more…
GetReservoirByIdReservoirsFunction

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

GetRMSEGridStatisticsInterface
GetRMSEfloatGridStatisticsFunction

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

GetSecondChronosFunction

Gets the second of the datetime represented by this instance

GetStDevGridStatisticsInterface
GetStDevOfGridFloatGridStatisticsFunction

compute unbiased standard deviation of grid_real optionally constrained to a mask

GetStDevOfGridIntegerGridStatisticsFunction

compute unbiased standard deviation of grid_integer optionally constrained to a mask

GetSumGridStatisticsInterface
GetSumOfGridFloatGridStatisticsFunction

compute sum of grid_real eventually constrained to a mask

GetSumOfGridIntegerGridStatisticsFunction

compute sum of grid_integer eventually constrained to a mask

GetTimeStepsGridLibInterface
GetTimeStepsFromFileGridLibFunction

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

GetTimeStepsFromNCidGridLibFunction

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

GetTimeZoneChronosFunction

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

GetUnitLogLibFunction

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

GetUnitUtilitiesFunction

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

GetXYGridOperationsInterface
GetXYfloatGridOperationsSubroutine

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

GetXYintegerGridOperationsSubroutine

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

GetXYSizesFromFileGridLibSubroutine

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

GetYearChronosFunction

Gets the year of the datetime represented by this instance

GlacierInitGlacierSubroutine

Initialize glacier model

GlacierParameterUpdateGlacierSubroutine

update parameter map that change in time

GlacierPointExportGlacierSubroutine

Export of point site data

GlacierPointInitGlacierSubroutine

Initialize export of point site data

GlacierUpdateGlacierSubroutine

compute accumulation and ablation and update water equivalent

GreaterThanChronosFunction

return true if time1 is greater than time2

GreaterThanOrEqualChronosFunction

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

GreenAmptInfiltrationFunction

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

Read more…
Grid2vectorGridOperationsInterface
Grid2vectorFloatGridOperationsSubroutine

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

Grid2vectorIntegerGridOperationsSubroutine

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

GridByIniGridOperationsInterface
GridByIniFloatGridOperationsSubroutine

read a grid_real using information stored in ini configuration file

GridByIniFloatSubSectionGridOperationsSubroutine

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

GridByIniIntegerGridOperationsSubroutine

read a grid_integer using information stored in ini configuration file

GridByIniIntegerSubSectionGridOperationsSubroutine

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

GridConvertGridOperationsInterface
GridConvertFloatGridOperationsSubroutine

coordinate conversion of a grid_real definition of corner points:

Read more…
GridConvertIntegerGridOperationsSubroutine

coordinate conversion of a grid_integer definition of corner points:

Read more…
GridDestroyGridLibInterface
GridDestroyFloatGridLibSubroutine

deallocate float grid

GridDestroyIntegerGridLibSubroutine

deallocate integer grid

GridResampleGridOperationsInterface
GridShiftGridOperationsInterface
GroundwaterInitGroundwaterSubroutine

Initialize groundwater

GroundwaterOutputGroundwaterSubroutine
GroundwaterOutputInitGroundwaterSubroutine

Initialize files for exporting output results

GroundwaterParameterUpdateGroundwaterSubroutine

update boundary condition map that change in time

GroundwaterPointExportGroundwaterSubroutine

Export of point site data

GroundwaterPointInitGroundwaterSubroutine

Initialize export of point site data

GroundwaterRiverInitGroundwaterSubroutine

Configure river-groundwater interaction

GroundwaterRiverUpdateGroundwaterSubroutine

Update river-groundwater exchange fluxes

GroundwaterUpdateGroundwaterSubroutine

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

Read more…
GrowDBHPlantsSubroutine

update DBH and height tree every new year

GrowDBHech2oPlantsSubroutine

update DBH and height tree according to ech2o model by Maneta

GrowLeafPlantsSubroutine

update leaf biomass and leaf area index

Read more…
HargreavesSamaniEvapotranspirationSubroutine

Compute potential evapotranspiration with Hargreaves Samani model at daily time scale

Read more…
HargreavesSamaniModifiedEvapotranspirationSubroutine

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

Read more…
HeightVsDBHPlantsAllometricsFunction

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

Read more…
HortonOrdersMorphologySubroutine

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

HyofhRichardsSubroutine

Get soil water variables from h

HyofSRichardsSubroutine

Get soil water variables from saturation S (where S<1)

iachariso_varying_stringInterface
iachar_iso_varying_stringFunction

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

ichariso_varying_stringInterface
ichar_iso_varying_stringFunction

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

IDWSpatialInterpolationSubroutine

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

Read more…
indexiso_varying_stringInterface
index_CH_VSiso_varying_stringFunction

Get the index of a varying substring within a character string

index_VS_CHiso_varying_stringFunction

Get the index of a character substring within a varying string

index_VS_VSiso_varying_stringFunction

Get the index of a varying substring within a varying string

InequalityChronosFunction

return true if time1 is different from time2

InfiltrationInitInfiltrationSubroutine

Initialize evapotranspiration computation

IniAddLineIniLibSubroutine

add a new Key-Val pair

IniCloseIniLibSubroutine

close a ini file

IniCountKeysIniLibFunction

count Key-Val pair in a file

IniOpenIniLibInterface
IniOpenFileNameIniLibSubroutine

open and read a ini file

IniOpenFileUnitIniLibSubroutine

read a ini file already open

IniReadDoubleIniLibFunction

read an double precision number corresponding to Key

IniReadIntIniLibFunction

read an integer corresponding to Key

IniReadLogicalIniLibFunction

read a logical value corresponding to Key

iniReadRealIniLibFunction

read a real number corresponding to Key

IniReadStringIniLibFunction

read a string corresponding to Key

InitBasinAverageBasinAverageSubroutine

Initialization of basin average

InitDischargeRoutingDischargeRoutingSubroutine

Initialize surface routing

InitDiversionsDiversionsSubroutine

Initialize diversions

InitRasterExportRasterExportSubroutine

Initialization of raster export

InitReservoirsReservoirsSubroutine

Initialize reservoirs

InitSoilBalanceSoilBalanceSubroutine

Initialize soil water balance

InitSpatialAverageBalanceSpatialAverageSubroutine

Initialization of spatial average of soil balance variables

InitSpatialAverageCanopySpatialAverageSubroutine

Initialization of spatial average of canopy interception variables

InitSpatialAverageGlaciersSpatialAverageSubroutine

Initialization of spatial average of glaciers variables

InitSpatialAverageMeteoSpatialAverageSubroutine

Initialization of spatial average of meteorological variables

InitSpatialAveragePlantsSpatialAverageSubroutine

Initialization of spatial average of plants dynamic variables

InitSpatialAverageSedimentSpatialAverageSubroutine

Initialization of spatial average of sediment variables

InitSpatialAverageSnowSpatialAverageSubroutine

Initialization of spatial average of snow variables

insertiso_varying_stringInterface
insert_CH_CHiso_varying_stringFunction

Insert a character substring into a character string

insert_CH_VSiso_varying_stringFunction

Insert a varying substring into a character string

insert_VS_CHiso_varying_stringFunction

Insert a character substring into a varying string

insert_VS_VSiso_varying_stringFunction

Insert a varying substring into a varying string

InterceptionInitPlantsInterceptionSubroutine

initialize variables for computing rainfall interception

InterpolateKrigingSubroutine

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

InterpolateMeteoUtilitiesSubroutine

interpolate site data to space

InterrillDetachmentRateSedimentSubroutine

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.

Read more…
inverseSpatialInterpolationSubroutine

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

Read more…
IrrigationConfigIrrigationSubroutine

configure irrigation

IrrigationUpdateIrrigationSubroutine

update irrigation and write output

IsLeapYearChronosFunction

Returns true if the specified year is a leap year

Read more…
isosubRichardsSubroutine

Subroutine to get adsorbed solute (units/g soil) from concn in soil water according to chosen isotherm code ("Fr" for Freundlich, "La" for Langmuir and "Ll" for Langmuir-linear).

IsOutOfGridGridOperationsInterface
IsOutOfGridFloatGridOperationsFunction

calculates if cell is out of grid space limits

IsOutOfGridIntegerGridOperationsFunction

calculates if cell is out of grid space limits

IsUTCChronosFunction

Returns true if datetime object is expressed in UTC

KcUpdateEvapotranspirationSubroutine

read new Kc values

KeepLinesFileSysSubroutine

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.

KeyIsPresentIniLibFunction

return true if key is present, false otherwise

KillPlantsPlantsMortalitySubroutine

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:

Read more…
KrigeKrigingSubroutine

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

Read more…
KrigingInitializeKrigingSubroutine

Initialize variables for kriging

leniso_varying_stringInterface
len_iso_varying_stringFunction

Get the length of a varying string

len_trimiso_varying_stringInterface
len_trim_iso_varying_stringFunction

Get the trimmed length of a varying string

LessThanChronosFunction

return true if time1 is less than time2

LessThanOrEqualChronosFunction

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

LevelPoolRoutingModelsSubroutine

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

lgeiso_varying_stringInterface
lge_CH_VSiso_varying_stringFunction

Compare (LGE) a character string and a varying string

lge_VS_CHiso_varying_stringFunction

Compare (LGE) a varying string and a character string

lge_VS_VSiso_varying_stringFunction

Compare (LGE) two varying strings

lgtiso_varying_stringInterface
lgt_CH_VSiso_varying_stringFunction

Compare (LGT) a character string and a varying string

lgt_VS_CHiso_varying_stringFunction

Compare (LGT) a varying string and a character string

lgt_VS_VSiso_varying_stringFunction

Compare (LGT) two varying strings

LinearInterpUtilitiesInterface
LinearInterpFloatDoubleUtilitiesFunction

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

LinearInterpFloatFloatUtilitiesFunction

calculates linear interpolation between real numbers.

LinearInterpIntFloatUtilitiesFunction

calculates linear interpolation between integer numbers with output real.

LinearRegressionSlopeStatisticsFunction

compute slope of linear regression between vector x and y

lleiso_varying_stringInterface
lle_CH_VSiso_varying_stringFunction

Compare (LLE) a character string and a varying string

lle_VS_CHiso_varying_stringFunction

Compare (LLE) a varying string and a character string

lle_VS_VSiso_varying_stringFunction

Compare (LLE) two varying strings

lltiso_varying_stringInterface
llt_CH_VSiso_varying_stringFunction

Compare (LLT) a character string and a varying string

llt_VS_CHiso_varying_stringFunction

Compare (LLT) a varying string and a character string

llt_VS_VSiso_varying_stringFunction

Compare (LLT) two varying strings

LogInitLogLibSubroutine

initialize global parameters

LogMsgLogLibSubroutine

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

LogStopLogLibSubroutine

stop logging. If open, close the log file

LongestFlowLengthMorphologyFunction

compute longest flow length (m)

LongestFlowPathSlopeMorphologyFunction

compute slope of longest flow path (m/m)

LongToStringStringManipulationFunction

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

MarkOrderBeginningRiverDrainageSubroutine

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

MatinvKrigingSubroutine

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.

Read more…
MeridionalDistanceGeoLibFunction

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

Read more…
MeteoInitMeteoSubroutine

Initialize meteorological forcings

MeteoPointExportMeteoSubroutine

Export of point site data

MeteoPointInitMeteoSubroutine

Initialize export of point site data

MeteoReadMeteoSubroutine

Read meteorological forcings

MinMaxNormalizationGridStatisticsInterface
MinMaxNormalizationFloatGridStatisticsSubroutine

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:

Read more…
MolodenskyShiftGeoLibSubroutine

shifts geodetic coordinates using the Molodensky method

MorphologyInitMorphologicalPropertiesSubroutine

Initialize morphological properties

MuskingumCungeRoutingModelsSubroutine

Solve Muskingum-Cunge equation.

Read more…
MuskingumCungeTodiniRoutingModelsSubroutine

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

Read more…
ncErrorHandlerGridLibSubroutine

Handle errors from netcdf related operation

NearestNeighborSpatialInterpolationSubroutine

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

Read more…
NewGridGridLibInterface
NewGridFloatAsGridFloatGridLibSubroutine

create a new grid_real using an existing grid_real as template

NewGridFloatAsGridIntegerGridLibSubroutine

create a new grid_real using an existing grid_integer as template

NewGridFloatFromESRI_ASCIIGridLibSubroutine
NewGridFloatFromESRI_BINARYGridLibSubroutine

read a float grid from a ESRI BINARY file.

NewGridFloatFromFileGridLibSubroutine

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

NewGridFloatFromNetCDFGridLibSubroutine

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.

NewGridIntegerAsGridFloatGridLibSubroutine

create a new grid_integer using an existing grid_real as template

NewGridIntegerAsGridIntegerGridLibSubroutine

create a new grid_integer using an existing grid_integer as template

NewGridIntegerFromESRI_ASCIIGridLibSubroutine

read a integer grid from a ESRI ASCII file.

NewGridIntegerFromESRI_BINARYGridLibSubroutine

read a integer grid from a ESRI BINARY file.

NewGridIntegerFromFileGridLibSubroutine

read a grid from a file.

Read more…
NewGridIntegerFromNetCDFGridLibSubroutine

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.

NextTimeGridLibFunction

Description returns the time of the next grid in netcdf dataset

NormalDepthRoutingModelsFunction

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

Read more…
NowChronosFunction

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

NuGeoLibFunction

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

OffsetMeteoUtilitiesSubroutine

apply offset to a grid_real

op_assign_CH_VSiso_varying_stringSubroutine

Assign a varying string to a character string

op_assign_VS_CHiso_varying_stringSubroutine

Assign a character string to a varying string

op_concat_CH_VSiso_varying_stringFunction

Concatenate a character string and a varying string

op_concat_VS_CHiso_varying_stringFunction

Concatenate a varying string and a character string

op_concat_VS_VSiso_varying_stringFunction

Concatenate two varying strings

op_eq_CH_VSiso_varying_stringFunction

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

op_eq_VS_CHiso_varying_stringFunction

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

op_eq_VS_VSiso_varying_stringFunction

Compare (==) two varying strings

op_ge_CH_VSiso_varying_stringFunction

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

op_ge_VS_CHiso_varying_stringFunction

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

op_ge_VS_VSiso_varying_stringFunction

Compare (>=) two varying strings

op_gt_CH_VSiso_varying_stringFunction

Compare (>) a character string and a varying string

op_gt_VS_CHiso_varying_stringFunction

Compare (>) a varying string and a character string

op_gt_VS_VSiso_varying_stringFunction

Compare (>) two varying strings

op_le_CH_VSiso_varying_stringFunction

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

op_le_VS_CHiso_varying_stringFunction

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

op_le_VS_VSiso_varying_stringFunction

Compare (<=) two varying strings

op_lt_CH_VSiso_varying_stringFunction

Compare (<) a character string and a varying string

op_lt_VS_CHiso_varying_stringFunction

Compare (<) a varying string and a character string

op_lt_VS_VSiso_varying_stringFunction

Compare (<) two varying strings

op_ne_CH_VSiso_varying_stringFunction

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

op_ne_VS_CHiso_varying_stringFunction

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

op_ne_VS_VSiso_varying_stringFunction

Compare (/=) two varying strings

OPERATOR ( + )ChronosInterface
OPERATOR ( - )ChronosInterface
OPERATOR ( /= )ChronosInterface
OPERATOR ( < )ChronosInterface
OPERATOR ( <= )ChronosInterface
OPERATOR ( == )ChronosInterface
OPERATOR ( > )ChronosInterface
OPERATOR ( >= )ChronosInterface
OPERATOR (==)GeoLibInterface
operator(//)iso_varying_stringInterface
operator(/=)iso_varying_stringInterface
operator(<)iso_varying_stringInterface
operator(<=)iso_varying_stringInterface
operator(==)iso_varying_stringInterface
operator(>)iso_varying_stringInterface
operator(>=)iso_varying_stringInterface
OpticalDepthSolarRadiationFunction

Compute tthe atmospheric optical depth

Read more…
OutDiversionsDiversionsSubroutine

write results on files

OutDiversionsInitDiversionsSubroutine

initialise files for output

OutReservoirsReservoirsSubroutine

write results on files

OutReservoirsInitReservoirsSubroutine

initialise files for output

PairDirectionKrigingSubroutine

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

PairDistanceKrigingSubroutine

Compute distance between pairs

ParseChronosSubroutine

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

ParseTimeGridLibSubroutine

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

PenmanMonteithEvapotranspirationSubroutine

Compute potential evapotranspiration with Penman-Monteith model

Read more…
PercolationAndCapriseSoilBalanceSubroutine

compute percolation and capilalry rise

PerimeterMorphologyFunction

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

PETupdateEvapotranspirationSubroutine

Compute potential evapotranspiration

PhilipInfiltrationFunction

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

Read more…
PlantsConfigPlantsSubroutine

Initialize Plants module

PlantsGrowPlantsSubroutine

Update plants state variables

PlantsParameterUpdatePlantsSubroutine

update parameter map that change in time

PrecipitationDailyInitPrecipitationDailySubroutine

Initialize precipitation

PrecipitationDailyReadPrecipitationDailySubroutine

Read precipitation data

PrecipitationInitPrecipitationSubroutine

Initialize precipitation

PrecipitationReadPrecipitationSubroutine

Read precipitation data

PriestleyTaylorEvapotranspirationSubroutine

Compute potential evapotranspiration with Priestley-Taylor model

Read more…
PsiSoilPropertiesFunction

Compute matric potential (m)

putiso_varying_stringInterface
put_CHiso_varying_stringSubroutine

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

put_lineiso_varying_stringInterface
put_line_CHiso_varying_stringSubroutine

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

put_line_unit_CHiso_varying_stringSubroutine

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

put_line_unit_VSiso_varying_stringSubroutine

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

put_line_VSiso_varying_stringSubroutine

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

put_unit_CHiso_varying_stringSubroutine

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

put_unit_VSiso_varying_stringSubroutine

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

put_VSiso_varying_stringSubroutine

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

ReadDataObservationalNetworksInterface
ReadDataFileUnitObservationalNetworksSubroutine

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)

ReadFieldMeteoUtilitiesSubroutine

read a time varying field from a netcdf file

ReadHydroNetworkHydroNetworkInterface
ReadMetadataObservationalNetworksInterface
ReadMetadataFileNameObservationalNetworksSubroutine

read metadata section from file

ReadMetadataFileUnitObservationalNetworksSubroutine

read metadata section from open unit

ReadNetworkGroundwaterHydroNetworkSubroutine

Read network for groundwater-surface interaction from file

ReadNetworkSedimentHydroNetworkSubroutine

Read network for sediment routing from file

ReadNetworkSurfaceFlowHydroNetworkSubroutine

Read network for surface flow routing from file

ReadPointFileBasinAverageBasinAverageSubroutine

Read point file

ReadReservoirStageReservoirsSubroutine

Read stage of reservoirs from a file

ReadSoilTypesInfiltrationSubroutine

read soil types from external file

ReadSpeciesPlantsSubroutine

read species parameters

removeiso_varying_stringInterface
remove_CHiso_varying_stringFunction

Remove a substring from a character string

remove_VSiso_varying_stringFunction

Remove a substring from a varying string

repeatiso_varying_stringInterface
repeat_iso_varying_stringFunction

Concatenate several copies of a varying string

replaceiso_varying_stringInterface
replace_CH_CH_autoiso_varying_stringFunction

Replace part of a character string with a character substring

replace_CH_CH_CH_targetiso_varying_stringFunction

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_CH_CH_fixediso_varying_stringFunction

Replace part of a character string with a character substring

replace_CH_CH_VS_targetiso_varying_stringFunction

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

replace_CH_VS_autoiso_varying_stringFunction

Replace part of a character string with a varying substring

replace_CH_VS_CH_targetiso_varying_stringFunction

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

replace_CH_VS_fixediso_varying_stringFunction

Replace part of a character string with a varying substring

replace_CH_VS_VS_targetiso_varying_stringFunction

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

replace_VS_CH_autoiso_varying_stringFunction

Replace part of a varying string with a character substring

replace_VS_CH_CH_targetiso_varying_stringFunction

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

replace_VS_CH_fixediso_varying_stringFunction

Replace part of a varying string with a character substring

replace_VS_CH_VS_targetiso_varying_stringFunction

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

replace_VS_VS_autoiso_varying_stringFunction

Replace part of a varying string with a varying substring

replace_VS_VS_CH_targetiso_varying_stringFunction

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

replace_VS_VS_fixediso_varying_stringFunction

Replace part of a varying string with a varying substring

replace_VS_VS_VS_targetiso_varying_stringFunction

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

ReplaceCharStringManipulationFunction

char is replaced with rep

ResampleFloatGridOperationsSubroutine

Fill in a grid with a different cellsize from input grid. Both input grid and output grid exist.

ResampleFloatCellGridOperationsSubroutine

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

ResampleIntegerGridOperationsSubroutine

Fill in a grid with a different cellsize from input grid. Both input grid and output grid exist.

ResampleIntegerCellGridOperationsSubroutine

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

RhoGeoLibFunction

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

RungeKuttaRoutingModelsFunction

solve mass continuity of reservoir using runge kutta method

Read more…
Sat2scnInfiltrationSubroutine

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

SaveHotStartFestSubroutine

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

Read more…
ScaleMeteoUtilitiesSubroutine

apply scale factor to a grid_real

scaniso_varying_stringInterface
scan_CH_VSiso_varying_stringFunction

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

scan_VS_CHiso_varying_stringFunction

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

scan_VS_VSiso_varying_stringFunction

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

ScanDatumGeoLibFunction

return datum numeric code given a string

ScanTimeStringAsStringGridLibSubroutine

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

Read more…
SCScurveNumberInfiltrationFunction

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

Read more…
SearchDatumByCodeGeoLibSubroutine

Search for datum parameters using a code.

SearchEllipsoidByCodeGeoLibSubroutine

Search for ellipsoid parameters using a code.

SecondOfYearChronosFunction

Gets the second of the year represented by this instance.

SecondsToEndChronosFunction

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

SectionIsPresentIniLibFunction

return true if section is present, false otherwise

SedimentInitSedimentSubroutine

Initialize sediment related variables

SedimentRoutingSedimentSubroutine

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

Read more…
SemivariogramKrigingSubroutine

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.

Read more…
SeparationKrigingSubroutine

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

SetCoordGeoLibSubroutine

assign easting and northing coordinates

SetCRSGeoLibInterface
SetCRScoordGeoLibSubroutine

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

SetCRSsystemGeoLibSubroutine

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

SetCurrentTimeGridLibInterface
SetCurrentTimeFloatGridLibSubroutine

set the current time of a float grid

SetCurrentTimeIntegerGridLibSubroutine

set the current time of a integer grid

SetDailyArrayDiversionsFunction

populate array of daily values

SetDailyArrayIrrigationFunction

populate array of daily values

SetDailyArrayReservoirsFunction

populate array of daily values

SetDayChronosSubroutine

Set the day of the datetime represented by this instance

SetEsriPeStringGridLibInterface
SetEsriPeStringFloatGridLibSubroutine

set the esri pe string of a float grid

SetEsriPeStringIntegerGridLibSubroutine

set the esri pe string of a integer grid

SetFlowDirectionConventionMorphologySubroutine

Set flow direction convention:

Read more…
SetGaussBoagaParametersGeoLibInterface
SetGaussBoagaparametersCoordGeoLibSubroutine

Set parameters for Gauss Boaga reference system

SetGaussBoagaparametersSystemGeoLibSubroutine

Set parameters for Gauss Boaga reference system

SetGeodeticParametersGeoLibInterface
SetGeodeticParametersCoordGeoLibSubroutine

Set parameters for Geodetic reference system

Read more…
SetGeodeticParametersSystemGeoLibSubroutine

Set parameters for Geodetic reference system

Read more…
SetHotineParametersGeoLibInterface
SetHotineParametersCoordGeoLibSubroutine

Set parameters for Hotine Oblique Mercator reference system

SetHotineParametersSystemGeoLibSubroutine

Set parameters for Hotine Oblique Mercator reference system

SetHourChronosSubroutine

Set the hour of the datetime represented by this instance

SetICPlantsSubroutine

set initial condition

SetInitialConditionSoilBalanceSubroutine

set initial condition for soilwater balance

SetLongNameGridLibInterface
SetLongNameFloatGridLibSubroutine

set the long name of a float grid

SetLongNameIntegerGridLibSubroutine

set the long name of a integer grid

SetMinuteChronosSubroutine

Set the minute of the datetime represented by this instance

SetMonthChronosSubroutine

Set the month of the datetime represented by this instance

SetParametersFromDBInfiltrationSubroutine

set parameter maps from soil database

SetParametersFromFileInfiltrationSubroutine

set parameter maps from separate files

SetPlantsManagementPlantsManagementSubroutine

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

Read more…
SetPracticePlantsManagementSubroutine

Set management practices to single plant stand

SetReferenceTimeGridLibInterface
SetReferenceTimeFloatGridLibSubroutine

set the reference time of a float grid

SetReferenceTimeIntegerGridLibSubroutine

set the reference time of a integer grid

SetRichardsBCRichardsSubroutine

Set variables and parameters to call SolveRichardsBC Map FEST structure to accomplish Ross' code

SetSecondChronosSubroutine

Set the second of the datetime represented by this instance

SetSpecificPropertiesAirRelativeHumiditySubroutine

set properties and initialize variables for each interpolation method

SetSpecificPropertiesAirTemperatureSubroutine
SetSpecificPropertiesAirTemperatureDailyMaxSubroutine

set properties and initialize variables for each interpolation method

SetSpecificPropertiesAirTemperatureDailyMeanSubroutine
SetSpecificPropertiesAirTemperatureDailyMinSubroutine

set properties and initialize variables for each interpolation method

SetSpecificPropertiesPrecipitationSubroutine

set properties and initialize variables for each interpolation method

SetSpecificPropertiesPrecipitationDailySubroutine

set properties and initialize variables for each interpolation method

SetSpecificPropertiesSolarRadiationSubroutine

set properties and initialize variables for each interpolation method

SetSpecificPropertiesWindFluxSubroutine

set properties and initialize variables for each interpolation method

SetStandardNameGridLibInterface
SetStandardNameFloatGridLibSubroutine

set the standard name of a float grid

SetStandardNameIntegerGridLibSubroutine

set the standard name of a integer grid

SetSwissParametersGeoLibInterface
SetSwissParametersCoordGeoLibSubroutine

Set parameters for Swiss Oblique Cylindrical reference system

SetSwissParametersSystemGeoLibSubroutine

Set parameters for Swiss Oblique Cylindrical reference system

SetTimeZoneChronosSubroutine

Set the timezone of the datetime represented by this instance

SetTransverseMercatorParametersGeoLibInterface
SetTransverseMercatorParametersCoordGeoLibSubroutine

Set parameters for Transverse Mercator reference system

SetTransverseMercatorParametersSystemGeoLibSubroutine

Set parameters for Transverse Mercator reference system

SetUnitsGridLibInterface
SetUnitsFloatGridLibSubroutine

set the units of a float grid

SetUnitsIntegerGridLibSubroutine

set the units of a integer grid

SetUTMparametersGeoLibInterface
SetUTMparametersCoordGeoLibSubroutine

Set parameters for Universal Transverse Mercator reference system

SetUTMparametersSystemGeoLibSubroutine

Set parameters for Universal Transverse Mercator reference system

SetVaryingModeGridLibInterface
SetVaryingModeFloatGridLibSubroutine

set the varying mode of a float grid Possible values:

Read more…
SetVaryingModeIntegerGridLibSubroutine

set the varying mode of a integer grid

SetWetlandSoilBalanceSubroutine

set wetland for soilwater balance

SetYearChronosSubroutine

Set the year of the datetime represented by this instance

ShearVelocitySedimentFunction

compute shear velocity (m/s)

ShiftBackWithLapseMeteoUtilitiesSubroutine

Shift back interpolated field to terrain surface

ShiftIntegerGridOperationsSubroutine

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

ShiftMeteoWithLapseMeteoUtilitiesSubroutine

shift meteo observations to reference elevation applying lapse rate

ShiftRealGridOperationsSubroutine

Apply a shift to grid_real. Modifies xllcorner and yllcorner

ShortToStringStringManipulationFunction

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

SimplexKrigingSubroutine

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.

Read more…
SizesOKDataTypeSizesFunction

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.

SkyViewSolarRadiationSubroutine

Compute the maximum angle of sky obstruction along 16 directions

Read more…
SnowInitSnowSubroutine

Initialize snow model

SnowParameterUpdateSnowSubroutine

update parameter map that change in time

SnowPointExportSnowSubroutine

Export of point site data

SnowPointInitSnowSubroutine

Initialize export of point site data

SnowUpdateSnowSubroutine

compute accumulation and melting and update snow water equivalent

SofhRichardsFunction

Get saturation S from matric head h

SolarAzimuthSolarRadiationFunction

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

Read more…
SolarDeclinationSolarRadiationFunction

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.

Read more…
SolarHourAngleSolarRadiationFunction

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).

Read more…
SolarRadiationInitSolarRadiationSubroutine

Initialize solar radiation

SolarRadiationReadSolarRadiationSubroutine

Read radiation data

Read more…
SoluteRichardsSubroutine

Solves the ADE from time ti to tf. Diffusion of solute ignored - dispersion coeff = dispersivity * abs(pore water velocity)

SolveRichardsBCRichardsSubroutine

Solve Richards' equation with Brooks and Corey WRC

Read more…
SolveSoilBalanceSoilBalanceSubroutine

Solve soil water balance

SortKrigingSubroutine

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

SortSpatialInterpolationSubroutine

Sort distances in increasing order

Read more…
SortedKrigingSubroutine

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.

SplashFestSubroutine
splitiso_varying_stringInterface
split_CHiso_varying_stringSubroutine

Split a varying string into two verying strings

split_VSiso_varying_stringSubroutine

Split a varying string into two verying strings

SplitNetworkRiverDrainageSubroutine

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

StemBiomassVsDBHPlantsAllometricsFunction

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

Read more…
StringCompactStringManipulationFunction

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

StringReverseStringManipulationFunction

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

StringSplitStringManipulationSubroutine

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

StringToDoubleStringManipulationFunction

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

StringToFloatStringManipulationFunction

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

StringTokenizeStringManipulationSubroutine

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.

StringToLongStringManipulationFunction

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

StringToLowerStringManipulationFunction

! 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

StringToShortStringManipulationFunction

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

StringToUpperStringManipulationFunction

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

SubSectionIsPresentIniLibFunction

return true if subsection is present in section, false otherwise

SunElevationAngleSolarRadiationFunction

Compute the sun elevation angle

Read more…
SwapGridIntegerBackGridLibSubroutine

transport matrix from grid_integer to netcdf format

SwapGridIntegerForwardGridLibSubroutine

transport matrix from netcdf format to grid_integer

SwapGridRealBackGridLibSubroutine

transport matrix from grid_real to netcdf format

SwapGridRealForwardGridLibSubroutine

transport matrix from netcdf format to grid_real

SWCmodPlantsModifiersFunction

soil water content modifier

Read more…
SyncIniLibSubroutine

synchronize the window in which searching for the key

SyncTimeGridLibSubroutine

Description returns lower bounding time step of a given datetime

TableCountColsTableLibFunction

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

TableCountRowsTableLibFunction

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

TableExportTableLibInterface
TableFileSyncTableLibFunction

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

TableGetDoubleTableLibSubroutine

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

TableGetFloatTableLibSubroutine

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

TableGetFromFileTableLibSubroutine

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

TableGetFromUnitTableLibSubroutine

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

TableGetNrowsTableLibInterface
TableGetNumberRowsTableLibFunction

return the number of rows in a table

TableGetStringTableLibSubroutine

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

TableGetValueTableLibInterface
TableNewTableLibInterface
TableReadContentTableLibSubroutine

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

TableReadHeaderTableLibSubroutine

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

TableReadIdTableLibFunction

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

TableReadTitleTableLibFunction

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

TableReadUnitTableLibSubroutine

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

TablesGetDoubleTableLibSubroutine

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

TablesGetFloatTableLibSubroutine

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

TablesGetFromFileTableLibSubroutine

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

TablesGetFromUnitTableLibSubroutine

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

TablesGetIdsTableLibFunction

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

TablesGetNumberRowsTableLibFunction

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

TablesGetStringTableLibSubroutine

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

TableStoreLinesTableLibSubroutine

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

TablesWriteToFileTableLibSubroutine

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

TablesWriteToUnitTableLibSubroutine

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

TableSyncByIdTableLibFunction

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

TableWriteToFileTableLibSubroutine

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

TableWriteToUnitTableLibSubroutine

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

TabToSpaceStringManipulationFunction

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

TEMPmodPlantsModifiersFunction

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.

Read more…
ThroughfallPlantsInterceptionSubroutine

calculate the effective rainfall through canopy

TimeDifferenceChronosFunction

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

TimeIndexGridLibFunction

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

TimeStampLogLibSubroutine

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

TimeStampUtilitiesSubroutine

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

Read more…
TimeToStringChronosSubroutine

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

TopographicIndexMorphologySubroutine

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:

Read more…
TopWidthRoutingModelsFunction

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

Read more…
ToStringStringManipulationInterface
ToUTCChronosFunction

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

triRichardsSubroutine

Get soil water variables from saturation S (where S<1Solves tridiag set of linear eqns. Coeff arrays aa and cc left intact

trimiso_varying_stringInterface
trim_iso_varying_stringFunction

Remove trailing blanks from a varying string

UniqueValuesGridStatisticsInterface
UniqueValuesOfGridIntegerGridStatisticsSubroutine

Description return a vector of distinct values from a grid_integer

UnsHydCondSoilPropertiesFunction

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

UpdateSoilMoistureSoilBalanceSubroutine

update soil moisture

UpstreamCellMorphologySubroutine

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

UtcNowChronosFunction

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

ValfKrigingFunction

function called by Simplex

var_striso_varying_stringInterface
var_str_iso_varying_stringFunction

Convert a character string to a varying string

VarfitKrigingSubroutine

Fit model to experimental variogram

Read more…
VariogrKrigingSubroutine

calculation of the variogram value in 2D

VelocityRoutingModelsFunction

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

Read more…
verifyiso_varying_stringInterface
verify_CH_VSiso_varying_stringFunction

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

verify_VS_CHiso_varying_stringFunction

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

verify_VS_VSiso_varying_stringFunction

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

VPDmodPlantsModifiersFunction

compute vapor pressure deficit modifier.

Read more…
WeightRichardsFunction

Get conductivity weighting for gravity flux calculations

WetlandIsWetSoilBalanceFunction

return .TRUE. if wetland is flooded

WettedAreaRoutingModelsFunction

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

Read more…
WettedPerimeterRoutingModelsFunction

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

Read more…
WindFluxInitWindFluxSubroutine

Initialize air temperature

WindFluxReadWindFluxSubroutine

Read wind speed data

WindGonzalezLongattSpatialInterpolationSubroutine

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.

Read more…
WindMicrometSpatialInterpolationSubroutine

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)

Read more…
WriteDataObservationalNetworksInterface
WriteDataFileUnitObservationalNetworksSubroutine

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

WriteMetadataObservationalNetworksInterface
WriteMetadataFileNameObservationalNetworksSubroutine

write metadata section to file TODO: full CRS support

WriteMetadataFileUnitObservationalNetworksSubroutine

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

WriteReservoirStageReservoirsSubroutine

Write stage of reservoirs in a file

Yang1973SedimentFunction

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

Read more…
Yang1979SedimentFunction

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.

Read more…
ZscoreNormalizationFloatGridStatisticsSubroutine

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:

Read more…