8. API Reference

8.1. Atmosphere

class atmosphere

Public Functions

int run_atmosphere_model(int iDay_doy, int iMonth_ymd, double dAspect_in, double dLatitude_in, double dPrecipitation_in, double dSlope_in, double dTemperature_basin_max_in, double dTemperature_dewpoint_in, double dTemperature_max_in, double dTemperature_min_in)

<atmospheric components>

Parameters:

  • iDay_doy – day of the year

  • iMonth_ymd – month of the year

  • dAspect_in – degree

  • dLatitude_in – degree

  • dPrecipitation_in – meter

  • dSlope_in – degree

  • dTemperature_basin_max_in – kelvin

  • dTemperature_dewpoint_in – kelvin

  • dTemperature_max_in – kelvin

  • dTemperature_min_in – kelvin

Returns:

<ReturnValue>

class groundwater
class evapotranspiration

Public Functions

int calculate_vaporization_latent_heat(double dTemperature_mean_in)

<calculate the latent heat of evaporation>

Parameters:

dTemperature_mean_in – the mean temperature, unit: kelvin

Returns:

<dLambda, unit: joule per gram>

int calculate_potential_evapotranspiration_jh(int iMonth, double dElevation_in, double dShortwave_in, double dTemperature_mean_in, double dVapor_pressure_deficit_in)

<ET using jh methodn>

Parameters:

  • iMonth – month od the year

  • dShortwave_radiation_in – units: joulie per square meter per day

  • dTemperature_mean_in – mean temperature unit kelvin

Returns:

<ReturnValue>

int calculate_potential_evapotranspiration_pt(int iMonth, double dElevation_in, double dShortwave_radiation_in, double dTemperature_mean_in, double dTemperature_mean_yesterday_in)

<ET using Priestley-tayor equation>

Parameters:

  • iMonth – month of the year

  • dElevation_in – elevation of the grid, unit meter

  • dShortwave_radiation_in – the daily actual shortwave radiation, units: joule per square meter per day

  • dTemperature_mean_in – mean temperature, unit kelvin

  • dTemperature_mean_yesterday_in – mean temperature from yesterday, unit kelvin

Returns:

<ReturnValue>

int run_evapotranspiration_model(int iMonth, double dElevation_in, double dShortwave_radiation_actual_in, double dTemperature_mean_in, double dVapor_pressure_deficit_in)

<long-description>

Parameters:

  • iMonth – month of the year

  • dShortwave_in – the daily actual shortwave radiation, units: joule per square meter per day

  • dTemperature_mean_in – mean temperature unti kelvin

Returns:

<ReturnValue>