diff --git a/Applications/ApplicationsLib/ProjectData.cpp b/Applications/ApplicationsLib/ProjectData.cpp index f92ee5e6f83a5c2fe43f4fad4f692f7107a58815..16a61dc57b77c79fcad25733e461a375b6f469d8 100644 --- a/Applications/ApplicationsLib/ProjectData.cpp +++ b/Applications/ApplicationsLib/ProjectData.cpp @@ -65,7 +65,6 @@ ProjectData::ProjectData(BaseLib::ConfigTree const& project_config, auto const mesh_param = project_config.getConfigParameter("mesh"); std::string const mesh_file = BaseLib::copyPathToFileName( - //! \ogs_file_param{prj__mesh} mesh_param.getValue<std::string>(), project_directory); MeshLib::Mesh* const mesh = MeshLib::IO::readMeshFromFile(mesh_file); @@ -76,7 +75,7 @@ ProjectData::ProjectData(BaseLib::ConfigTree const& project_config, } if (auto const axially_symmetric = - //! \ogs_file_param{prj__mesh__axial_symmetric} + //! \ogs_file_attr{prj__mesh__axially_symmetric} mesh_param.getConfigAttributeOptional<bool>("axially_symmetric")) { mesh->setAxiallySymmetric(*axially_symmetric); @@ -263,12 +262,13 @@ void ProjectData::parseProcesses(BaseLib::ConfigTree const& processes_config, //! \ogs_file_param{process__type} auto const type = process_config.peekConfigParameter<std::string>("type"); - //! \ogs_file_param{process__type} + //! \ogs_file_param{process__name} auto const name = process_config.getConfigParameter<std::string>("name"); std::unique_ptr<ProcessLib::Process> process; auto jacobian_assembler = ProcessLib::createJacobianAssembler( + //! \ogs_file_param{process__jacobian_assembler} process_config.getConfigSubtreeOptional("jacobian_assembler")); if (type == "GROUNDWATER_FLOW") @@ -297,6 +297,7 @@ void ProjectData::parseProcesses(BaseLib::ConfigTree const& processes_config, } else if (type == "SMALL_DEFORMATION") { + //! \ogs_file_param{process__SMALL_DEFORMATION__dimension} switch (process_config.getConfigParameter<int>("dimension")) { case 2: diff --git a/Documentation/ProjectFile/boundary_condition/UniformDirichlet/c_UniformDirichlet.md b/Documentation/ProjectFile/boundary_condition/Dirichlet/c_Dirichlet.md similarity index 100% rename from Documentation/ProjectFile/boundary_condition/UniformDirichlet/c_UniformDirichlet.md rename to Documentation/ProjectFile/boundary_condition/Dirichlet/c_Dirichlet.md diff --git a/Documentation/ProjectFile/prj/output/VTK/c_VTK.md b/Documentation/ProjectFile/boundary_condition/Dirichlet/t_parameter.md similarity index 100% rename from Documentation/ProjectFile/prj/output/VTK/c_VTK.md rename to Documentation/ProjectFile/boundary_condition/Dirichlet/t_parameter.md diff --git a/Documentation/ProjectFile/boundary_condition/UniformDirichlet/t_value.md b/Documentation/ProjectFile/boundary_condition/UniformDirichlet/t_value.md deleted file mode 100644 index dd12bb0335972c7bd7f5cf7757ab8462e3bc0073..0000000000000000000000000000000000000000 --- a/Documentation/ProjectFile/boundary_condition/UniformDirichlet/t_value.md +++ /dev/null @@ -1 +0,0 @@ -The value to which the unknown is set on this Dirichlet boundary. diff --git a/Documentation/ProjectFile/prj/output/i_output.md b/Documentation/ProjectFile/material/fluid/density/IdealGasLaw/c_IdealGasLaw.md similarity index 100% rename from Documentation/ProjectFile/prj/output/i_output.md rename to Documentation/ProjectFile/material/fluid/density/IdealGasLaw/c_IdealGasLaw.md diff --git a/Documentation/ProjectFile/prj/output/t_output_iteration_results.md b/Documentation/ProjectFile/material/fluid/density/IdealGasLaw/t_molar_mass.md similarity index 100% rename from Documentation/ProjectFile/prj/output/t_output_iteration_results.md rename to Documentation/ProjectFile/material/fluid/density/IdealGasLaw/t_molar_mass.md diff --git a/Documentation/ProjectFile/prj/output/t_prefix.md b/Documentation/ProjectFile/material/fluid/density/i_density.md similarity index 100% rename from Documentation/ProjectFile/prj/output/t_prefix.md rename to Documentation/ProjectFile/material/fluid/density/i_density.md diff --git a/Documentation/ProjectFile/prj/output/t_type.md b/Documentation/ProjectFile/material/fluid/density/linear_temperature/i_linear_temperature.md similarity index 100% rename from Documentation/ProjectFile/prj/output/t_type.md rename to Documentation/ProjectFile/material/fluid/density/linear_temperature/i_linear_temperature.md diff --git a/Documentation/ProjectFile/prj/output/timesteps/i_timesteps.md b/Documentation/ProjectFile/material/fluid/density/linear_temperature/t_beta.md similarity index 100% rename from Documentation/ProjectFile/prj/output/timesteps/i_timesteps.md rename to Documentation/ProjectFile/material/fluid/density/linear_temperature/t_beta.md diff --git a/Documentation/ProjectFile/prj/output/timesteps/pair/i_pair.md b/Documentation/ProjectFile/material/fluid/density/linear_temperature/t_temperature0.md similarity index 100% rename from Documentation/ProjectFile/prj/output/timesteps/pair/i_pair.md rename to Documentation/ProjectFile/material/fluid/density/linear_temperature/t_temperature0.md diff --git a/Documentation/ProjectFile/prj/output/timesteps/pair/t_each_steps.md b/Documentation/ProjectFile/material/fluid/density/liquid_density/i_liquid_density.md similarity index 100% rename from Documentation/ProjectFile/prj/output/timesteps/pair/t_each_steps.md rename to Documentation/ProjectFile/material/fluid/density/liquid_density/i_liquid_density.md diff --git a/Documentation/ProjectFile/prj/output/timesteps/pair/t_repeat.md b/Documentation/ProjectFile/material/fluid/density/liquid_density/t_bulk_modulus.md similarity index 100% rename from Documentation/ProjectFile/prj/output/timesteps/pair/t_repeat.md rename to Documentation/ProjectFile/material/fluid/density/liquid_density/t_bulk_modulus.md diff --git a/Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md b/Documentation/ProjectFile/material/fluid/density/liquid_density/t_p0.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md rename to Documentation/ProjectFile/material/fluid/density/liquid_density/t_p0.md diff --git a/Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/t_t_end.md b/Documentation/ProjectFile/material/fluid/density/liquid_density/t_rho0.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/t_t_end.md rename to Documentation/ProjectFile/material/fluid/density/liquid_density/t_rho0.md diff --git a/Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/t_t_initial.md b/Documentation/ProjectFile/material/fluid/density/liquid_density/t_temperature0.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/t_t_initial.md rename to Documentation/ProjectFile/material/fluid/density/liquid_density/t_temperature0.md diff --git a/Documentation/ProjectFile/prj/time_stepping/t_type.md b/Documentation/ProjectFile/material/fluid/density/t_type.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/t_type.md rename to Documentation/ProjectFile/material/fluid/density/t_type.md diff --git a/Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md b/Documentation/ProjectFile/material/fluid/density/t_value.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md rename to Documentation/ProjectFile/material/fluid/density/t_value.md diff --git a/Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md b/Documentation/ProjectFile/material/fluid/viscosity/Constant/c_Constant.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md rename to Documentation/ProjectFile/material/fluid/viscosity/Constant/c_Constant.md diff --git a/Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md b/Documentation/ProjectFile/material/fluid/viscosity/Constant/t_value.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md rename to Documentation/ProjectFile/material/fluid/viscosity/Constant/t_value.md diff --git a/Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md b/Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/i_temperature_dependent.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md rename to Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/i_temperature_dependent.md diff --git a/Documentation/ProjectFile/prj/time_stepping/SingleStep/c_SingleStep.md b/Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_gamma.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/SingleStep/c_SingleStep.md rename to Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_gamma.md diff --git a/Documentation/ProjectFile/prj/time_stepping/i_time_stepping.md b/Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_p0.md similarity index 100% rename from Documentation/ProjectFile/prj/time_stepping/i_time_stepping.md rename to Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_p0.md diff --git a/Documentation/ProjectFile/process/output/i_output.md b/Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_tc.md similarity index 100% rename from Documentation/ProjectFile/process/output/i_output.md rename to Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_tc.md diff --git a/Documentation/ProjectFile/process/output/t_output_extrapolation_residuals.md b/Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_tv.md similarity index 100% rename from Documentation/ProjectFile/process/output/t_output_extrapolation_residuals.md rename to Documentation/ProjectFile/material/fluid/viscosity/temperature_dependent/t_tv.md diff --git a/Documentation/ProjectFile/process/output/t_output_iteration_results.md b/Documentation/ProjectFile/parameter/CurveScaled/c_CurveScaled.md similarity index 100% rename from Documentation/ProjectFile/process/output/t_output_iteration_results.md rename to Documentation/ProjectFile/parameter/CurveScaled/c_CurveScaled.md diff --git a/Documentation/ProjectFile/process/output/variables/i_variables.md b/Documentation/ProjectFile/parameter/CurveScaled/t_curve.md similarity index 100% rename from Documentation/ProjectFile/process/output/variables/i_variables.md rename to Documentation/ProjectFile/parameter/CurveScaled/t_curve.md diff --git a/Documentation/ProjectFile/process/output/variables/t_variable.md b/Documentation/ProjectFile/parameter/CurveScaled/t_parameter.md similarity index 100% rename from Documentation/ProjectFile/process/output/variables/t_variable.md rename to Documentation/ProjectFile/parameter/CurveScaled/t_parameter.md diff --git a/Documentation/ProjectFile/process/t_nonlinear_solver.md b/Documentation/ProjectFile/parameter/Group/index_values/i_index_values.md similarity index 100% rename from Documentation/ProjectFile/process/t_nonlinear_solver.md rename to Documentation/ProjectFile/parameter/Group/index_values/i_index_values.md diff --git a/Documentation/ProjectFile/process/time_discretization/BackwardDifferentiationFormula/c_BackwardDifferentiationFormula.md b/Documentation/ProjectFile/parameter/Group/index_values/t_index.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/BackwardDifferentiationFormula/c_BackwardDifferentiationFormula.md rename to Documentation/ProjectFile/parameter/Group/index_values/t_index.md diff --git a/Documentation/ProjectFile/process/time_discretization/BackwardDifferentiationFormula/t_order.md b/Documentation/ProjectFile/parameter/Group/index_values/t_value.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/BackwardDifferentiationFormula/t_order.md rename to Documentation/ProjectFile/parameter/Group/index_values/t_value.md diff --git a/Documentation/ProjectFile/process/time_discretization/BackwardEuler/c_BackwardEuler.md b/Documentation/ProjectFile/parameter/Group/index_values/t_values.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/BackwardEuler/c_BackwardEuler.md rename to Documentation/ProjectFile/parameter/Group/index_values/t_values.md diff --git a/Documentation/ProjectFile/parameter/i_parameter.md b/Documentation/ProjectFile/parameter/c_parameter.md similarity index 100% rename from Documentation/ProjectFile/parameter/i_parameter.md rename to Documentation/ProjectFile/parameter/c_parameter.md diff --git a/Documentation/ProjectFile/process/time_discretization/CrankNicolson/c_CrankNicolson.md b/Documentation/ProjectFile/prj/mesh/a_axially_symmetric.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/CrankNicolson/c_CrankNicolson.md rename to Documentation/ProjectFile/prj/mesh/a_axially_symmetric.md diff --git a/Documentation/ProjectFile/prj/mesh/i_mesh.md b/Documentation/ProjectFile/prj/mesh/i_mesh.md new file mode 100644 index 0000000000000000000000000000000000000000..11ed78b9ec0b7e61c6f2e191a45b0cd5a8cb48f5 --- /dev/null +++ b/Documentation/ProjectFile/prj/mesh/i_mesh.md @@ -0,0 +1 @@ +Information about input mesh. diff --git a/Documentation/ProjectFile/prj/t_mesh.md b/Documentation/ProjectFile/prj/t_mesh.md deleted file mode 100644 index b7cefacbd935d4a60c4babf706aec64b51648a88..0000000000000000000000000000000000000000 --- a/Documentation/ProjectFile/prj/t_mesh.md +++ /dev/null @@ -1 +0,0 @@ -Info about mesh... diff --git a/Documentation/ProjectFile/process/time_discretization/CrankNicolson/t_theta.md b/Documentation/ProjectFile/prj/time_loop/i_time_loop.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/CrankNicolson/t_theta.md rename to Documentation/ProjectFile/prj/time_loop/i_time_loop.md diff --git a/Documentation/ProjectFile/process/time_discretization/ForwardEuler/c_ForwardEuler.md b/Documentation/ProjectFile/prj/time_loop/output/i_output.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/ForwardEuler/c_ForwardEuler.md rename to Documentation/ProjectFile/prj/time_loop/output/i_output.md diff --git a/Documentation/ProjectFile/process/time_discretization/i_time_discretization.md b/Documentation/ProjectFile/prj/time_loop/output/t_output_iteration_results.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/i_time_discretization.md rename to Documentation/ProjectFile/prj/time_loop/output/t_output_iteration_results.md diff --git a/Documentation/ProjectFile/process/time_discretization/t_type.md b/Documentation/ProjectFile/prj/time_loop/output/t_prefix.md similarity index 100% rename from Documentation/ProjectFile/process/time_discretization/t_type.md rename to Documentation/ProjectFile/prj/time_loop/output/t_prefix.md diff --git a/Documentation/ProjectFile/prj/time_loop/output/t_type.md b/Documentation/ProjectFile/prj/time_loop/output/t_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/output/t_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/output/timesteps/i_timesteps.md b/Documentation/ProjectFile/prj/time_loop/output/timesteps/i_timesteps.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/output/timesteps/i_timesteps.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/i_pair.md b/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/i_pair.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/i_pair.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/t_each_steps.md b/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/t_each_steps.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/t_each_steps.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/t_repeat.md b/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/t_repeat.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/output/timesteps/pair/t_repeat.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/i_processes.md b/Documentation/ProjectFile/prj/time_loop/processes/i_processes.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/i_processes.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/a_ref.md b/Documentation/ProjectFile/prj/time_loop/processes/process/a_ref.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/a_ref.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/c_DeltaX.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/DeltaX/c_DeltaX.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/c_DeltaX.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/t_abstol.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_abstol.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/t_abstol.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/t_norm_type.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_norm_type.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/t_norm_type.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/t_reltol.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/DeltaX/t_reltol.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/DeltaX/t_reltol.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/c_PerComponentDeltaX.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/t_abstols.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_abstols.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/t_abstols.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/t_norm_type.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/t_reltols.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentDeltaX/t_reltols.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentDeltaX/t_reltols.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/c_PerComponentResidual.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/t_abstols.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_abstols.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/t_abstols.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/t_norm_type.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_norm_type.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/t_norm_type.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/t_reltols.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/PerComponentResidual/t_reltols.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/PerComponentResidual/t_reltols.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/c_Residual.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/Residual/c_Residual.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/c_Residual.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/t_abstol.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/Residual/t_abstol.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/t_abstol.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/t_norm_type.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/Residual/t_norm_type.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/t_norm_type.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/t_reltol.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/Residual/t_reltol.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/Residual/t_reltol.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/i_convergence_criterion.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/i_convergence_criterion.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/i_convergence_criterion.md diff --git a/Documentation/ProjectFile/process/convergence_criterion/t_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/t_type.md similarity index 100% rename from Documentation/ProjectFile/process/convergence_criterion/t_type.md rename to Documentation/ProjectFile/prj/time_loop/processes/process/convergence_criterion/t_type.md diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/i_process.md b/Documentation/ProjectFile/prj/time_loop/processes/process/i_process.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/i_process.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/output/i_output.md b/Documentation/ProjectFile/prj/time_loop/processes/process/output/i_output.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/output/i_output.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/output/t_output_extrapolation_residuals.md b/Documentation/ProjectFile/prj/time_loop/processes/process/output/t_output_extrapolation_residuals.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/output/t_output_extrapolation_residuals.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/output/variables/i_variables.md b/Documentation/ProjectFile/prj/time_loop/processes/process/output/variables/i_variables.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/output/variables/i_variables.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/output/variables/t_variable.md b/Documentation/ProjectFile/prj/time_loop/processes/process/output/variables/t_variable.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/output/variables/t_variable.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/t_nonlinear_solver.md b/Documentation/ProjectFile/prj/time_loop/processes/process/t_nonlinear_solver.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/t_nonlinear_solver.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardDifferentiationFormula/c_BackwardDifferentiationFormula.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardDifferentiationFormula/c_BackwardDifferentiationFormula.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardDifferentiationFormula/c_BackwardDifferentiationFormula.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardDifferentiationFormula/t_order.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardDifferentiationFormula/t_order.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardDifferentiationFormula/t_order.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardEuler/c_BackwardEuler.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardEuler/c_BackwardEuler.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/BackwardEuler/c_BackwardEuler.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/CrankNicolson/c_CrankNicolson.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/CrankNicolson/c_CrankNicolson.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/CrankNicolson/c_CrankNicolson.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/CrankNicolson/t_theta.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/CrankNicolson/t_theta.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/CrankNicolson/t_theta.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/ForwardEuler/c_ForwardEuler.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/ForwardEuler/c_ForwardEuler.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/ForwardEuler/c_ForwardEuler.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/i_time_discretization.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/i_time_discretization.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/i_time_discretization.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/t_type.md b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/t_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/processes/process/time_discretization/t_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/c_FixedTimeStepping.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_end.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_initial.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_initial.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/t_t_initial.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/i_timesteps.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/i_pair.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/t_delta_t.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/FixedTimeStepping/timesteps/pair/t_repeat.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/SingleStep/c_SingleStep.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/SingleStep/c_SingleStep.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/SingleStep/c_SingleStep.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/i_time_stepping.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md b/Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/prj/time_loop/time_stepping/t_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/HEAT_CONDUCTION/c_HEAT_CONDUCTION.md b/Documentation/ProjectFile/process/HEAT_CONDUCTION/c_HEAT_CONDUCTION.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/HEAT_CONDUCTION/c_HEAT_CONDUCTION.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/HEAT_CONDUCTION/process_variables/i_process_variables.md b/Documentation/ProjectFile/process/HEAT_CONDUCTION/process_variables/i_process_variables.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/HEAT_CONDUCTION/process_variables/i_process_variables.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/HEAT_CONDUCTION/process_variables/t_process_variable.md b/Documentation/ProjectFile/process/HEAT_CONDUCTION/process_variables/t_process_variable.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/HEAT_CONDUCTION/process_variables/t_process_variable.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_density.md b/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_density.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_density.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_heat_capacity.md b/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_heat_capacity.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_heat_capacity.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_thermal_conductivity.md b/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_thermal_conductivity.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/HEAT_CONDUCTION/t_thermal_conductivity.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/SMALL_DEFORMATION/constitutive_relation/t_type.md b/Documentation/ProjectFile/process/SMALL_DEFORMATION/constitutive_relation/t_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/SMALL_DEFORMATION/constitutive_relation/t_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/calculatesurfaceflux/i_calculatesurfaceflux.md b/Documentation/ProjectFile/process/calculatesurfaceflux/i_calculatesurfaceflux.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/calculatesurfaceflux/i_calculatesurfaceflux.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/calculatesurfaceflux/t_mesh.md b/Documentation/ProjectFile/process/calculatesurfaceflux/t_mesh.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/calculatesurfaceflux/t_mesh.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/calculatesurfaceflux/t_output_mesh.md b/Documentation/ProjectFile/process/calculatesurfaceflux/t_output_mesh.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/calculatesurfaceflux/t_output_mesh.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/calculatesurfaceflux/t_property_name.md b/Documentation/ProjectFile/process/calculatesurfaceflux/t_property_name.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/calculatesurfaceflux/t_property_name.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/jacobian_assembler/i_jacobian_assembler.md b/Documentation/ProjectFile/process/jacobian_assembler/i_jacobian_assembler.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/jacobian_assembler/i_jacobian_assembler.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/jacobian_assembler/t_component_magnitudes.md b/Documentation/ProjectFile/process/jacobian_assembler/t_component_magnitudes.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/jacobian_assembler/t_component_magnitudes.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/jacobian_assembler/t_relative_epsilons.md b/Documentation/ProjectFile/process/jacobian_assembler/t_relative_epsilons.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/jacobian_assembler/t_relative_epsilons.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/jacobian_assembler/t_type.md b/Documentation/ProjectFile/process/jacobian_assembler/t_type.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/jacobian_assembler/t_type.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/Documentation/ProjectFile/process/t_name.md b/Documentation/ProjectFile/process/t_name.md new file mode 100644 index 0000000000000000000000000000000000000000..576add64edccf5d980a0ff86143dc43a7109a788 --- /dev/null +++ b/Documentation/ProjectFile/process/t_name.md @@ -0,0 +1 @@ +\ogs_missing_documentation diff --git a/MaterialLib/Fluid/Density/createFluidDensityModel.cpp b/MaterialLib/Fluid/Density/createFluidDensityModel.cpp index bf7f23e3cacf6cb611562cb219bc521b8ce51c80..ec380411d0b468322e6fe28d327192635e941918 100644 --- a/MaterialLib/Fluid/Density/createFluidDensityModel.cpp +++ b/MaterialLib/Fluid/Density/createFluidDensityModel.cpp @@ -74,21 +74,17 @@ std::unique_ptr<FluidProperty> createFluidDensityModel( if (type == "Constant") { return std::unique_ptr<FluidProperty>(new ConstantFluidProperty( - //! \ogs_file_param{material__fluid__density__Constant_value} + //! \ogs_file_param{material__fluid__density__value} config.getConfigParameter<double>("value"))); } - //! \ogs_file_param{material__fluid__density__LiquidDensity} else if (type == "LiquidDensity") return createLiquidDensity(config); - - //! \ogs_file_param{material__fluid__density__TemperatureDependent} else if (type == "TemperatureDependent") return createLinearTemperatureDependentDensity(config); - //! \ogs_file_param{material__fluid__density__IdealGasLaw} else if (type == "IdealGasLaw") { - //! \ogs_file_param{material__fluid__density__IdealGasLaw__molar_mass} return std::unique_ptr<FluidProperty>( + //! \ogs_file_param{material__fluid__density__IdealGasLaw__molar_mass} new IdealGasLaw(config.getConfigParameter<double>("molar_mass"))); } else diff --git a/MaterialLib/Fluid/Viscosity/createViscosityModel.cpp b/MaterialLib/Fluid/Viscosity/createViscosityModel.cpp index 2d82e0e66a21662b2d9d9417b2e04e6da5c3f860..3cc564b1c9742e033174f863f078f863845e604f 100644 --- a/MaterialLib/Fluid/Viscosity/createViscosityModel.cpp +++ b/MaterialLib/Fluid/Viscosity/createViscosityModel.cpp @@ -80,7 +80,7 @@ std::unique_ptr<FluidProperty> createViscosityModel( { INFO("Using Vogels model, which gives viscosity in SI unit, Pa s"); auto const fluid_type = - //! \ogs_file_param{material__fluid__viscosity__Vogels__fluid_type} + //! \ogs_file_param{material__fluid__viscosity__Vogels__liquid_type} config.getConfigParameter<std::string>("liquid_type"); if (fluid_type == "Water") { diff --git a/MaterialLib/SolidModels/CreateLinearElasticIsotropic.h b/MaterialLib/SolidModels/CreateLinearElasticIsotropic.h index e968212edc52a9ec12b0fe755e73e93dfeea9415..9471731ebc3f90f62e50824af40be84dddabde9e 100644 --- a/MaterialLib/SolidModels/CreateLinearElasticIsotropic.h +++ b/MaterialLib/SolidModels/CreateLinearElasticIsotropic.h @@ -24,17 +24,20 @@ createLinearElasticIsotropic( std::vector<std::unique_ptr<ProcessLib::ParameterBase>> const& parameters, BaseLib::ConfigTree const& config) { + //! \ogs_file_param{process__SMALL_DEFORMATION__constitutive_relation__type} config.checkConfigParameter("type", "LinearElasticIsotropic"); DBUG("Create LinearElasticIsotropic material"); // Youngs modulus auto& youngs_modulus = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__LinearElasticIsotropic__youngs_modulus} config, "youngs_modulus", parameters, 1); DBUG("Use '%s' as youngs_modulus parameter.", youngs_modulus.name.c_str()); // Poissons ratio auto& poissons_ratio = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__LinearElasticIsotropic__poissons_ratio} config, "poissons_ratio", parameters, 1); DBUG("Use '%s' as poissons_ratio parameter.", poissons_ratio.name.c_str()); diff --git a/MaterialLib/SolidModels/CreateLubby2.h b/MaterialLib/SolidModels/CreateLubby2.h index d06dad3c2e3be9fa054c65cc79332fa0afd516c4..14d05ebb05bb234a8e0c9a5331709f1028e83736 100644 --- a/MaterialLib/SolidModels/CreateLubby2.h +++ b/MaterialLib/SolidModels/CreateLubby2.h @@ -25,11 +25,13 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( std::vector<std::unique_ptr<ProcessLib::ParameterBase>> const& parameters, BaseLib::ConfigTree const& config) { + //! \ogs_file_param{process__SMALL_DEFORMATION__constitutive_relation__type} config.checkConfigParameter("type", "Lubby2"); DBUG("Create Lubby2 material"); // Kelvin shear modulus. auto& kelvin_shear_modulus = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__kelvin_shear_modulus} config, "kelvin_shear_modulus", parameters, 1); DBUG("Use '%s' as kelvin shear modulus parameter.", @@ -37,6 +39,7 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( // Kelvin viscosity. auto& kelvin_viscosity = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__kelvin_viscosity} config, "kelvin_viscosity", parameters, 1); DBUG("Use '%s' as kelvin viscosity parameter.", @@ -44,6 +47,7 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( // Maxwell shear modulus. auto& maxwell_shear_modulus = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__maxwell_shear_modulus} config, "maxwell_shear_modulus", parameters, 1); DBUG("Use '%s' as maxwell shear modulus parameter.", @@ -51,6 +55,7 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( // Maxwell bulk modulus. auto& maxwell_bulk_modulus = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__maxwell_bulk_modulus} config, "maxwell_bulk_modulus", parameters, 1); DBUG("Use '%s' as maxwell bulk modulus parameter.", @@ -58,6 +63,7 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( // Maxwell viscosity. auto& maxwell_viscosity = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__maxwell_viscosity} config, "maxwell_viscosity", parameters, 1); DBUG("Use '%s' as maxwell viscosity parameter.", @@ -65,6 +71,7 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( // Dependency parameter for mK. auto& dependency_parameter_mK = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__dependency_parameter_mk} config, "dependency_parameter_mk", parameters, 1); DBUG("Use '%s' as dependency parameter mK.", @@ -72,6 +79,7 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( // Dependency parameter for mvK. auto& dependency_parameter_mvK = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__dependency_parameter_mvk} config, "dependency_parameter_mvk", parameters, 1); DBUG("Use '%s' as dependency parameter mvK.", @@ -79,6 +87,7 @@ std::unique_ptr<MechanicsBase<DisplacementDim>> createLubby2( // Dependency parameter for mvM. auto& dependency_parameter_mvM = ProcessLib::findParameter<double>( + //! \ogs_file_param_special{process__SMALL_DEFORMATION__constitutive_relation__Lubby2__dependency_parameter_mvm} config, "dependency_parameter_mvm", parameters, 1); DBUG("Use '%s' as dependency parameter mvM.", diff --git a/NumLib/ODESolver/ConvergenceCriterion.cpp b/NumLib/ODESolver/ConvergenceCriterion.cpp index 42191dc81cfc76931da4b918dc970f44f949aa20..ede0da8851c1998e02da763d21ba2e25a311f943 100644 --- a/NumLib/ODESolver/ConvergenceCriterion.cpp +++ b/NumLib/ODESolver/ConvergenceCriterion.cpp @@ -21,7 +21,7 @@ namespace NumLib std::unique_ptr<ConvergenceCriterion> createConvergenceCriterion( const BaseLib::ConfigTree& config) { - //! \ogs_file_param{process__convergence_criterion__type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__type} auto const type = config.peekConfigParameter<std::string>("type"); if (type == "DeltaX") { diff --git a/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp b/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp index 8f903ee4996159874a297f3a20bf16b363f872be..a1dfe9e5c7fdeb224d5f1ff90bb089a27a6ff6fa 100644 --- a/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionDeltaX.cpp @@ -54,15 +54,15 @@ void ConvergenceCriterionDeltaX::checkDeltaX(const GlobalVector& minus_delta_x, std::unique_ptr<ConvergenceCriterionDeltaX> createConvergenceCriterionDeltaX( const BaseLib::ConfigTree& config) { - //! \ogs_file_param{process__convergence_criterion__type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__type} config.checkConfigParameter("type", "DeltaX"); - //! \ogs_file_param{process__convergence_criterion__DeltaX__abstol} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__DeltaX__abstol} auto abstol = config.getConfigParameterOptional<double>("abstol"); - //! \ogs_file_param{process__convergence_criterion__DeltaX__reltol} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__DeltaX__reltol} auto reltol = config.getConfigParameterOptional<double>("reltol"); auto const norm_type_str = - //! \ogs_file_param{process__convergence_criterion__DeltaX__norm_type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__DeltaX__norm_type} config.getConfigParameter<std::string>("norm_type"); auto const norm_type = MathLib::convertStringToVecNormType(norm_type_str); diff --git a/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp b/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp index 6fac5ce794580a4eca4144cd4621c829238da9eb..35c4e826e90845c9d5623fcf2bc9e8cad223aad0 100644 --- a/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionPerComponentDeltaX.cpp @@ -80,17 +80,17 @@ void ConvergenceCriterionPerComponentDeltaX::setDOFTable( std::unique_ptr<ConvergenceCriterionPerComponentDeltaX> createConvergenceCriterionPerComponentDeltaX(const BaseLib::ConfigTree& config) { - //! \ogs_file_param{process__convergence_criterion__type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__type} config.checkConfigParameter("type", "PerComponentDeltaX"); auto abstols = - //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__abstols} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__PerComponentDeltaX__abstols} config.getConfigParameterOptional<std::vector<double>>("abstols"); auto reltols = - //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__reltols} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__PerComponentDeltaX__reltols} config.getConfigParameterOptional<std::vector<double>>("reltols"); auto const norm_type_str = - //! \ogs_file_param{process__convergence_criterion__PerComponentDeltaX__norm_type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__PerComponentDeltaX__norm_type} config.getConfigParameter<std::string>("norm_type"); if ((!abstols) && (!reltols)) diff --git a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp index 4b8cad55d9337c645828838242e7fb14a8f6f76e..db4199d117c7ba6c7eb50590c1ada6989c780cc8 100644 --- a/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionPerComponentResidual.cpp @@ -90,17 +90,17 @@ std::unique_ptr<ConvergenceCriterionPerComponentResidual> createConvergenceCriterionPerComponentResidual( const BaseLib::ConfigTree& config) { - //! \ogs_file_param{process__convergence_criterion__type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__type} config.checkConfigParameter("type", "PerComponentResidual"); auto abstols = - //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__abstols} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__PerComponentResidual__abstols} config.getConfigParameterOptional<std::vector<double>>("abstols"); auto reltols = - //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__reltols} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__PerComponentResidual__reltols} config.getConfigParameterOptional<std::vector<double>>("reltols"); auto const norm_type_str = - //! \ogs_file_param{process__convergence_criterion__PerComponentResidual__norm_type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__PerComponentResidual__norm_type} config.getConfigParameter<std::string>("norm_type"); if ((!abstols) && (!reltols)) diff --git a/NumLib/ODESolver/ConvergenceCriterionResidual.cpp b/NumLib/ODESolver/ConvergenceCriterionResidual.cpp index 96a5b7c338ca6b5ba9e6449e3ccf790351e1bb22..04222e2be306ad3e1bebc2428320556e38c01ca1 100644 --- a/NumLib/ODESolver/ConvergenceCriterionResidual.cpp +++ b/NumLib/ODESolver/ConvergenceCriterionResidual.cpp @@ -58,15 +58,15 @@ void ConvergenceCriterionResidual::checkResidual(const GlobalVector& residual) std::unique_ptr<ConvergenceCriterionResidual> createConvergenceCriterionResidual(const BaseLib::ConfigTree& config) { - //! \ogs_file_param{process__convergence_criterion__type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__type} config.checkConfigParameter("type", "Residual"); - //! \ogs_file_param{process__convergence_criterion__Residual__abstol} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__Residual__abstol} auto abstol = config.getConfigParameterOptional<double>("abstol"); - //! \ogs_file_param{process__convergence_criterion__Residual__reltol} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__Residual__reltol} auto reltol = config.getConfigParameterOptional<double>("reltol"); auto const norm_type_str = - //! \ogs_file_param{process__convergence_criterion__Residual__norm_type} + //! \ogs_file_param{prj__time_loop__processes__process__convergence_criterion__Residual__norm_type} config.getConfigParameter<std::string>("norm_type"); auto const norm_type = MathLib::convertStringToVecNormType(norm_type_str); diff --git a/NumLib/ODESolver/TimeDiscretizationBuilder.cpp b/NumLib/ODESolver/TimeDiscretizationBuilder.cpp index a347b2223aef3b54e58bdf04b01e79c510dfe957..fe572d1fa6933971ab888340fbd0f19ed469b97e 100644 --- a/NumLib/ODESolver/TimeDiscretizationBuilder.cpp +++ b/NumLib/ODESolver/TimeDiscretizationBuilder.cpp @@ -18,31 +18,31 @@ std::unique_ptr<TimeDiscretization> createTimeDiscretization( { using T = std::unique_ptr<TimeDiscretization>; - //! \ogs_file_param{process__time_discretization__type} + //! \ogs_file_param{prj__time_loop__processes__process__time_discretization__type} auto const type = config.getConfigParameter<std::string>("type"); if (type == "BackwardEuler") { - //! \ogs_file_param_special{process__time_discretization__BackwardEuler} + //! \ogs_file_param_special{prj__time_loop__processes__process__time_discretization__BackwardEuler} using ConcreteTD = BackwardEuler; return T(new ConcreteTD); } else if (type == "ForwardEuler") { - //! \ogs_file_param_special{process__time_discretization__ForwardEuler} + //! \ogs_file_param_special{prj__time_loop__processes__process__time_discretization__ForwardEuler} using ConcreteTD = ForwardEuler; return T(new ConcreteTD); } else if (type == "CrankNicolson") { - //! \ogs_file_param{process__time_discretization__CrankNicolson__theta} + //! \ogs_file_param{prj__time_loop__processes__process__time_discretization__CrankNicolson__theta} auto const theta = config.getConfigParameter<double>("theta"); using ConcreteTD = CrankNicolson; return T(new ConcreteTD(theta)); } else if (type == "BackwardDifferentiationFormula") { - //! \ogs_file_param{process__time_discretization__BackwardDifferentiationFormula__order} + //! \ogs_file_param{prj__time_loop__processes__process__time_discretization__BackwardDifferentiationFormula__order} auto const order = config.getConfigParameter<unsigned>("order"); using ConcreteTD = BackwardDifferentiationFormula; return T(new ConcreteTD(order)); diff --git a/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp b/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp index a852a5d3c727f2a611b25838d614ab6cc56fefc5..8376621268813f89c82341bd504833cfa647bc6f 100644 --- a/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp +++ b/NumLib/TimeStepping/Algorithms/FixedTimeStepping.cpp @@ -36,14 +36,14 @@ FixedTimeStepping::FixedTimeStepping(double t0, double tn, double dt) std::unique_ptr<ITimeStepAlgorithm> FixedTimeStepping::newInstance(BaseLib::ConfigTree const& config) { - //! \ogs_file_param{prj__time_stepping__type} + //! \ogs_file_param{prj__time_loop__time_stepping__type} config.checkConfigParameter("type", "FixedTimeStepping"); - //! \ogs_file_param{prj__time_stepping__FixedTimeStepping__t_initial} + //! \ogs_file_param{prj__time_loop__time_stepping__FixedTimeStepping__t_initial} auto const t_initial = config.getConfigParameter<double>("t_initial"); - //! \ogs_file_param{prj__time_stepping__FixedTimeStepping__t_end} + //! \ogs_file_param{prj__time_loop__time_stepping__FixedTimeStepping__t_end} auto const t_end = config.getConfigParameter<double>("t_end"); - //! \ogs_file_param{prj__time_stepping__FixedTimeStepping__timesteps} + //! \ogs_file_param{prj__time_loop__time_stepping__FixedTimeStepping__timesteps} auto const delta_ts = config.getConfigSubtree("timesteps"); std::vector<double> timesteps; @@ -51,16 +51,16 @@ FixedTimeStepping::newInstance(BaseLib::ConfigTree const& config) double delta_t = 0.0; // TODO: consider adding call "listNonEmpty" to config tree - //! \ogs_file_param{prj__time_stepping__FixedTimeStepping__timesteps__pair} + //! \ogs_file_param{prj__time_loop__time_stepping__FixedTimeStepping__timesteps__pair} auto const range = delta_ts.getConfigSubtreeList("pair"); if (range.begin() == range.end()) { OGS_FATAL("no timesteps have been given"); } for (auto const pair : range) { - //! \ogs_file_param{prj__time_stepping__FixedTimeStepping__timesteps__pair__repeat} + //! \ogs_file_param{prj__time_loop__time_stepping__FixedTimeStepping__timesteps__pair__repeat} auto const repeat = pair.getConfigParameter<std::size_t>("repeat"); - //! \ogs_file_param{prj__time_stepping__FixedTimeStepping__timesteps__pair__delta_t} + //! \ogs_file_param{prj__time_loop__time_stepping__FixedTimeStepping__timesteps__pair__delta_t} delta_t = pair.getConfigParameter<double>("delta_t"); if (repeat == 0) { diff --git a/ProcessLib/CalculateSurfaceFlux/ParseCalculateSurfaceFluxData.cpp b/ProcessLib/CalculateSurfaceFlux/ParseCalculateSurfaceFluxData.cpp index 3fbbf455a30ae6e1fd74f88d33452115a92c544a..1269639fc770ae19137edda4c4818228cf46e87a 100644 --- a/ProcessLib/CalculateSurfaceFlux/ParseCalculateSurfaceFluxData.cpp +++ b/ProcessLib/CalculateSurfaceFlux/ParseCalculateSurfaceFluxData.cpp @@ -23,14 +23,14 @@ void parseCalculateSurfaceFluxData(BaseLib::ConfigTree const& config, return; mesh_name = - //! \ogs_file_attr{process__calculatesurfaceflux__mesh} + //! \ogs_file_param{process__calculatesurfaceflux__mesh} calculatesurfaceflux_config->getConfigParameter<std::string>("mesh"); property_name = - //! \ogs_file_attr{process__calculatesurfaceflux__property_name} + //! \ogs_file_param{process__calculatesurfaceflux__property_name} calculatesurfaceflux_config->getConfigParameter<std::string>( "property_name"); out_fname = - //! \ogs_file_attr{process__calculatesurfaceflux__output_mesh} + //! \ogs_file_param{process__calculatesurfaceflux__output_mesh} calculatesurfaceflux_config->getConfigParameter<std::string>( "output_mesh"); } diff --git a/ProcessLib/CentralDifferencesJacobianAssembler.cpp b/ProcessLib/CentralDifferencesJacobianAssembler.cpp index e129d943c8da19335a98a752e13832dae2c4131b..24b02328aa664209ef8de6bb49bd4d5a502cf30b 100644 --- a/ProcessLib/CentralDifferencesJacobianAssembler.cpp +++ b/ProcessLib/CentralDifferencesJacobianAssembler.cpp @@ -130,11 +130,14 @@ void CentralDifferencesJacobianAssembler::assembleWithJacobian( std::unique_ptr<CentralDifferencesJacobianAssembler> createCentralDifferencesJacobianAssembler(BaseLib::ConfigTree const& config) { + //! \ogs_file_param{process__jacobian_assembler__type} config.checkConfigParameter("type", "CentralDifferences"); // TODO make non-optional. + //! \ogs_file_param{process__jacobian_assembler__relative_epsilons} auto rel_eps = config.getConfigParameterOptional<std::vector<double>>( "relative_epsilons"); + //! \ogs_file_param{process__jacobian_assembler__component_magnitudes} auto comp_mag = config.getConfigParameterOptional<std::vector<double>>( "component_magnitudes"); diff --git a/ProcessLib/CreateJacobianAssembler.cpp b/ProcessLib/CreateJacobianAssembler.cpp index d4b6788eab2fb6802aaafb02b0d7f328757965fe..d8ca0c5025a0ef9275bca6f1ff36ba44448e5964 100644 --- a/ProcessLib/CreateJacobianAssembler.cpp +++ b/ProcessLib/CreateJacobianAssembler.cpp @@ -22,6 +22,7 @@ std::unique_ptr<AbstractJacobianAssembler> createJacobianAssembler( return std::unique_ptr<AbstractJacobianAssembler>( new AnalyticalJacobianAssembler); + //! \ogs_file_param{process__jacobian_assembler__type} auto const type = config->peekConfigParameter<std::string>("type"); if (type == "Analytical") { diff --git a/ProcessLib/Output.cpp b/ProcessLib/Output.cpp index 24c871b8f6a78fb7c1ff2441fc8e9fbd71fbf56c..a9b1c05ad2db08f9291021f796d0e2f6a60b6d5a 100644 --- a/ProcessLib/Output.cpp +++ b/ProcessLib/Output.cpp @@ -49,24 +49,24 @@ std::unique_ptr<Output> Output:: newInstance(const BaseLib::ConfigTree &config, std::string const& output_directory) { auto const output_iteration_results = - //! \ogs_file_param{prj__output__output_iteration_results} + //! \ogs_file_param{prj__time_loop__output__output_iteration_results} config.getConfigParameterOptional<bool>("output_iteration_results"); std::unique_ptr<Output> out{new Output{ BaseLib::joinPaths(output_directory, - //! \ogs_file_param{prj__output__prefix} + //! \ogs_file_param{prj__time_loop__output__prefix} config.getConfigParameter<std::string>("prefix")), output_iteration_results ? *output_iteration_results : false}}; - //! \ogs_file_param{prj__output__timesteps} + //! \ogs_file_param{prj__time_loop__output__timesteps} if (auto const timesteps = config.getConfigSubtreeOptional("timesteps")) { - //! \ogs_file_param{prj__output__timesteps__pair} + //! \ogs_file_param{prj__time_loop__output__timesteps__pair} for (auto pair : timesteps->getConfigSubtreeList("pair")) { - //! \ogs_file_param{prj__output__timesteps__pair__repeat} + //! \ogs_file_param{prj__time_loop__output__timesteps__pair__repeat} auto repeat = pair.getConfigParameter<unsigned>("repeat"); - //! \ogs_file_param{prj__output__timesteps__pair__each_steps} + //! \ogs_file_param{prj__time_loop__output__timesteps__pair__each_steps} auto each_steps = pair.getConfigParameter<unsigned>("each_steps"); assert(repeat != 0 && each_steps != 0); diff --git a/ProcessLib/Parameter/GroupBasedParameter.cpp b/ProcessLib/Parameter/GroupBasedParameter.cpp index 7cca25ecce090f26de05d1b97423ea2144e60f35..5be4cb0da5fe411569a6bab452ae8ba13e82121a 100644 --- a/ProcessLib/Parameter/GroupBasedParameter.cpp +++ b/ProcessLib/Parameter/GroupBasedParameter.cpp @@ -22,7 +22,7 @@ std::unique_ptr<ParameterBase> createGroupBasedParameter( config.checkConfigParameter("type", "Group"); // get a property vector of group IDs - //! \ogs_file_param{parameter_Group__group_id_property} + //! \ogs_file_param{parameter__Group__group_id_property} std::string const group_id_property_name = config.getConfigParameter<std::string>("group_id_property"); DBUG("Using group_id_property %s", group_id_property_name.c_str()); @@ -36,13 +36,13 @@ std::unique_ptr<ParameterBase> createGroupBasedParameter( typedef std::vector<double> Values; typedef std::pair<int, Values> Index_Values; std::vector<Index_Values> vec_index_values; - //! \ogs_file_param{parameter_Group__index_values} + //! \ogs_file_param{parameter__Group__index_values} for (auto p : config.getConfigSubtreeList("index_values")) { - //! \ogs_file_param{parameter_Group__index_values__index} + //! \ogs_file_param{parameter__Group__index_values__index} auto const index = p.getConfigParameter<int>("index"); { - //! \ogs_file_param{parameter_Group__index_values__value} + //! \ogs_file_param{parameter__Group__index_values__value} auto const value = p.getConfigParameterOptional<double>("value"); if (value) @@ -54,7 +54,7 @@ std::unique_ptr<ParameterBase> createGroupBasedParameter( } // Value tag not available; continue with required values tag. - //! \ogs_file_param{parameter_Group__index_values__values} + //! \ogs_file_param{parameter__Group__index_values__values} Values const values = p.getConfigParameter<Values>("values"); if (values.empty()) diff --git a/ProcessLib/ProcessOutput.cpp b/ProcessLib/ProcessOutput.cpp index 0bac1d2701bea3abd2c252b3b593e95a630a1e96..a4c4ad055f73a0c623bfc3abfc4afb19dd924bb5 100644 --- a/ProcessLib/ProcessOutput.cpp +++ b/ProcessLib/ProcessOutput.cpp @@ -17,10 +17,10 @@ namespace ProcessLib ProcessOutput::ProcessOutput(BaseLib::ConfigTree const& output_config) { - //! \ogs_file_param{process__output__variables} + //! \ogs_file_param{prj__time_loop__processes__process__output__variables} auto const out_vars = output_config.getConfigSubtree("variables"); - //! \ogs_file_param{process__output__variables__variable} + //! \ogs_file_param{prj__time_loop__processes__process__output__variables__variable} for (auto out_var : out_vars.getConfigParameterList<std::string>("variable")) { if (output_variables.find(out_var) != output_variables.cend()) @@ -33,7 +33,7 @@ ProcessOutput::ProcessOutput(BaseLib::ConfigTree const& output_config) } if (auto out_resid = - //! \ogs_file_param{process__output__output_extrapolation_residuals} + //! \ogs_file_param{prj__time_loop__processes__process__output__output_extrapolation_residuals} output_config.getConfigParameterOptional<bool>("output_extrapolation_residuals")) { output_residuals = *out_resid; diff --git a/ProcessLib/SmallDeformation/CreateSmallDeformationProcess.cpp b/ProcessLib/SmallDeformation/CreateSmallDeformationProcess.cpp index ac6079963c9c01805d742e3c1d65a34612d90a44..4fa4be91509c0c8458f23a74643dd753f8f72d84 100644 --- a/ProcessLib/SmallDeformation/CreateSmallDeformationProcess.cpp +++ b/ProcessLib/SmallDeformation/CreateSmallDeformationProcess.cpp @@ -68,6 +68,7 @@ createSmallDeformationProcess( config.getConfigSubtree("constitutive_relation"); auto const type = + //! \ogs_file_param{process__SMALL_DEFORMATION__constitutive_relation__type} constitutive_relation_config.peekConfigParameter<std::string>("type"); std::unique_ptr<MaterialLib::Solids::MechanicsBase<DisplacementDim>> diff --git a/ProcessLib/UncoupledProcessesTimeLoop.cpp b/ProcessLib/UncoupledProcessesTimeLoop.cpp index 4324562487e93638e79968d3e1e167fa8f589066..aa5548d1a6c519be479558af526dd1f677b07da7 100644 --- a/ProcessLib/UncoupledProcessesTimeLoop.cpp +++ b/ProcessLib/UncoupledProcessesTimeLoop.cpp @@ -25,7 +25,7 @@ std::unique_ptr<NumLib::ITimeStepAlgorithm> createTimeStepper( if (type == "SingleStep") { - //! \ogs_file_param_special{prj__time_stepping__SingleStep} + //! \ogs_file_param_special{prj__time_loop__time_stepping__SingleStep} config.ignoreConfigParameter("type"); timestepper.reset(new NumLib::FixedTimeStepping(0.0, 1.0, 1.0)); } @@ -282,8 +282,8 @@ std::vector<std::unique_ptr<SingleProcessData>> createPerProcessData( processes, pcs_name, "A process with the given name has not been defined."); - //! \ogs_file_param{prj__time_loop__processes__process__nonlinear_solver} auto const nl_slv_name = + //! \ogs_file_param{prj__time_loop__processes__process__nonlinear_solver} pcs_config.getConfigParameter<std::string>("nonlinear_solver"); auto& nl_slv = *BaseLib::getOrError( nonlinear_solvers, nl_slv_name, @@ -298,8 +298,7 @@ std::vector<std::unique_ptr<SingleProcessData>> createPerProcessData( pcs_config.getConfigSubtree("convergence_criterion")); //! \ogs_file_param{prj__time_loop__processes__process__output} - ProcessOutput process_output{ - pcs_config.getConfigSubtree("output")}; + ProcessOutput process_output{pcs_config.getConfigSubtree("output")}; per_process_data.emplace_back(makeSingleProcessData( nl_slv, pcs, std::move(time_disc), std::move(conv_crit), @@ -321,16 +320,16 @@ std::unique_ptr<UncoupledProcessesTimeLoop> createUncoupledProcessesTimeLoop( const std::map<std::string, std::unique_ptr<NumLib::NonlinearSolverBase>>& nonlinear_solvers) { - //! \ogs_file_param{prj__time_loop__time_stepping} auto timestepper = + //! \ogs_file_param{prj__time_loop__time_stepping} createTimeStepper(config.getConfigSubtree("time_stepping")); - //! \ogs_file_param{prj__time_loop__output} auto output = + //! \ogs_file_param{prj__time_loop__output} createOutput(config.getConfigSubtree("output"), output_directory); - //! \ogs_file_param{prj__time_loop__processes} auto per_process_data = createPerProcessData( + //! \ogs_file_param{prj__time_loop__processes} config.getConfigSubtree("processes"), processes, nonlinear_solvers); return std::unique_ptr<UncoupledProcessesTimeLoop>{ diff --git a/scripts/doc/append-xml-tags.py b/scripts/doc/append-xml-tags.py index bdfc2b80514602135b5bd841ec9427ad177968ce..11f7a7a94fb59e72d9b6ee2a1a4d4e76b02b6254 100755 --- a/scripts/doc/append-xml-tags.py +++ b/scripts/doc/append-xml-tags.py @@ -36,7 +36,6 @@ docdir = os.path.join(docauxdir, "dox", "ProjectFile") # used to expand documentation entry points to full xml tag paths # that are used in the prj file. tag_path_expansion_table = { - "initial_condition": "process_variables.process_variable.initial_condition", "boundary_condition": "process_variables.process_variable.boundary_conditions.boundary_condition", "linear_solver": "linear_solvers.linear_solver", "process": "processes.process", diff --git a/scripts/doc/get-project-params.sh b/scripts/doc/get-project-params.sh index ae826269461b66db7c0474046533063209508725..8f1e5bc5379024624d3a8a20327e2b6c973c1558 100755 --- a/scripts/doc/get-project-params.sh +++ b/scripts/doc/get-project-params.sh @@ -22,18 +22,19 @@ cat <<"EOF" \ --exclude-dir '.git' \ --exclude-dir 'Tests' \ --exclude 'ConfigTree*.*' \ - -f - -r -n -o $color \ + -f - -r -n $color \ + -A 2 \ | cut -c $((${#srcdir} + 2))- //! \\ogs_file_\(param\|attr\){[A-Za-z_0-9]\+}\( \\todo .*\)\?$ //! \\ogs_file_special$ //! \\ogs_file_\(param\|attr\)_special{[A-Za-z_0-9]\+}\( \\todo .*\)\?$ -checkConfigParameter.*) -getConfigAttribute.*) -getConfigParameter.*) -getConfigSubtree.*) -ignoreConfigAttribute.*) -ignoreConfigParameter.*) -peekConfigParameter.*) +checkConfigParameter[^)]*)\? +getConfigAttribute[^)]*)\? +getConfigParameter[^)]*)\? +getConfigSubtree[^)]*)\? +ignoreConfigAttribute[^)]*)\? +ignoreConfigParameter[^)]*)\? +peekConfigParameter[^)]*)\? EOF # format as table: diff --git a/scripts/doc/linked-xml-file.py b/scripts/doc/linked-xml-file.py index 521e7fe0e983c152c0f0679df0248b60b35b07ec..e5d00b9789115c045f5bde0e8c9fc0b811c96637 100755 --- a/scripts/doc/linked-xml-file.py +++ b/scripts/doc/linked-xml-file.py @@ -34,7 +34,6 @@ docauxdir = os.path.abspath(docauxdir) outdir = os.path.join(docauxdir, "dox", "CTestProjectFiles") tag_path_expansion_table = { - "prj__process_variables__process_variable__initial_condition": "initial_condition", "prj__process_variables__process_variable__boundary_conditions__boundary_condition": "boundary_condition", "prj__linear_solvers__linear_solver": "linear_solver", "prj__processes__process": "process", diff --git a/scripts/doc/normalize-param-cache.py b/scripts/doc/normalize-param-cache.py index bf82a526999e8ea67a24f388038b835b6aefd3c4..2175daf84cf73eb9ced8f9b9d11f35b0573b04b4 100755 --- a/scripts/doc/normalize-param-cache.py +++ b/scripts/doc/normalize-param-cache.py @@ -21,11 +21,73 @@ comment_special = re.compile(r"//! \\ogs_file(_param|_attr)?_special(\{[A-Za-z_0 # capture #5 is the parameter name getter = re.compile(r'(get|check|ignore|peek)Config(Parameter|Attribute|Subtree)(List|Optional|All)?' - +r'(<.*>)?' - +r'\("([a-zA-Z_0-9:]+)"[,)]') + +r'\s*(<.*>)?' + +r'\s*\(\s*"([a-zA-Z_0-9:]+)"\s*[,)]') getter_special = re.compile(r'(get|check|ignore|peek)Config(Parameter|Attribute|Subtree)(List|Optional|All)?' - +r'(<.*>)?\(') + +r'\s*(<.*>)?\(') + + +# merge lines belonging together from grep -A 2 output. +def merge_lines(it): + buf = "" + buf_fn = "" + buf_lno = 0 + + for l in it: + l = l.strip() + if (not l) or l == "--": + # separator line + if buf_fn: + yield buf_fn, buf_lno, buf + buf = "" + buf_fn = "" + buf_lno = 0 + else: + m = re.match("(.*)([:-])([0-9]+)([:-])(.*)$", l) + assert m + assert m.group(2) == m.group(4) + fn = m.group(1) + lno = int(m.group(3)) + line = m.group(5) + msg = fn + m.group(2) + str(lno) + m.group(4) + line + + # remove non-doxygen comments + line = re.sub('/\*[^!*].*\*/|/\*\*/', '', line) + line = re.sub("//[^!*].*|//$", "", line, 1) + + if buf_fn: + if m.group(2) == ":": + # new location started, yield the old one + yield buf_fn, buf_lno, buf + buf = line + buf_fn = fn + buf_lno = lno + else: + # continuation line + assert buf_fn == fn + buf += " " + line + elif m.group(2) == ":": + buf = line + buf_fn = fn + buf_lno = lno + else: + # continuation line and empty buffer + pass + + if buf_fn and (comment.search(line) or comment_special.search(line)): + # make sure nothing can be appended to doxygen comment lines + yield buf_fn, buf_lno, buf + buf = "" + buf_lno = 0 + buf_fn = "" + + if buf_fn: + yield buf_fn, buf_lno, buf + + return + yield + state = "getter" path = "" @@ -34,16 +96,12 @@ line = "" tag_path_comment = "" param_or_attr_comment = "" -for inline in sys.stdin: +for inline in merge_lines(sys.stdin): oldpath = path; oldlineno = lineno; oldline = line - - path, lineno, line = inline.split(":", 2) + path, lineno, line = inline if path != oldpath: debug(path) - line = line.strip() - lineno = int(lineno) - m = comment.search(line) if m: if state != "getter":