arginput.cppΒΆ
An implementation cpp file containing the definitions of code parameter objects and some functions relavant to their handling and display.
Functions
- void InitialiseArguments(void)
Function in which all code input parameters are specified as members of an ArgumentList.
- void ParameterFileRead(const char * parameter_file_location)
Function which searches a parameter file for all parameters expected from the ArgumentList and reads their values.
- See
- ArgumentList
- Parameters
- parameter_file_location -
path to target parameter file
- parameter_file_location -
- int param_cmd_parse(int argc, char * argv[])
Function which searches a the command line input for all parameters expected from the ArgumentList and reads their values.
- See
- ArgumentList
- Parameters
- argc -
number of terminal arguments
- argv -
array of terminal arguments as constant character arrays (c strings)
- argc -
- void PrintUsage(void)
Function which loops over the ArgumentList and prints to screen all available arguments, flags and descriptions.
Variables
- std::string input_file_location
path to target snapshot file
- std::string output_file_location
path to output file
- std::string param_file_location
path to target parameter file
- int input_format
snapshot input file format
- int output_format
griddr output file format
- int use_vels
if use_vels!=1, 3D velocity components are not smoothed on to the grid
- double x_r
rotation angle (degs) around the x-axis
- double y_r
rotation angle (degs) around the y-axis
- double z_r
rotation angle (degs) around the z-axis
- double theta_r
rotation angle (degs) in the theta direction
- double phi_r
rotation angle (degs) in the phi direction
- double x_r0
coordinate translation new centre (rotate about this pos.)
- double y_r0
coordinate translation new centre (rotate about this pos.)
- double z_r0
coordinate translation new centre (rotate about this pos.)
- int NxDim
number of grid cells (pixels) in the x direction
- int NyDim
number of grid cells (pixels) in the y direction
- int NzDim
number of grid cells (pixels) in the z direction
- int LimMode
smoothing grid limit calculation mode
- int grid_inc_type
particle type to enclose if grid limits auto calculated
- double xLen_g
length of the smoothing grid in the x direction
- double yLen_g
length of the smoothing grid in the y direction
- double zLen_g
length of the smoothing grid in the z direction
- double x_g0
smoothing grid x-dimension centre
- double y_g0
smoothing grid y-dimension centre
- double z_g0
smoothing grid z-dimension centre
- double dx_grid
smoothing grid x-dimension cell length
- double dy_grid
smoothing grid y-dimension cell length
- double dz_grid
smoothing grid z-dimension cell length
- double xLim_g[2]
smoothing grid x-dimension [lower, upper] limits
- double yLim_g[2]
smoothing grid y-dimension [lower, upper] limits
- double zLim_g[2]
smoothing grid z-dimension [lower, upper] limits
- int sph_kernel_type
SPH kernel in use.
- bool help_on
- ArgumentList input_arguments