From b44d2f7a289cd56a10e21fbb26cb6a0aa3c53d8e Mon Sep 17 00:00:00 2001
From: Christoph Lehmann <christoph.lehmann@ufz.de>
Date: Thu, 28 Sep 2023 10:10:04 +0200
Subject: [PATCH] [T, Doc] Renamed is_linear
ag -l -s 'is_linear' Documentation/ Tests/Data/ | xargs sed -i -e 's/is_linear/linear/g'
---
...olver_compute_only_upon_timestep_change.md | 6 ++--
.../SparseLU_is_linear/1d_decay_chain_GIA.xml | 2 +-
.../1d_decay_chain_GIA.xml | 2 +-
.../is_linear/1d_decay_chain_GIA.xml | 2 +-
.../1d_decay_chain_GIA.xml | 2 +-
.../performance_measurements.ipynb | 30 +++++++++----------
.../1d_decay_chain_GIA.xml | 2 +-
.../1d_decay_chain_GIA.xml | 2 +-
8 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_linear_solver_compute_only_upon_timestep_change.md b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_linear_solver_compute_only_upon_timestep_change.md
index dc4e00b0f4a..2160affa1b3 100644
--- a/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_linear_solver_compute_only_upon_timestep_change.md
+++ b/Documentation/ProjectFile/prj/processes/process/ComponentTransport/t_linear_solver_compute_only_upon_timestep_change.md
@@ -4,13 +4,13 @@ the linear solver will only do the `compute()`<sup>\*</sup> step if the timestep
changes.
This flag is a further optimization on top of the
-[\<is_linear\>](@ref ogs_file_param__prj__processes__process__ComponentTransport__is_linear)
+[\<linear\>](@ref ogs_file_param__prj__processes__process__ComponentTransport__linear)
flag.
-So the requirements of `<is_linear>` apply to this flag, too!
+So the requirements of `<linear>` apply to this flag, too!
\attention
This is an expert option. It comes with a number of further **requirements above
-those of `<is_linear>`**. These are:
+those of `<linear>`**. These are:
- The linear solver used to solve the process equations must be exclusively used
for a single process (or for a single `process_id` in the case of staggered
diff --git a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear/1d_decay_chain_GIA.xml b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear/1d_decay_chain_GIA.xml
index 1c821430cde..4c14f5288ba 100644
--- a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear/1d_decay_chain_GIA.xml
+++ b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear/1d_decay_chain_GIA.xml
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<OpenGeoSysProjectDiff base_file="../1d_decay_chain_GIA.prj">
<add sel="/*/processes/process">
- <is_linear>true</is_linear>
+ <linear>true</linear>
</add>
<remove sel="/*/linear_solvers/linear_solver/eigen" />
diff --git a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
index 55a5907a6c1..47e2f124dfa 100644
--- a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
+++ b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/SparseLU_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<OpenGeoSysProjectDiff base_file="../1d_decay_chain_GIA.prj">
<add sel="/*/processes/process">
- <is_linear>true</is_linear>
+ <linear>true</linear>
<linear_solver_compute_only_upon_timestep_change>true</linear_solver_compute_only_upon_timestep_change>
</add>
diff --git a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear/1d_decay_chain_GIA.xml b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear/1d_decay_chain_GIA.xml
index 35a742eda51..da4454fc483 100644
--- a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear/1d_decay_chain_GIA.xml
+++ b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear/1d_decay_chain_GIA.xml
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<OpenGeoSysProjectDiff base_file="../1d_decay_chain_GIA.prj">
<add sel="/*/processes/process">
- <is_linear>true</is_linear>
+ <linear>true</linear>
</add>
</OpenGeoSysProjectDiff>
diff --git a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
index 55aaf9b19f6..f6f2423fdd6 100644
--- a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
+++ b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<OpenGeoSysProjectDiff base_file="../1d_decay_chain_GIA.prj">
<add sel="/*/processes/process">
- <is_linear>true</is_linear>
+ <linear>true</linear>
<linear_solver_compute_only_upon_timestep_change>true</linear_solver_compute_only_upon_timestep_change>
</add>
</OpenGeoSysProjectDiff>
diff --git a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/performance_measurements.ipynb b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/performance_measurements.ipynb
index 85d9a2f7a89..73ddf389e3b 100644
--- a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/performance_measurements.ipynb
+++ b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/performance_measurements.ipynb
@@ -88,12 +88,12 @@
"# Considered cases\n",
"\n",
"1. base case\n",
- "2. `<is_linear>true</is_linear>`\n",
+ "2. `<linear>true</linear>`\n",
" * requires that global matrices `M`, `K` and right-hand side vector `b` assembled by the `ComponentTransport` process do not change over time (and do not depend on the solution)\n",
" * requires that BCs and STs do not depend on the solution\n",
" * performs only **one non-linear iteration per timestep**\n",
" * `ComponentTransport` process **caches assembled global matrices** (no re-assembly necessary)\n",
- "3. `<is_linear>true</is_linear>` and `<linear_solver_compute_only_upon_timestep_change>true</linear_solver_compute_only_upon_timestep_change>`\n",
+ "3. `<linear>true</linear>` and `<linear_solver_compute_only_upon_timestep_change>true</linear_solver_compute_only_upon_timestep_change>`\n",
" * requires additionally, that also the BC and ST contributions to the global matrices do not change over time (no time- or solution-dependent BCs or STs!)\n",
" * LU decomposition or preconditioner is **computed only upon timestep change**\n",
" * only implemented for linear solvers from the Eigen library, so far\n",
@@ -115,19 +115,19 @@
"source": [
"cases = [\n",
" [\"1 base\", \"./1d_decay_chain_GIA.prj\"],\n",
- " [\"2 linear\", \"is_linear/1d_decay_chain_GIA.xml\"],\n",
- " [\"3 linear & dt\", \"is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\"],\n",
+ " [\"2 linear\", \"linear/1d_decay_chain_GIA.xml\"],\n",
+ " [\"3 linear & dt\", \"linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\"],\n",
" [\"4 LU\", \"SparseLU/1d_decay_chain_GIA.xml\"],\n",
- " [\"5 LU & linear\", \"SparseLU_is_linear/1d_decay_chain_GIA.xml\"],\n",
+ " [\"5 LU & linear\", \"SparseLU_linear/1d_decay_chain_GIA.xml\"],\n",
" [\n",
" \"6 LU & linear & dt\",\n",
- " \"SparseLU_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\",\n",
+ " \"SparseLU_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\",\n",
" ],\n",
" [\"7 varying dt\", \"varying_dt/1d_decay_chain_GIA.xml\"],\n",
- " [\"8 varying dt & linear\", \"varying_dt_is_linear/1d_decay_chain_GIA.xml\"],\n",
+ " [\"8 varying dt & linear\", \"varying_dt_linear/1d_decay_chain_GIA.xml\"],\n",
" [\n",
" \"9 varying dt & linear & dt\",\n",
- " \"varying_dt_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\",\n",
+ " \"varying_dt_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\",\n",
" ],\n",
"]"
]
@@ -155,14 +155,14 @@
"output_type": "stream",
"text": [
"running case ./1d_decay_chain_GIA.prj\n",
- "running case is_linear/1d_decay_chain_GIA.xml\n",
- "running case is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\n",
+ "running case linear/1d_decay_chain_GIA.xml\n",
+ "running case linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\n",
"running case SparseLU/1d_decay_chain_GIA.xml\n",
- "running case SparseLU_is_linear/1d_decay_chain_GIA.xml\n",
- "running case SparseLU_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\n",
+ "running case SparseLU_linear/1d_decay_chain_GIA.xml\n",
+ "running case SparseLU_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\n",
"running case varying_dt/1d_decay_chain_GIA.xml\n",
- "running case varying_dt_is_linear/1d_decay_chain_GIA.xml\n",
- "running case varying_dt_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\n"
+ "running case varying_dt_linear/1d_decay_chain_GIA.xml\n",
+ "running case varying_dt_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml\n"
]
}
],
@@ -501,7 +501,7 @@
"id": "058305aa-e717-4dcf-989b-b58591494d87",
"metadata": {},
"source": [
- "* with `<is_linear>true<is_linear>` only one non-linear iteration is done per timestep."
+ "* with `<linear>true<linear>` only one non-linear iteration is done per timestep."
]
},
{
diff --git a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear/1d_decay_chain_GIA.xml b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear/1d_decay_chain_GIA.xml
index c68801d2a62..f2d747af71a 100644
--- a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear/1d_decay_chain_GIA.xml
+++ b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear/1d_decay_chain_GIA.xml
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<OpenGeoSysProjectDiff base_file="../1d_decay_chain_GIA.prj">
<add sel="/*/processes/process">
- <is_linear>true</is_linear>
+ <linear>true</linear>
</add>
<remove sel="/*/time_loop/processes/process/time_stepping/timesteps"/>
diff --git a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
index 4ec9cc4fc40..58e1864d759 100644
--- a/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
+++ b/Tests/Data/Parabolic/ComponentTransport/ReactiveTransport/DecayChain/GlobalImplicitApproach/varying_dt_is_linear_compute_only_on_dt_change/1d_decay_chain_GIA.xml
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding='ISO-8859-1'?>
<OpenGeoSysProjectDiff base_file="../1d_decay_chain_GIA.prj">
<add sel="/*/processes/process">
- <is_linear>true</is_linear>
+ <linear>true</linear>
<linear_solver_compute_only_upon_timestep_change>true</linear_solver_compute_only_upon_timestep_change>
</add>
--
GitLab