kynema::interfaces::components::SolutionInput Struct Reference

A configuration object used to create the low level StepParameters object. More...

#include <solution_input.hpp>

Public Member Functions
StepParameters	Parameters () const
	Construct step parameters from inputs.

Public Attributes
std::array< double, 3 >	gravity {0., 0., 0.}
	Array of gravity components (XYZ)
bool	dynamic_solve {true}
	Flag to toggle between static and dynamic solve.
double	time_step {0.01}
	Solver time step.
double	rho_inf {0.0}
	Solver numerical damping factor (0 = maximum damping)
size_t	max_iter {5U}
	Maximum number of convergence iterations.
double	absolute_error_tolerance {1e-5}
	Absolute error tolerance.
double	relative_error_tolerance {1e-3}
	Relative error tolerance.
std::string	output_file_path
	Output file path for NetCDF results (empty = no outputs will be written)

Detailed Description

A configuration object used to create the low level StepParameters object.

Member Function Documentation

Parameters()

StepParameters kynema::interfaces::components::SolutionInput::Parameters ( ) const

inline

Construct step parameters from inputs.

Returns

Step parameters struct

Member Data Documentation

absolute_error_tolerance

double kynema::interfaces::components::SolutionInput::absolute_error_tolerance {1e-5}

Absolute error tolerance.

dynamic_solve

bool kynema::interfaces::components::SolutionInput::dynamic_solve {true}

Flag to toggle between static and dynamic solve.

gravity

std::array<double, 3> kynema::interfaces::components::SolutionInput::gravity {0., 0., 0.}

Array of gravity components (XYZ)

max_iter

size_t kynema::interfaces::components::SolutionInput::max_iter {5U}

Maximum number of convergence iterations.

output_file_path

std::string kynema::interfaces::components::SolutionInput::output_file_path

Output file path for NetCDF results (empty = no outputs will be written)

relative_error_tolerance

double kynema::interfaces::components::SolutionInput::relative_error_tolerance {1e-3}

Relative error tolerance.

rho_inf

double kynema::interfaces::components::SolutionInput::rho_inf {0.0}

Solver numerical damping factor (0 = maximum damping)

time_step

double kynema::interfaces::components::SolutionInput::time_step {0.01}

Solver time step.

---

The documentation for this struct was generated from the following file:

• /home/runner/work/kynema/kynema/kynema/src/interfaces/components/solution_input.hpp