Skip to content
Snippets Groups Projects
Commit a76be140 authored by Dmitri Naumov's avatar Dmitri Naumov
Browse files

Move boundary_condition documentation.

parent a2d45737
No related branches found
No related tags found
No related merge requests found
Showing
with 17 additions and 17 deletions
The name of the geometrical set (see \ref ogs_file_param__gml__name) in which
the \ref ogs_file_param__boundary_condition__geometry "geometry" is defined.
the \ref
ogs_file_param__prj__process_variables__process_variable__boundary_conditions__boundary_condition__geometry
"geometry" is defined.
Specifies a single boundary condition.
See \ref ogs_file_param__boundary_condition.
......@@ -31,7 +31,7 @@ std::unique_ptr<BoundaryCondition> BoundaryConditionBuilder::createBoundaryCondi
MeshGeoToolsLib::BoundaryElementsSearcher boundary_element_searcher(
mesh, mesh_node_searcher);
//! \ogs_file_param{boundary_condition__type}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__type}
auto const type = config.config.peekConfigParameter<std::string>("type");
if (type == "Dirichlet")
......
......@@ -68,10 +68,10 @@ std::unique_ptr<DirichletBoundaryCondition> createDirichletBoundaryCondition(
const std::vector<std::unique_ptr<ProcessLib::ParameterBase>>& parameters)
{
DBUG("Constructing DirichletBoundaryCondition from config.");
//! \ogs_file_param{boundary_condition__type}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__type}
config.checkConfigParameter("type", "Dirichlet");
//! \ogs_file_param{boundary_condition__Dirichlet__parameter}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__Dirichlet__parameter}
auto const param_name = config.getConfigParameter<std::string>("parameter");
DBUG("Using parameter %s", param_name.c_str());
......
......@@ -23,10 +23,10 @@ std::unique_ptr<NeumannBoundaryCondition> createNeumannBoundaryCondition(
std::vector<std::unique_ptr<ParameterBase>> const& parameters)
{
DBUG("Constructing Neumann BC from config.");
//! \ogs_file_param{boundary_condition__type}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__type}
config.checkConfigParameter("type", "Neumann");
//! \ogs_file_param{boundary_condition__Neumann__parameter}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__Neumann__parameter}
auto const param_name = config.getConfigParameter<std::string>("parameter");
DBUG("Using parameter %s", param_name.c_str());
......
......@@ -23,12 +23,12 @@ std::unique_ptr<RobinBoundaryCondition> createRobinBoundaryCondition(
std::vector<std::unique_ptr<ParameterBase>> const& parameters)
{
DBUG("Constructing RobinBcConfig from config.");
//! \ogs_file_param{boundary_condition__type}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__type}
config.checkConfigParameter("type", "Robin");
//! \ogs_file_param{boundary_condition__Robin__alpha}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__Robin__alpha}
auto const alpha_name = config.getConfigParameter<std::string>("alpha");
//! \ogs_file_param{boundary_condition__Robin__u_0}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__Robin__u_0}
auto const u_0_name = config.getConfigParameter<std::string>("u_0");
auto const& alpha = findParameter<double>(alpha_name, parameters, 1);
......
......@@ -33,10 +33,10 @@ std::unique_ptr<BoundaryCondition> createNeumannBoundaryCondition(
FractureProperty const& fracture_prop)
{
DBUG("Constructing Neumann BC from config.");
//! \ogs_file_param{boundary_condition__type}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__type}
config.checkConfigParameter("type", "Neumann");
//! \ogs_file_param{boundary_condition__Neumann__parameter}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__Neumann__parameter}
auto const param_name = config.getConfigParameter<std::string>("parameter");
DBUG("Using parameter %s", param_name.c_str());
......
......@@ -49,10 +49,10 @@ ProcessVariable::ProcessVariable(
bcs_config->getConfigSubtreeList("boundary_condition"))
{
auto const geometrical_set_name =
//! \ogs_file_param{boundary_condition__geometrical_set}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__geometrical_set}
bc_config.getConfigParameter<std::string>("geometrical_set");
auto const geometry_name =
//! \ogs_file_param{boundary_condition__geometry}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__geometry}
bc_config.getConfigParameter<std::string>("geometry");
GeoLib::GeoObject const* const geometry =
......@@ -69,7 +69,7 @@ ProcessVariable::ProcessVariable(
GeoLib::convertGeoTypeToString(geometry->getGeoType()).c_str());
auto component_id =
//! \ogs_file_param{boundary_condition__component}
//! \ogs_file_param{prj__process_variables__process_variable__boundary_conditions__boundary_condition__component}
bc_config.getConfigParameterOptional<int>("component");
if (!component_id)
......
......@@ -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 = {
"boundary_condition": "process_variables.process_variable.boundary_conditions.boundary_condition",
"linear_solver": "linear_solvers.linear_solver",
"process": "processes.process",
"parameter": "parameters.parameter",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment