Public Member Functions
	LSDPorewaterParams ()
	The default constructor. Does nothing. More...

	LSDPorewaterParams (string paramfile_path, string paramfile_name)
	Create a SoilHydroRaster by copying an LSDRaster. More...

vector< float >	get_Depths () const

float	get_alpha () const

float	get_D_0 () const

float	get_K_sat () const

float	get_D_hat () const

float	get_d () const

float	get_friction_angle () const

float	get_cohesion () const

float	get_weight_of_water () const

float	get_weight_of_soil () const

void	calculate_beta ()

void	calculate_D_hat ()
	This calculates dimensionless diffusivity. More...

vector< float >	weeks_to_seconds (vector< float > weeks)
	converts weeks to seconds More...

float	weeks_to_seconds (float weeks)
	converts weeks to seconds More...

vector< float >	days_to_seconds (vector< float > days)
	converts days to seconds More...

float	days_to_seconds (float days)
	converts days to seconds More...

vector< float >	seconds_to_weeks (vector< float > seconds)
	converts seconds to weeks More...

float	seconds_to_weeks (float seconds)
	converts seconds to weeks More...

vector< float >	seconds_to_days (vector< float > seconds)
	converts seconds to days More...

float	seconds_to_days (float seconds)
	converts seconds to days More...

vector< float >	calculate_steady_psi ()
	This calculates a steady state pressure profile. More...

void	parse_rainfall_file (string path, string filename, vector< float > &intensities)
	This function parses a rainfall file. It only captures the rainfall rates, which must have the csv header "rainfall_rate". More...

void	parse_MIDAS_rainfall_file (string path, string filename, vector< int > &days, vector< float > &intensities)
	This function parses a rainfall file derived from MIDAS. More...

void	parse_MIDAS_duration_intensities (vector< int > &days, vector< float > &intensities, vector< float > &durations)
	This function takes data vectors extracted from a parsed MIDAS file (using the parse_MIDAS.py script) and returns an intensity duration record. More...

void	print_parameters_to_screen ()
	Thes function prints the parameters to screen. More...

Protected Attributes
vector< float >	Depths
	This holds the depths in metres.

float	alpha
	This holds the slope in radians.

float	D_0
	The hydraulic diffusivity in m^2/s.

float	K_sat
	The saturated hydraulic conductivity in m/s.

float	D_hat
	The dimensionless hydraulic diffusivity.

float	d
	The depth to saturated water table at steady infiltration in metres.

float	beta
	A parameter that describes the stead state pressure profile.

float	Iz_over_K_steady
	The infiltration rate at steady state.

float	friction_angle
	The friction andgle.

float	cohesion
	The cohesion.

float	weight_of_water
	The weigth of water (density time gravity)

float	weight_of_soil
	The weight of soil (density times gravity)

Constructor & Destructor Documentation

LSDPorewaterParams::LSDPorewaterParams ( )

inline

The default constructor. Does nothing.

Author: SMM

Date: 11/11/2015

LSDPorewaterParams::LSDPorewaterParams	(	string	paramfile_path,
		string	paramfile_name
	)

inline

Create a SoilHydroRaster by copying an LSDRaster.

Parameters

ThisRaster The LSDRaster to be copied

Author: SMM

Date: 11/11/2015

Member Function Documentation

void LSDPorewaterParams::calculate_beta ( )

@ brief Calculates the beta parameter and sets that data member

Author: SMM

Date: 17/11/2016

void LSDPorewaterParams::calculate_D_hat ( )

This calculates dimensionless diffusivity.

Author: SMM

Date: 17/11/2016

vector< float > LSDPorewaterParams::calculate_steady_psi ( )

This calculates a steady state pressure profile.

Author: SMM

Date: 17/11/2016

vector< float > LSDPorewaterParams::days_to_seconds ( vector< float > days )

converts days to seconds

Parameters

weeks a vector of days

Returns: a vector of seconds

Author: SMM

Date: 25/11/2016

float LSDPorewaterParams::days_to_seconds ( float days )

