Create modeling options

AUTHORS: Julien Ruffault (julien.ruff@gmail.com), Nicolas Martin-StPaul (nicolas.martin@inrae.fr)

---

source

create_modeling_options

 create_modeling_options (time_step_for_evapo:int=1, reset_swc:bool=False,
                          avoid_water_soil_transfer:bool=True,
                          soil_evapo:bool=True, defoliation:bool=False,
                          threshold_mortality:int=90,
                          transpiration_model:str=['jarvis', 'granier'],
                          etp_formulation:str=['pt', 'penman'],
                          rn_formulation:str=['linacre', 'linear'],
                          pedo_transfer_formulation:str=['vg',
                          'campbell'], constant_climate:bool=False,
                          comp_options_for_evapo:str=['normal',
                          'accurate', 'fast', 'custom'],
                          custom_small_time_step_in_sec:int=600,
                          lcav:int=1, scav:int=1, eord:int=1,
                          numerical_scheme:str=['implicit', 'semi-
                          implicit', 'explicit'],
                          stomatal_reg_formulation:str=['sigmoid',
                          'piecewise_linear', 'turgor'],
                          print_prog:bool=True)

Create a dictionary containing modeling options that can be used as an input in run.SurEauR

	Type	Default	Details
time_step_for_evapo	int	1	time step for the main evapotranspiration loop. Should be one of the following 1,2,4,6,8
reset_swc	bool	False	Boolean indicating whether soil layers should be refilled at the beginning of each year
avoid_water_soil_transfer	bool	True	Yet to be implemented. Boolean indicating whether the transfer of water between soil layers should be avoided by disconnecting the soil layers that get refilled from the soil-plant system
soil_evapo	bool	True	Boolean indicating whether soil evaporation should be simulated (True) or not (False)
defoliation	bool	False	Boolean indicating whether trees should loose leaves whenoccurs.cavitation occurs of the above part of plant. Defoliation starts only when PLC_Leaf > 10% .
threshold_mortality	int	90	Percentange value indicating the percentage loss of conductivity above which the plant is considered dead and simulation stops for the current year.
transpiration_model	str	[‘jarvis’, ‘granier’]	Transpiration model type
etp_formulation	str	[‘pt’, ‘penman’]
rn_formulation	str	[‘linacre’, ‘linear’]	the formulation of ETP to be used, either pt (Priestley-Taylor) or penman (Penmman)
pedo_transfer_formulation	str	[‘vg’, ‘campbell’]	method to be used to calculate net radiation from global radiation, either linacre or ‘linear’ (the linear method is not implemnted yet)
constant_climate	bool	False	Boolian indicating whether the climate should be considered constant or not
comp_options_for_evapo	str	[‘normal’, ‘accurate’, ‘fast’, ‘custom’]
custom_small_time_step_in_sec	int	600	Time step in seconds. Use if comp_options_for_evapo is set to custom
lcav	int	1	Unknown parameter definition
scav	int	1	Unknown parameter definition
eord	int	1	Unknown parameter definition
numerical_scheme	str	[‘implicit’, ‘semi-implicit’, ‘explicit’]
stomatal_reg_formulation	str	[‘sigmoid’, ‘piecewise_linear’, ‘turgor’]	Unknown parameter definition
print_prog	bool	True	Unknown parameter definition
Returns	typing.Dict

Example: Create modeling options dictionary

create_modeling_options(
    time_step_for_evapo=2,
    reset_swc=True,
    avoid_water_soil_transfer=True,
    constant_climate=True,
    defoliation=True,
    soil_evapo=True,
    threshold_mortality=51,
    etp_formulation="pt",
    rn_formulation="linear",
    comp_options_for_evapo="custom",
    stomatal_reg_formulation="turgor",
    transpiration_model="jarvis",
    numerical_scheme="implicit",
    pedo_transfer_formulation="vg",
)

defaultdict(list,
            {'constant_climate': True,
             'etp_formulation': 'pt',
             'rn_formulation': 'linear',
             'pedo_transfer_formulation': 'vg',
             'time_step_for_evapo': 2,
             'time': array([ 0,  2,  4,  6,  8, 10, 12, 14, 16, 18, 20, 22]),
             'reset_swc': True,
             'avoid_water_soil_transfer': True,
             'comp_options': defaultdict(list,
                         {'numerical_scheme': 'implicit',
                          'nsmalltimesteps': 12.0,
                          'lsym': 1,
                          'ssym': 1,
                          'clapo': 1,
                          'ctapo': 1,
                          'eord': 1,
                          'lcav': 1,
                          'scav': 1}),
             'stomatal_reg_formulation': 'turgor',
             'soil_evapo': True,
             'defoliation': True,
             'threshold_mortality': 51,
             'transpiration_model': 'jarvis',
             'print_prog': True})