doc: More documentation !
4728ae8e7325
Actions

Authored by georget on Aug 22 2017, 22:03.

Description

doc: More documentation !

Details

Committed

georget

Aug 22 2017, 22:03

Parents

rSPECMICPca7b5e361a03: fix propagates typo correction

Branches

Unknown

Tags

Unknown

Event Timeline

georget committed rSPECMICP4728ae8e7325: doc: More documentation ! (authored by georget).Aug 22 2017, 22:03

Changes (138)
Show All Changes

Very Large Commit

This commit is very large. Load each file individually.

				Path
	M			doc/Doxyfile.in
	M			doc/api.md
	M			doc/reactmicp/solver.md
	M			src/bin/reactmicp/unsaturated.cpp
	M			src/bin/specmicp/specmicp.cpp
	M			src/dfpm/1dtransport/diffusion.hpp
	M			src/dfpm/1dtransport/diffusion_parameters.hpp
	M			src/dfpm/io/hdf5_mesh.hpp
	M			src/dfpm/io/meshes.hpp
	M			src/dfpm/meshes/mesh1d.hpp
	M			src/dfpm/meshes/mesh1d_storage.hpp
	M			src/dfpm/solver/driver.hpp
	M			src/dfpm/solver/driver_structs.hpp
	M			src/dfpm/solver/parabolic_driver.hpp
	M			src/dfpm/solver/parabolic_program.hpp
	M			src/dfpm/solver/parabolic_structs.hpp
	M			src/reactmicp/equilibrium_curve/chemistry.hpp
	M			src/reactmicp/equilibrium_curve/eqcurve_coupler.hpp
	M			src/reactmicp/equilibrium_curve/eqcurve_extractor.hpp
	M			src/reactmicp/equilibrium_curve/eqcurve_solid_transport.hpp
	M			src/reactmicp/io/configuration.cpp
	M			src/reactmicp/io/configuration.hpp
	M			src/reactmicp/io/configuration_unsaturated.hpp
	M			src/reactmicp/io/hdf5_unsaturated.hpp
	M			src/reactmicp/io/saturated_react.cpp
	M			src/reactmicp/io/saturated_react.hpp
	M			src/reactmicp/solver/reactive_transport_solver.hpp
	M			src/reactmicp/solver/reactive_transport_solver_structs.hpp
	M			src/reactmicp/solver/timestepper.hpp
	M			src/reactmicp/solver/timestepper_structs.hpp
	M			src/reactmicp/systems/saturated_react/diffusive_upscaling_stagger.hpp
	M			src/reactmicp/systems/saturated_react/equilibrium_stagger.cpp
	M			src/reactmicp/systems/saturated_react/equilibrium_stagger.hpp
	M			src/reactmicp/systems/saturated_react/init_variables.hpp
	M			src/reactmicp/systems/saturated_react/kinetic_stagger.hpp
	M			src/reactmicp/systems/saturated_react/transport_program.hpp
	M			src/reactmicp/systems/saturated_react/transport_stagger.cpp
	M			src/reactmicp/systems/saturated_react/transport_stagger.hpp
	M			src/reactmicp/systems/saturated_react/variables.hpp
	M			src/reactmicp/systems/unsaturated/aqueous_equation.hpp
	M			src/reactmicp/systems/unsaturated/aqueous_pressure_equation.hpp
	M			src/reactmicp/systems/unsaturated/boundary_conditions.hpp
	M			src/reactmicp/systems/unsaturated/equilibrium_stagger.hpp
	M			src/reactmicp/systems/unsaturated/fv_1dof_equation.hpp
	M			src/reactmicp/systems/unsaturated/pressure_equation.hpp
	M			src/reactmicp/systems/unsaturated/saturation_equation.cpp
	M			src/reactmicp/systems/unsaturated/saturation_equation.hpp
	M			src/reactmicp/systems/unsaturated/variables_sub.hpp
	M			src/specmicp/adimensional/adimensional_system.hpp
	M			src/specmicp/adimensional/adimensional_system_numbering.hpp
	M			src/specmicp/adimensional/adimensional_system_pcfm.hpp
	M			src/specmicp/adimensional/adimensional_system_solution_extractor.hpp
	M			src/specmicp/adimensional/adimensional_system_solver.hpp
	M			src/specmicp/adimensional/adimensional_system_structs.hpp
	M			src/specmicp/adimensional/config_default_options_solver.h
	M			src/specmicp/adimensional/equilibrium_curve.hpp
	M			src/specmicp/adimensional_kinetics/CMakeLists.txt
	M			src/specmicp/adimensional_kinetics/kinetic_system.hpp
	M			src/specmicp/adimensional_kinetics/kinetic_system_euler_solver.hpp
	M			src/specmicp/adimensional_kinetics/kinetic_variables.hpp
	M			src/specmicp/io/adimensional_system_solution_reader.hpp
	M			src/specmicp/io/adimensional_system_solution_saver.hpp
	M			src/specmicp/io/config_solution_output_format.h
	M			src/specmicp/io/configuration.cpp
	M			src/specmicp/problem_solver/dissolver.hpp
	M			src/specmicp/problem_solver/reactant_box.hpp
	M			src/specmicp/problem_solver/smart_solver.hpp
	M			src/specmicp/problem_solver/step_solver.hpp
	M			src/specmicp_common/cli/parser.cpp
	M			src/specmicp_common/cli/parser.hpp
	M			src/specmicp_common/eigen/value_checker.hpp
	M			src/specmicp_common/eigen/vector_checker.hpp
	M			src/specmicp_common/eigen/vector_checker_expr.hpp
	M			src/specmicp_common/io/all_io_files.cpp
	M			src/specmicp_common/io/all_io_files.hpp
	M			src/specmicp_common/io/config_yaml_sections.h
	M			src/specmicp_common/io/configuration.hpp
	M			src/specmicp_common/io/csv_formatter.hpp
	M			src/specmicp_common/io/format.hpp
	M			src/specmicp_common/io/hdf5/attribute.hpp
	M			src/specmicp_common/io/hdf5/dataset.hpp
	M			src/specmicp_common/io/hdf5/dataspace.hpp
	M			src/specmicp_common/io/hdf5/file.hpp
	M			src/specmicp_common/io/hdf5/group.hpp
	M			src/specmicp_common/io/hdf5/id_class.hpp
	M			src/specmicp_common/io/hdf5/path.hpp
	M			src/specmicp_common/io/hdf5/type.hpp
	M			src/specmicp_common/io/hdf5_timesteps.hpp
	M			src/specmicp_common/io/safe_config.cpp
	M			src/specmicp_common/io/safe_config.hpp
	M			src/specmicp_common/io/yaml.cpp
	M			src/specmicp_common/log.cpp
	M			src/specmicp_common/log.hpp
	M			src/specmicp_common/macros.hpp
	M			src/specmicp_common/micpsolver/boxviprog.hpp
	M			src/specmicp_common/micpsolver/estimate_cond_number.hpp
	M			src/specmicp_common/micpsolver/micpsolver.hpp
	M			src/specmicp_common/micpsolver/micpsolver_base.hpp
	M			src/specmicp_common/micpsolver/micpsolver_min.hpp
	M			src/specmicp_common/micpsolver/micpsolver_structs.hpp
	M			src/specmicp_common/micpsolver/micpsolverold.inl
	M			src/specmicp_common/micpsolver/ncp_function.hpp
	M			src/specmicp_common/odeint/butcher_tableau.hpp
	M			src/specmicp_common/odeint/odeint_types.hpp
	M			src/specmicp_common/odeint/runge_kutta_step.hpp
	M			src/specmicp_common/physics/constants.hpp
	M			src/specmicp_common/physics/maths.hpp
	M			src/specmicp_common/physics/units.hpp
	M			src/specmicp_common/plugins/module_base.hpp
	M			src/specmicp_common/plugins/plugin_base.hpp
	M			src/specmicp_common/plugins/plugin_modules_names.h
	M			src/specmicp_common/plugins/plugin_types.hpp
	M			src/specmicp_common/range_iterator.hpp
	M			src/specmicp_common/range_iterator.inl
	M			src/specmicp_common/sparse_solvers/sparse_solver_structs.hpp
	M			src/specmicp_database/appender.hpp
	M			src/specmicp_database/aqueous_selector.hpp
	M			src/specmicp_database/data_container.cpp
	M			src/specmicp_database/data_container.hpp
	M			src/specmicp_database/errors.hpp
	M			src/specmicp_database/io/configuration.cpp
	M			src/specmicp_database/io/configuration.hpp
	M			src/specmicp_database/mineral_selector.hpp
	M			src/specmicp_database/module.hpp
	M			src/specmicp_database/oxydo_selector.hpp
	M			src/specmicp_database/reader_common.cpp
	M			src/specmicp_database/selector.hpp
	M			src/specmicp_database/species/component_list.hpp
	M			src/specmicp_database/species/element_list.hpp
	M			src/specmicp_database/species/ionic_parameters.hpp
	M			src/specmicp_database/species/mineral_list.hpp
	M			src/specmicp_database/species/species.hpp
	M			src/specmicp_database/switch_basis.hpp
	M			src/specmicp_database/unknown_class.hpp
	M			src/specmicp_database/yaml_reader.cpp
	M			src/specmicp_database/yaml_reader.hpp
	M			src/specmicp_database/yaml_writer.cpp
	M			src/specmicp_database/yaml_writer.hpp