converts days to seconds

Parameters

days

Returns: seconds

Author: SMM

Date: 25/11/2016

float LSDPorewaterParams::get_alpha ( ) const

inline

Returns: slope in radians

float LSDPorewaterParams::get_cohesion ( ) const

inline

Returns: cohesion

float LSDPorewaterParams::get_d ( ) const

inline

Returns: depth to water table

float LSDPorewaterParams::get_D_0 ( ) const

inline

Returns: diffusivity

float LSDPorewaterParams::get_D_hat ( ) const

inline

Returns: dimensionless diffusivity

vector<float> LSDPorewaterParams::get_Depths ( ) const

inline

Returns: The vector of depths

float LSDPorewaterParams::get_friction_angle ( ) const

inline

Returns: friction_angle

float LSDPorewaterParams::get_K_sat ( ) const

inline

Returns: the saturated hydraulic conductivity

float LSDPorewaterParams::get_weight_of_soil ( ) const

inline

Returns: weight_of_soil

float LSDPorewaterParams::get_weight_of_water ( ) const

inline

Returns: weight_of_water

void LSDPorewaterParams::parse_MIDAS_duration_intensities	(	vector< int > &	days,
		vector< float > &	intensities,
		vector< float > &	durations
	)

This function takes data vectors extracted from a parsed MIDAS file (using the parse_MIDAS.py script) and returns an intensity duration record.

Parameters

days	a vector of the days in int format of the rainfall measurements
intensities	the intensity measurements: for MIDAS this is mm/day
durations	this is replaced with the durations in days of the records

Author: SMM

Date: 23/11/2016

void LSDPorewaterParams::parse_MIDAS_rainfall_file	(	string	path,
		string	filename,
		vector< int > &	days,
		vector< float > &	intensities
	)

This function parses a rainfall file derived from MIDAS.

Parameters

path	the path to the rainfall file
filename	the name of the file including extension (but this needs to be a csv file)
days	the days since 1900.
intensities	a float vector holding rainfall intensities.

Author: SMM

Date: 22/11/2016

void LSDPorewaterParams::parse_rainfall_file	(	string	path,
		string	filename,
		vector< float > &	intensities
	)

This function parses a rainfall file. It only captures the rainfall rates, which must have the csv header "rainfall_rate".

Parameters

path	the path to the rainfall file
filename	the name of the file including extension (but this needs to be a csv file)
intensities	a float vector holding rainfall intensities.

Author: SMM

Date: 17/11/2016

void LSDPorewaterParams::print_parameters_to_screen ( )

Thes function prints the parameters to screen.

Author: SMM

Date: 22/11/2016

vector< float > LSDPorewaterParams::seconds_to_days ( vector< float > seconds )

converts seconds to days

Parameters

weeks a vector of seconds

Returns: a vector of days

Author: SMM

Date: 25/11/2016

float LSDPorewaterParams::seconds_to_days ( float seconds )

converts seconds to days

Parameters

seconds

Returns: days

Author: SMM

Date: 25/11/2016

vector< float > LSDPorewaterParams::seconds_to_weeks ( vector< float > seconds )

converts seconds to weeks

Parameters

seconds a vector of seconds

Returns: a vector of weeks

Author: SMM

Date: 25/11/2016

float LSDPorewaterParams::seconds_to_weeks ( float seconds )

converts seconds to weeks

Parameters

seconds

Returns: weeks

Author: SMM

Date: 25/11/2016

vector< float > LSDPorewaterParams::weeks_to_seconds ( vector< float > weeks )

converts weeks to seconds

Parameters

weeks a vector of weeks

Returns: a vector of seconds

Author: SMM

Date: 25/11/2016

float LSDPorewaterParams::weeks_to_seconds ( float weeks )

converts weeks to seconds

Parameters

weeks weeks

Returns: seconds

Author: SMM

Date: 25/11/2016

The documentation for this class was generated from the following files:

LSDPorewaterParams.hpp
LSDPorewaterParams.cpp

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation