From 6ae12b1093fc1acdab341b419e161c9ade469ffd Mon Sep 17 00:00:00 2001
From: Kilian Weishaupt <kilian.weishaupt@iws.uni-stuttgart.de>
Date: Fri, 30 Oct 2020 13:22:29 +0100
Subject: [PATCH] [doc][material] Fix documentation of fluidMatrixInteraction
function
---
.../1p/sequential/test_diffusionspatialparams.hh | 2 +-
.../1p/sequential/test_diffusionspatialparams3d.hh | 2 +-
.../2p/sequential/test_3d2pspatialparams.hh | 2 +-
.../2p/sequential/test_impesadaptivespatialparams.hh | 2 +-
.../2p/sequential/test_impesspatialparams.hh | 2 +-
.../2p/sequential/test_mpfa2pspatialparams.hh | 2 +-
.../2p/sequential/test_transportspatialparams.hh | 2 +-
.../implicit/chemicalnonequilibrium/spatialparams.hh | 2 +-
.../2p2c/implicit/waterair/spatialparams.hh | 2 +-
.../2p2c/sequential/test_dec2p2c_spatialparams.hh | 2 +-
.../2pnc/implicit/diffusion/spatialparams.hh | 2 +-
.../2pnc/implicit/fuelcell/spatialparams.hh | 2 +-
.../2pncmin/implicit/isothermal/spatialparams.hh | 2 +-
.../2pncmin/implicit/nonisothermal/spatialparams.hh | 2 +-
.../3p/implicit/infiltration/spatialparams.hh | 2 +-
test/porousmediumflow/co2/implicit/spatialparams.hh | 2 +-
.../mpnc/implicit/kinetic/spatialparams.hh | 10 +++++-----
.../mpnc/implicit/obstacle/spatialparams.hh | 2 +-
.../implicit/thermalnonequilibrium/spatialparams.hh | 2 +-
.../richards/implicit/analytical/spatialparams.hh | 2 +-
.../richards/implicit/lens/spatialparams.hh | 4 ++--
.../richards/implicit/nonisothermal/spatialparams.hh | 2 +-
.../richardsnc/implicit/spatialparams.hh | 2 +-
23 files changed, 28 insertions(+), 28 deletions(-)
diff --git a/test/porousmediumflow/1p/sequential/test_diffusionspatialparams.hh b/test/porousmediumflow/1p/sequential/test_diffusionspatialparams.hh
index 0cb1c59956..87ad388043 100644
--- a/test/porousmediumflow/1p/sequential/test_diffusionspatialparams.hh
+++ b/test/porousmediumflow/1p/sequential/test_diffusionspatialparams.hh
@@ -88,7 +88,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/1p/sequential/test_diffusionspatialparams3d.hh b/test/porousmediumflow/1p/sequential/test_diffusionspatialparams3d.hh
index 11694890da..4dc891770d 100644
--- a/test/porousmediumflow/1p/sequential/test_diffusionspatialparams3d.hh
+++ b/test/porousmediumflow/1p/sequential/test_diffusionspatialparams3d.hh
@@ -84,7 +84,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/2p/sequential/test_3d2pspatialparams.hh b/test/porousmediumflow/2p/sequential/test_3d2pspatialparams.hh
index 9f243fb561..eefa797640 100644
--- a/test/porousmediumflow/2p/sequential/test_3d2pspatialparams.hh
+++ b/test/porousmediumflow/2p/sequential/test_3d2pspatialparams.hh
@@ -94,7 +94,7 @@ public:
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/2p/sequential/test_impesadaptivespatialparams.hh b/test/porousmediumflow/2p/sequential/test_impesadaptivespatialparams.hh
index da2742e91c..4c67c969df 100644
--- a/test/porousmediumflow/2p/sequential/test_impesadaptivespatialparams.hh
+++ b/test/porousmediumflow/2p/sequential/test_impesadaptivespatialparams.hh
@@ -83,7 +83,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/2p/sequential/test_impesspatialparams.hh b/test/porousmediumflow/2p/sequential/test_impesspatialparams.hh
index f2c62155a7..c2435326d7 100644
--- a/test/porousmediumflow/2p/sequential/test_impesspatialparams.hh
+++ b/test/porousmediumflow/2p/sequential/test_impesspatialparams.hh
@@ -83,7 +83,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/2p/sequential/test_mpfa2pspatialparams.hh b/test/porousmediumflow/2p/sequential/test_mpfa2pspatialparams.hh
index 9b52441ba2..d758aef5ec 100644
--- a/test/porousmediumflow/2p/sequential/test_mpfa2pspatialparams.hh
+++ b/test/porousmediumflow/2p/sequential/test_mpfa2pspatialparams.hh
@@ -107,7 +107,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/2p/sequential/test_transportspatialparams.hh b/test/porousmediumflow/2p/sequential/test_transportspatialparams.hh
index 77a915c561..b16a128274 100644
--- a/test/porousmediumflow/2p/sequential/test_transportspatialparams.hh
+++ b/test/porousmediumflow/2p/sequential/test_transportspatialparams.hh
@@ -83,7 +83,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
diff --git a/test/porousmediumflow/2p2c/implicit/chemicalnonequilibrium/spatialparams.hh b/test/porousmediumflow/2p2c/implicit/chemicalnonequilibrium/spatialparams.hh
index 73efbc3e0a..4a917e81a8 100644
--- a/test/porousmediumflow/2p2c/implicit/chemicalnonequilibrium/spatialparams.hh
+++ b/test/porousmediumflow/2p2c/implicit/chemicalnonequilibrium/spatialparams.hh
@@ -102,7 +102,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
{
diff --git a/test/porousmediumflow/2p2c/implicit/waterair/spatialparams.hh b/test/porousmediumflow/2p2c/implicit/waterair/spatialparams.hh
index 138079d15f..0ee720606f 100644
--- a/test/porousmediumflow/2p2c/implicit/waterair/spatialparams.hh
+++ b/test/porousmediumflow/2p2c/implicit/waterair/spatialparams.hh
@@ -127,7 +127,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/test/porousmediumflow/2p2c/sequential/test_dec2p2c_spatialparams.hh b/test/porousmediumflow/2p2c/sequential/test_dec2p2c_spatialparams.hh
index 1843367baf..cbbc484c06 100644
--- a/test/porousmediumflow/2p2c/sequential/test_dec2p2c_spatialparams.hh
+++ b/test/porousmediumflow/2p2c/sequential/test_dec2p2c_spatialparams.hh
@@ -80,7 +80,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/2pnc/implicit/diffusion/spatialparams.hh b/test/porousmediumflow/2pnc/implicit/diffusion/spatialparams.hh
index 71cf16416c..e291b2a8fb 100644
--- a/test/porousmediumflow/2pnc/implicit/diffusion/spatialparams.hh
+++ b/test/porousmediumflow/2pnc/implicit/diffusion/spatialparams.hh
@@ -85,7 +85,7 @@ public:
{ return 0.2; }
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/2pnc/implicit/fuelcell/spatialparams.hh b/test/porousmediumflow/2pnc/implicit/fuelcell/spatialparams.hh
index 6efbf239cb..6292e4659f 100644
--- a/test/porousmediumflow/2pnc/implicit/fuelcell/spatialparams.hh
+++ b/test/porousmediumflow/2pnc/implicit/fuelcell/spatialparams.hh
@@ -84,7 +84,7 @@ public:
{ return 0.2; }
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
diff --git a/test/porousmediumflow/2pncmin/implicit/isothermal/spatialparams.hh b/test/porousmediumflow/2pncmin/implicit/isothermal/spatialparams.hh
index c0a59da7da..38ff739939 100644
--- a/test/porousmediumflow/2pncmin/implicit/isothermal/spatialparams.hh
+++ b/test/porousmediumflow/2pncmin/implicit/isothermal/spatialparams.hh
@@ -129,7 +129,7 @@ public:
{ return 10.0; }
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
diff --git a/test/porousmediumflow/2pncmin/implicit/nonisothermal/spatialparams.hh b/test/porousmediumflow/2pncmin/implicit/nonisothermal/spatialparams.hh
index e3985f9e08..b0f95c1486 100644
--- a/test/porousmediumflow/2pncmin/implicit/nonisothermal/spatialparams.hh
+++ b/test/porousmediumflow/2pncmin/implicit/nonisothermal/spatialparams.hh
@@ -130,7 +130,7 @@ public:
{ return 10.0; }
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
diff --git a/test/porousmediumflow/3p/implicit/infiltration/spatialparams.hh b/test/porousmediumflow/3p/implicit/infiltration/spatialparams.hh
index 42c0ccf0da..bc0b79e05a 100644
--- a/test/porousmediumflow/3p/implicit/infiltration/spatialparams.hh
+++ b/test/porousmediumflow/3p/implicit/infiltration/spatialparams.hh
@@ -143,7 +143,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/co2/implicit/spatialparams.hh b/test/porousmediumflow/co2/implicit/spatialparams.hh
index 43d2c5016a..8cfeada7b7 100644
--- a/test/porousmediumflow/co2/implicit/spatialparams.hh
+++ b/test/porousmediumflow/co2/implicit/spatialparams.hh
@@ -167,7 +167,7 @@ public:
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
diff --git a/test/porousmediumflow/mpnc/implicit/kinetic/spatialparams.hh b/test/porousmediumflow/mpnc/implicit/kinetic/spatialparams.hh
index c1c2d0f1fc..ca8ba66062 100644
--- a/test/porousmediumflow/mpnc/implicit/kinetic/spatialparams.hh
+++ b/test/porousmediumflow/mpnc/implicit/kinetic/spatialparams.hh
@@ -196,7 +196,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
const NonwettingSolidInterfacialArea& nonwettingSolidInterfacialAreaAtPos(const GlobalPosition &globalPos) const
@@ -209,7 +209,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
const WettingSolidInterfacialArea& wettingSolidInterfacialAreaAtPos(const GlobalPosition &globalPos) const
@@ -218,7 +218,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
const WettingNonwettingInterfacialArea& wettingNonwettingInterfacialAreaAtPos(const GlobalPosition &globalPos) const
@@ -232,7 +232,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*/
template<class ElementSolution>
auto fluidMatrixInteraction(const Element& element,
@@ -243,7 +243,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
{
diff --git a/test/porousmediumflow/mpnc/implicit/obstacle/spatialparams.hh b/test/porousmediumflow/mpnc/implicit/obstacle/spatialparams.hh
index a7843b2526..5b60e7488a 100644
--- a/test/porousmediumflow/mpnc/implicit/obstacle/spatialparams.hh
+++ b/test/porousmediumflow/mpnc/implicit/obstacle/spatialparams.hh
@@ -89,7 +89,7 @@ public:
{ return porosity_; }
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
{
diff --git a/test/porousmediumflow/mpnc/implicit/thermalnonequilibrium/spatialparams.hh b/test/porousmediumflow/mpnc/implicit/thermalnonequilibrium/spatialparams.hh
index bcef6650c9..f273a4e84f 100644
--- a/test/porousmediumflow/mpnc/implicit/thermalnonequilibrium/spatialparams.hh
+++ b/test/porousmediumflow/mpnc/implicit/thermalnonequilibrium/spatialparams.hh
@@ -189,7 +189,7 @@ public:
Scalar interfacialTension() const { return interfacialTension_ ; }
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
diff --git a/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh b/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh
index 6a450aa0e8..62c184ac94 100644
--- a/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh
+++ b/test/porousmediumflow/richards/implicit/analytical/spatialparams.hh
@@ -82,7 +82,7 @@ public:
{ return 0.4; }
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos A global coordinate vector
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition &globalPos) const
diff --git a/test/porousmediumflow/richards/implicit/lens/spatialparams.hh b/test/porousmediumflow/richards/implicit/lens/spatialparams.hh
index 100ecb90da..34468ca84d 100644
--- a/test/porousmediumflow/richards/implicit/lens/spatialparams.hh
+++ b/test/porousmediumflow/richards/implicit/lens/spatialparams.hh
@@ -102,7 +102,7 @@ public:
{ return 0.4; }
/*!
- * \brief Returns the parameters for the material law for the sub-control volume
+ * \brief Returns the fluid-matrix interaction law for the sub-control volume
*
* This method is not actually required by the Richards model, but provided
* for the convenience of the RichardsLensProblem
@@ -122,7 +122,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* This method is not actually required by the Richards model, but provided
* for the convenience of the RichardsLensProblem
diff --git a/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh b/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh
index 7afce1ac6a..31ff4d0377 100644
--- a/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh
+++ b/test/porousmediumflow/richards/implicit/nonisothermal/spatialparams.hh
@@ -82,7 +82,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
* \param globalPos The global coordinates for the given location
*/
auto fluidMatrixInteractionAtPos(const GlobalPosition& globalPos) const
diff --git a/test/porousmediumflow/richardsnc/implicit/spatialparams.hh b/test/porousmediumflow/richardsnc/implicit/spatialparams.hh
index 4e4434dd95..5d755c3201 100644
--- a/test/porousmediumflow/richardsnc/implicit/spatialparams.hh
+++ b/test/porousmediumflow/richardsnc/implicit/spatialparams.hh
@@ -93,7 +93,7 @@ public:
}
/*!
- * \brief Returns the parameters for the material law at a given location
+ * \brief Returns the fluid-matrix interaction law at a given location
*
* \param globalPos The global coordinates for the given location
*/
--
GitLab