LSDTopoTools
 All Classes Files Functions Variables Friends Pages
Public Member Functions | Public Attributes | List of all members
LSDSedimentRouting Class Reference

A derived class that is used to compute erosion rates based on concentrations of in-situ cosmogenic nuclides such as 10Be and 26Al. More...

#include <LSDRasterAggregator.hpp>

Inheritance diagram for LSDSedimentRouting:
LSDRasterAggregator

Public Member Functions

 LSDSedimentRouting (string path, string file_prefix)
 This constructor requires a filename The filename and path point to files with the rasters. More...
 
void check_parameter_values ()
 This checks for the parameter values specific to the sediment routing routines. More...
 
void print_parameter_values_to_screen ()
 Prints the parameter values to screen. More...
 
- Public Member Functions inherited from LSDRasterAggregator
 LSDRasterAggregator ()
 the default constructor. This doesn't do anything.
 
 LSDRasterAggregator (string path, string file_prefix)
 This constructor requires a filename The filename and path point to files with the rasters. More...
 
void load_raster_filenames (string filename)
 This function load a csv file containing names of a DEMs and (possibly) other rasters The first row of the file contains column headers and is ignored Thereafter you have two columns in each row, comma seperated, with the raster type as the first column and the raster filename (with full path) as the second. More...
 
void load_parameters (string filename)
 This loads parameters It creates a map of parameter values. More...
 
void check_rasters ()
 this function checks the existence and georeferencing of the rasters outlined in the file list More...
 

Public Attributes

vector< float >
calculate_suspended_and_bedload(int
node, LSDFlowInfo &FlowInfo,
vector< LSDRaster > RasterVec)
protected float 
erosion_rate
 This calculates the suspended and bedload for a given node in the DEM It can be called repeatedly to get the entire DEM. More...
 
map< int, float > erodibility_coefficients
 
map< int, float > fertility_coefficients
 
map< int, float > source_1mm
 

Additional Inherited Members

- Protected Attributes inherited from LSDRasterAggregator
string path
 the path to the cosmo data. Also used to print results
 
string param_name
 the prefix of the parameter files
 
map< string, string > raster_filenames
 
map< string, string > parameter_map
 
float min_slope
 The minimum slope for the fill function.
 
vector< string > boundary_conditions
 The boundary conditions for flow info calculations.
 

Detailed Description

A derived class that is used to compute erosion rates based on concentrations of in-situ cosmogenic nuclides such as 10Be and 26Al.

Constructor & Destructor Documentation

LSDSedimentRouting::LSDSedimentRouting ( string  path,
string  file_prefix 
)
inline

This constructor requires a filename The filename and path point to files with the rasters.

Parameters
pathThe path to the files
file_prefixthe prefix of the files
Author
SMM
Date
10/02/2016

Member Function Documentation

void LSDSedimentRouting::check_parameter_values ( )

This checks for the parameter values specific to the sediment routing routines.

Author
SMM
Date
10/02/2016
void LSDSedimentRouting::print_parameter_values_to_screen ( )

Prints the parameter values to screen.

Author
SMM
Date
10/02/2016

Member Data Documentation

map<int,float> LSDSedimentRouting::erodibility_coefficients

The erodibiliy coefficients in km^-1 The int is the index into the lithology (coded with an integer)

vector<float> calculate_suspended_and_bedload (int node, LSDFlowInfo& FlowInfo, vector<LSDRaster> RasterVec) protected float LSDSedimentRouting::erosion_rate

This calculates the suspended and bedload for a given node in the DEM It can be called repeatedly to get the entire DEM.

Parameters
nodeThe node at which you want to calculate suspended and bedload
FlowInfothe LSDFlowinfo object
RasterVeca vector of LSDRasters, the first element is the DEM, the second element is the lithology, the third element is the flow distance and the fourth element is the erosion rate
Returns
a vector containg the bedload and suspended load information
Author
SMM
Date
22/03/2016 the erosion rate in mm/yr
map<int,float> LSDSedimentRouting::fertility_coefficients

The fertility coefficients: states the fraction in the source material that contains zircon The int is the index into the lithology (coded with an integer)

map<int,float> LSDSedimentRouting::source_1mm

The fraction of the source material that is entered as suspended load The int is the index into the lithology (coded with an integer)


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