Skip to content
Snippets Groups Projects
Commit ef5a3640 authored by Ruben Heinrich's avatar Ruben Heinrich
Browse files

[base] NAMESPACE, DESCRIPTION and doc cleanup

parent 3b1a1b16
No related branches found
No related tags found
1 merge request!6Merge branch 7 fixed functionality into master
......@@ -3,5 +3,4 @@
.RData
.Ruserdata
packrat/lib*/
packrat/src/
inst/doc
......@@ -37,6 +37,9 @@ Imports:
curl,
xtable,
dplyr,
rlang
rlang,
doParallel
RoxygenNote: 7.1.1
VignetteBuilder: knitr
Depends:
foreach
# Generated by roxygen2: do not edit by hand
export(OGS6)
export(OGS6_Chain)
export(OGS6_Ensemble)
export(OGS6_UnstructuredGrid)
export(OGS6_mesh)
export(generate_benchmark_script)
export(generate_structured_mesh)
export(pick_vtu_file)
export(r2ogs6_borehole_heat_exchanger)
export(r2ogs6_boundary_condition)
export(r2ogs6_capillary_pressure)
export(r2ogs6_chemical_system)
export(r2ogs6_com_property)
export(r2ogs6_component)
export(r2ogs6_convergence_criterion)
export(r2ogs6_curve)
export(r2ogs6_deactivated_subdomain)
export(r2ogs6_eigen)
export(r2ogs6_flow_and_temperature_control)
export(r2ogs6_fluid)
export(r2ogs6_fracture_model)
export(r2ogs6_fracture_properties)
export(r2ogs6_global_process_coupling)
export(r2ogs6_gml)
export(r2ogs6_insitu)
export(r2ogs6_jacobian_assembler)
export(r2ogs6_kinetic_reactant)
export(r2ogs6_linear_solver)
export(r2ogs6_local_coordinate_system)
export(r2ogs6_material_property)
export(r2ogs6_medium)
export(r2ogs6_nonlinear_solver)
export(r2ogs6_output)
export(r2ogs6_parameter)
export(r2ogs6_ph_property)
export(r2ogs6_phase)
export(r2ogs6_phase_component)
export(r2ogs6_phasefield_parameters)
export(r2ogs6_pipes)
export(r2ogs6_porous_medium)
export(r2ogs6_pr_property)
export(r2ogs6_process)
export(r2ogs6_process_variable)
export(r2ogs6_rate)
export(r2ogs6_search_length_algorithm)
export(r2ogs6_solution)
export(r2ogs6_source_term)
export(r2ogs6_time_loop)
export(r2ogs6_time_stepping)
export(r2ogs6_tl_process)
export(r2ogs6_vtkdiff)
export(read_in_gml)
export(read_in_prj)
export(read_in_vtu)
export(run_simulation)
......@@ -346,11 +346,18 @@ Adds a r2ogs6_insitu object
\subsection{Method \code{get_status()}}{
Checks if the OGS6 object has all necessary parameters for
starting a simulation
print_log
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{OGS6$get_status()}\if{html}{\out{</div>}}
\if{html}{\out{<div class="r">}}\preformatted{OGS6$get_status(print_status = TRUE)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{print_status}}{flag: Should the status be printed to the console?
print_log}
}
\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-print_log"></a>}}
......
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