Stores and processes user input from a driver script. More...
Inheritance diagram for Input:
Collaboration diagram for Input:
Public Member Functions | |
| function | Input () |
| Class constructor. | |
| function | put (in obj, in key, in value) |
| Put a new (key, value) pair into the input database. | |
| function | get (in obj, in key) |
| Get the value for a key in the input database. | |
| function | contains (in obj, in key) |
| Check if a key exists. | |
Public Attributes | |
| Property | bc_left |
| Property | bc_right |
| Property | bc_bottom |
| Property | bc_top |
| Property | number_groups |
| Property | equations |
| Property | inner_max_iters |
| Property | inner_tolerance |
| Property | max_outer |
| Property | tol_outer |
| Property | max_fission |
| Property | tol_fission |
| Property | tol_eigenvalue |
| Property | quadrature_type |
| Property | quadrature_order |
| Property | problem_type |
| Property | solver_type |
Private Attributes | |
| Property | d_map |
| Input data map, consisting of "keys" with "values". | |
Detailed Description
Stores and processes user input from a driver script.
The basic idea of this class is to store arbitrary user input for all of the features in the code. To hard code a set user input is silly, since new parameters are added for new algorithms or implementations. Hence, all parameters are added to a map database (simple structures could also work). New algorithms and implementations are then required to set defaults in the event these are not set. Several standard items are given defaults upon construction.
Constructor & Destructor Documentation
Member Function Documentation
| function contains | ( | in | obj, |
| in | key | ||
| ) |
Check if a key exists.
- Returns:
- 1 if it exists, 0 otherwise.
| function get | ( | in | obj, |
| in | key | ||
| ) |
Get the value for a key in the input database.
- Returns:
- Value for the key or zero along with a warning.
| function put | ( | in | obj, |
| in | key, | ||
| in | value | ||
| ) |
Put a new (key, value) pair into the input database.
- Returns:
- Instance of the Mesh class with standard defaults.
Member Data Documentation
| Property bc_bottom |
| Property bc_left |
| Property bc_right |
| Property bc_top |
| Property equations |
| Property inner_max_iters |
| Property inner_tolerance |
| Property max_fission |
| Property max_outer |
| Property number_groups |
| Property problem_type |
| Property quadrature_order |
| Property quadrature_type |
| Property solver_type |
| Property tol_eigenvalue |
| Property tol_fission |
| Property tol_outer |
The documentation for this class was generated from the following file:
- /home/robertsj/Research/matlab_transport_pack/source/Input.m
