Skip to content
Snippets Groups Projects
Commit 3c184ad1 authored by Johannes Boog's avatar Johannes Boog
Browse files

[doc] update function documentation

parent eaf29100
No related branches found
No related tags found
1 merge request!54[bugfix] make all OGS6 benchmarks work.
Hide whitespace changes
Inline Side-by-side
man/OGS6_Chain.Rd
+ 12
− 12
View file @ 3c184ad1
...@@ -9,15 +9,15 @@ Constructor for the OGS6_Chain base class ...@@ -9,15 +9,15 @@ Constructor for the OGS6_Chain base class
\section{Methods}{ \section{Methods}{
\subsection{Public methods}{ \subsection{Public methods}{
\itemize{ \itemize{
\item \href{#method-new}{\code{OGS6_Chain$new()}} \item \href{#method-OGS6_Chain-new}{\code{OGS6_Chain$new()}}
\item \href{#method-ogs6_run_simulation}{\code{OGS6_Chain$ogs6_run_simulation()}} \item \href{#method-OGS6_Chain-ogs6_run_simulation}{\code{OGS6_Chain$ogs6_run_simulation()}}
\item \href{#method-print_log}{\code{OGS6_Chain$print_log()}} \item \href{#method-OGS6_Chain-print_log}{\code{OGS6_Chain$print_log()}}
\item \href{#method-clone}{\code{OGS6_Chain$clone()}} \item \href{#method-OGS6_Chain-clone}{\code{OGS6_Chain$clone()}}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}} \if{html}{\out{<a id="method-OGS6_Chain-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Chain-new}{}}}
\subsection{Method \code{new()}}{ \subsection{Method \code{new()}}{
Creates new OGS6_Chain object Creates new OGS6_Chain object
\subsection{Usage}{ \subsection{Usage}{
...@@ -35,8 +35,8 @@ Creates new OGS6_Chain object ...@@ -35,8 +35,8 @@ Creates new OGS6_Chain object
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-ogs6_run_simulation"></a>}} \if{html}{\out{<a id="method-OGS6_Chain-ogs6_run_simulation"></a>}}
\if{latex}{\out{\hypertarget{method-ogs6_run_simulation}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Chain-ogs6_run_simulation}{}}}
\subsection{Method \code{ogs6_run_simulation()}}{ \subsection{Method \code{ogs6_run_simulation()}}{
Runs the simulation. This calls r2ogs6::ogs6_run_simulation() internally. Runs the simulation. This calls r2ogs6::ogs6_run_simulation() internally.
For chains, output will be written to logfiles. For chains, output will be written to logfiles.
...@@ -46,8 +46,8 @@ For chains, output will be written to logfiles. ...@@ -46,8 +46,8 @@ For chains, output will be written to logfiles.
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-print_log"></a>}} \if{html}{\out{<a id="method-OGS6_Chain-print_log"></a>}}
\if{latex}{\out{\hypertarget{method-print_log}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Chain-print_log}{}}}
\subsection{Method \code{print_log()}}{ \subsection{Method \code{print_log()}}{
Reads in logfile of simulation and prints it to the console. Reads in logfile of simulation and prints it to the console.
This calls print_log internally. If no index is specified, this will This calls print_log internally. If no index is specified, this will
...@@ -65,8 +65,8 @@ print the logfile of the last object in the chain. ...@@ -65,8 +65,8 @@ print the logfile of the last object in the chain.
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}} \if{html}{\out{<a id="method-OGS6_Chain-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Chain-clone}{}}}
\subsection{Method \code{clone()}}{ \subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method. The objects of this class are cloneable with this method.
\subsection{Usage}{ \subsection{Usage}{
......
man/OGS6_Ensemble.Rd
+ 15
− 15
View file @ 3c184ad1
...@@ -24,16 +24,16 @@ Constructor for the OGS6_Ensemble base class ...@@ -24,16 +24,16 @@ Constructor for the OGS6_Ensemble base class
\section{Methods}{ \section{Methods}{
\subsection{Public methods}{ \subsection{Public methods}{
\itemize{ \itemize{
\item \href{#method-new}{\code{OGS6_Ensemble$new()}} \item \href{#method-OGS6_Ensemble-new}{\code{OGS6_Ensemble$new()}}
\item \href{#method-print}{\code{OGS6_Ensemble$print()}} \item \href{#method-OGS6_Ensemble-print}{\code{OGS6_Ensemble$print()}}
\item \href{#method-run_simulation}{\code{OGS6_Ensemble$run_simulation()}} \item \href{#method-OGS6_Ensemble-run_simulation}{\code{OGS6_Ensemble$run_simulation()}}
\item \href{#method-get_point_data}{\code{OGS6_Ensemble$get_point_data()}} \item \href{#method-OGS6_Ensemble-get_point_data}{\code{OGS6_Ensemble$get_point_data()}}
\item \href{#method-clone}{\code{OGS6_Ensemble$clone()}} \item \href{#method-OGS6_Ensemble-clone}{\code{OGS6_Ensemble$clone()}}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}} \if{html}{\out{<a id="method-OGS6_Ensemble-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Ensemble-new}{}}}
\subsection{Method \code{new()}}{ \subsection{Method \code{new()}}{
Creates new OGS6_Ensemble object Creates new OGS6_Ensemble object
\subsection{Usage}{ \subsection{Usage}{
...@@ -63,8 +63,8 @@ have the same length.} ...@@ -63,8 +63,8 @@ have the same length.}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-print"></a>}} \if{html}{\out{<a id="method-OGS6_Ensemble-print"></a>}}
\if{latex}{\out{\hypertarget{method-print}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Ensemble-print}{}}}
\subsection{Method \code{print()}}{ \subsection{Method \code{print()}}{
Overrides default printing behaviour Overrides default printing behaviour
\subsection{Usage}{ \subsection{Usage}{
...@@ -73,8 +73,8 @@ Overrides default printing behaviour ...@@ -73,8 +73,8 @@ Overrides default printing behaviour
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-run_simulation"></a>}} \if{html}{\out{<a id="method-OGS6_Ensemble-run_simulation"></a>}}
\if{latex}{\out{\hypertarget{method-run_simulation}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Ensemble-run_simulation}{}}}
\subsection{Method \code{run_simulation()}}{ \subsection{Method \code{run_simulation()}}{
Runs the simulation. This calls r2ogs6::ogs6_run_simulation() Runs the simulation. This calls r2ogs6::ogs6_run_simulation()
internally. For ensembles, output will always be written to logfiles. internally. For ensembles, output will always be written to logfiles.
...@@ -96,8 +96,8 @@ This is implementented via the 'parallel' package.} ...@@ -96,8 +96,8 @@ This is implementented via the 'parallel' package.}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-get_point_data"></a>}} \if{html}{\out{<a id="method-OGS6_Ensemble-get_point_data"></a>}}
\if{latex}{\out{\hypertarget{method-get_point_data}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Ensemble-get_point_data}{}}}
\subsection{Method \code{get_point_data()}}{ \subsection{Method \code{get_point_data()}}{
Wrapper for `OGS6_pvd$get_point_data()` Returns combined dataframe Wrapper for `OGS6_pvd$get_point_data()` Returns combined dataframe
with extra `name` and / or `perc` column depending on if with extra `name` and / or `perc` column depending on if
...@@ -133,8 +133,8 @@ to last timestep.} ...@@ -133,8 +133,8 @@ to last timestep.}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}} \if{html}{\out{<a id="method-OGS6_Ensemble-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}} \if{latex}{\out{\hypertarget{method-OGS6_Ensemble-clone}{}}}
\subsection{Method \code{clone()}}{ \subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method. The objects of this class are cloneable with this method.
\subsection{Usage}{ \subsection{Usage}{
......
man/OGS6_gml.Rd
+ 9
− 9
View file @ 3c184ad1
...@@ -48,14 +48,14 @@ OGS6_gml$new( ...@@ -48,14 +48,14 @@ OGS6_gml$new(
\section{Methods}{ \section{Methods}{
\subsection{Public methods}{ \subsection{Public methods}{
\itemize{ \itemize{
\item \href{#method-new}{\code{OGS6_gml$new()}} \item \href{#method-OGS6_gml-new}{\code{OGS6_gml$new()}}
\item \href{#method-print}{\code{OGS6_gml$print()}} \item \href{#method-OGS6_gml-print}{\code{OGS6_gml$print()}}
\item \href{#method-clone}{\code{OGS6_gml$clone()}} \item \href{#method-OGS6_gml-clone}{\code{OGS6_gml$clone()}}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}} \if{html}{\out{<a id="method-OGS6_gml-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}} \if{latex}{\out{\hypertarget{method-OGS6_gml-new}{}}}
\subsection{Method \code{new()}}{ \subsection{Method \code{new()}}{
Creates new OGS6_gml object Creates new OGS6_gml object
\subsection{Usage}{ \subsection{Usage}{
...@@ -86,8 +86,8 @@ have optional 'name' vector} ...@@ -86,8 +86,8 @@ have optional 'name' vector}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-print"></a>}} \if{html}{\out{<a id="method-OGS6_gml-print"></a>}}
\if{latex}{\out{\hypertarget{method-print}{}}} \if{latex}{\out{\hypertarget{method-OGS6_gml-print}{}}}
\subsection{Method \code{print()}}{ \subsection{Method \code{print()}}{
Overrides default printing behaviour Overrides default printing behaviour
\subsection{Usage}{ \subsection{Usage}{
...@@ -96,8 +96,8 @@ Overrides default printing behaviour ...@@ -96,8 +96,8 @@ Overrides default printing behaviour
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}} \if{html}{\out{<a id="method-OGS6_gml-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}} \if{latex}{\out{\hypertarget{method-OGS6_gml-clone}{}}}
\subsection{Method \code{clone()}}{ \subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method. The objects of this class are cloneable with this method.
\subsection{Usage}{ \subsection{Usage}{
......
man/OGS6_h5.Rd
+ 15
− 15
View file @ 3c184ad1
...@@ -63,16 +63,16 @@ df <- ogs6_h5$get_df("/t_0", "pressure") ...@@ -63,16 +63,16 @@ df <- ogs6_h5$get_df("/t_0", "pressure")
\section{Methods}{ \section{Methods}{
\subsection{Public methods}{ \subsection{Public methods}{
\itemize{ \itemize{
\item \href{#method-new}{\code{OGS6_h5$new()}} \item \href{#method-OGS6_h5-new}{\code{OGS6_h5$new()}}
\item \href{#method-print}{\code{OGS6_h5$print()}} \item \href{#method-OGS6_h5-print}{\code{OGS6_h5$print()}}
\item \href{#method-get_h5}{\code{OGS6_h5$get_h5()}} \item \href{#method-OGS6_h5-get_h5}{\code{OGS6_h5$get_h5()}}
\item \href{#method-get_df}{\code{OGS6_h5$get_df()}} \item \href{#method-OGS6_h5-get_df}{\code{OGS6_h5$get_df()}}
\item \href{#method-clone}{\code{OGS6_h5$clone()}} \item \href{#method-OGS6_h5-clone}{\code{OGS6_h5$clone()}}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}} \if{html}{\out{<a id="method-OGS6_h5-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}} \if{latex}{\out{\hypertarget{method-OGS6_h5-new}{}}}
\subsection{Method \code{new()}}{ \subsection{Method \code{new()}}{
This function will be called automatically after a This function will be called automatically after a
simulation is run to give an overview of the \code{h5} output data. simulation is run to give an overview of the \code{h5} output data.
...@@ -100,8 +100,8 @@ ogs6_h5 <- OGS6_h5$new(h5_path) ...@@ -100,8 +100,8 @@ ogs6_h5 <- OGS6_h5$new(h5_path)
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-print"></a>}} \if{html}{\out{<a id="method-OGS6_h5-print"></a>}}
\if{latex}{\out{\hypertarget{method-print}{}}} \if{latex}{\out{\hypertarget{method-OGS6_h5-print}{}}}
\subsection{Method \code{print()}}{ \subsection{Method \code{print()}}{
Overrides the default print method Overrides the default print method
\subsection{Usage}{ \subsection{Usage}{
...@@ -123,8 +123,8 @@ ogs6_h5 ...@@ -123,8 +123,8 @@ ogs6_h5
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-get_h5"></a>}} \if{html}{\out{<a id="method-OGS6_h5-get_h5"></a>}}
\if{latex}{\out{\hypertarget{method-get_h5}{}}} \if{latex}{\out{\hypertarget{method-OGS6_h5-get_h5}{}}}
\subsection{Method \code{get_h5()}}{ \subsection{Method \code{get_h5()}}{
return a h5 object for further processing with the return a h5 object for further processing with the
\code{rhdf5} package. \code{rhdf5} package.
...@@ -157,8 +157,8 @@ A list of data elements or the element accessed with ...@@ -157,8 +157,8 @@ A list of data elements or the element accessed with
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-get_df"></a>}} \if{html}{\out{<a id="method-OGS6_h5-get_df"></a>}}
\if{latex}{\out{\hypertarget{method-get_df}{}}} \if{latex}{\out{\hypertarget{method-OGS6_h5-get_df}{}}}
\subsection{Method \code{get_df()}}{ \subsection{Method \code{get_df()}}{
Method to retrieve \code{HDF5} output as a \code{tibble} Method to retrieve \code{HDF5} output as a \code{tibble}
assuming a standardized structure of \code{OGS6 HDF5} output. assuming a standardized structure of \code{OGS6 HDF5} output.
...@@ -192,8 +192,8 @@ df <- ogs6_h5$get_df("/t_0", "pressure") ...@@ -192,8 +192,8 @@ df <- ogs6_h5$get_df("/t_0", "pressure")
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}} \if{html}{\out{<a id="method-OGS6_h5-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}} \if{latex}{\out{\hypertarget{method-OGS6_h5-clone}{}}}
\subsection{Method \code{clone()}}{ \subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method. The objects of this class are cloneable with this method.
\subsection{Usage}{ \subsection{Usage}{
......
man/OGS6_pvd.Rd
+ 24
− 24
View file @ 3c184ad1
...@@ -29,19 +29,19 @@ Constructor for the OGS6_pvd base class ...@@ -29,19 +29,19 @@ Constructor for the OGS6_pvd base class
\section{Methods}{ \section{Methods}{
\subsection{Public methods}{ \subsection{Public methods}{
\itemize{ \itemize{
\item \href{#method-new}{\code{OGS6_pvd$new()}} \item \href{#method-OGS6_pvd-new}{\code{OGS6_pvd$new()}}
\item \href{#method-print}{\code{OGS6_pvd$print()}} \item \href{#method-OGS6_pvd-print}{\code{OGS6_pvd$print()}}
\item \href{#method-vtu_by_timestep}{\code{OGS6_pvd$vtu_by_timestep()}} \item \href{#method-OGS6_pvd-vtu_by_timestep}{\code{OGS6_pvd$vtu_by_timestep()}}
\item \href{#method-timestep_by_vtu}{\code{OGS6_pvd$timestep_by_vtu()}} \item \href{#method-OGS6_pvd-timestep_by_vtu}{\code{OGS6_pvd$timestep_by_vtu()}}
\item \href{#method-get_point_data_at}{\code{OGS6_pvd$get_point_data_at()}} \item \href{#method-OGS6_pvd-get_point_data_at}{\code{OGS6_pvd$get_point_data_at()}}
\item \href{#method-get_point_data}{\code{OGS6_pvd$get_point_data()}} \item \href{#method-OGS6_pvd-get_point_data}{\code{OGS6_pvd$get_point_data()}}
\item \href{#method-get_cell_data}{\code{OGS6_pvd$get_cell_data()}} \item \href{#method-OGS6_pvd-get_cell_data}{\code{OGS6_pvd$get_cell_data()}}
\item \href{#method-clone}{\code{OGS6_pvd$clone()}} \item \href{#method-OGS6_pvd-clone}{\code{OGS6_pvd$clone()}}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-new}{}}}
\subsection{Method \code{new()}}{ \subsection{Method \code{new()}}{
Creates new OGS6_pvd object Creates new OGS6_pvd object
\subsection{Usage}{ \subsection{Usage}{
...@@ -57,8 +57,8 @@ Creates new OGS6_pvd object ...@@ -57,8 +57,8 @@ Creates new OGS6_pvd object
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-print"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-print"></a>}}
\if{latex}{\out{\hypertarget{method-print}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-print}{}}}
\subsection{Method \code{print()}}{ \subsection{Method \code{print()}}{
Overrides default printing behaviour Overrides default printing behaviour
\subsection{Usage}{ \subsection{Usage}{
...@@ -67,8 +67,8 @@ Overrides default printing behaviour ...@@ -67,8 +67,8 @@ Overrides default printing behaviour
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-vtu_by_timestep"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-vtu_by_timestep"></a>}}
\if{latex}{\out{\hypertarget{method-vtu_by_timestep}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-vtu_by_timestep}{}}}
\subsection{Method \code{vtu_by_timestep()}}{ \subsection{Method \code{vtu_by_timestep()}}{
Returns .vtu path for specified timestep Returns .vtu path for specified timestep
\subsection{Usage}{ \subsection{Usage}{
...@@ -84,8 +84,8 @@ Returns .vtu path for specified timestep ...@@ -84,8 +84,8 @@ Returns .vtu path for specified timestep
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-timestep_by_vtu"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-timestep_by_vtu"></a>}}
\if{latex}{\out{\hypertarget{method-timestep_by_vtu}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-timestep_by_vtu}{}}}
\subsection{Method \code{timestep_by_vtu()}}{ \subsection{Method \code{timestep_by_vtu()}}{
Returns timestep for specified .vtu path Returns timestep for specified .vtu path
\subsection{Usage}{ \subsection{Usage}{
...@@ -101,8 +101,8 @@ Returns timestep for specified .vtu path ...@@ -101,8 +101,8 @@ Returns timestep for specified .vtu path
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-get_point_data_at"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-get_point_data_at"></a>}}
\if{latex}{\out{\hypertarget{method-get_point_data_at}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-get_point_data_at}{}}}
\subsection{Method \code{get_point_data_at()}}{ \subsection{Method \code{get_point_data_at()}}{
Returns a tibble containing point data Returns a tibble containing point data
\subsection{Usage}{ \subsection{Usage}{
...@@ -133,8 +133,8 @@ to last timestep.} ...@@ -133,8 +133,8 @@ to last timestep.}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-get_point_data"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-get_point_data"></a>}}
\if{latex}{\out{\hypertarget{method-get_point_data}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-get_point_data}{}}}
\subsection{Method \code{get_point_data()}}{ \subsection{Method \code{get_point_data()}}{
Returns a tibble containing point data Returns a tibble containing point data
\subsection{Usage}{ \subsection{Usage}{
...@@ -159,8 +159,8 @@ to last timestep.} ...@@ -159,8 +159,8 @@ to last timestep.}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-get_cell_data"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-get_cell_data"></a>}}
\if{latex}{\out{\hypertarget{method-get_cell_data}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-get_cell_data}{}}}
\subsection{Method \code{get_cell_data()}}{ \subsection{Method \code{get_cell_data()}}{
Returns a tibble containing cell data Returns a tibble containing cell data
\subsection{Usage}{ \subsection{Usage}{
...@@ -185,8 +185,8 @@ to last timestep.} ...@@ -185,8 +185,8 @@ to last timestep.}
} }
} }
\if{html}{\out{<hr>}} \if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}} \if{html}{\out{<a id="method-OGS6_pvd-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}} \if{latex}{\out{\hypertarget{method-OGS6_pvd-clone}{}}}
\subsection{Method \code{clone()}}{ \subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method. The objects of this class are cloneable with this method.
\subsection{Usage}{ \subsection{Usage}{
......
man/prj_ph_property.Rd
+ 7
− 1
View file @ 3c184ad1
...@@ -16,6 +16,8 @@ prj_ph_property( ...@@ -16,6 +16,8 @@ prj_ph_property(
exponents = NULL, exponents = NULL,
lower_saturation_limit = NULL, lower_saturation_limit = NULL,
upper_saturation_limit = NULL, upper_saturation_limit = NULL,
tortuosity = NULL,
curve = NULL,
... ...
) )
} }
...@@ -42,7 +44,11 @@ prj_ph_property( ...@@ -42,7 +44,11 @@ prj_ph_property(
\item{upper_saturation_limit}{Optional:} \item{upper_saturation_limit}{Optional:}
\item{...}{independent_variable} \item{tortuosity}{Optional:}
\item{curve}{Optional:}
\item{...}{independent_variable, dvalue}
} }
\description{ \description{
tag: property tag: property
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment