OGSTools Documentation#
- User Guide
- Examples
- How to use feflowlib
- How to use logparser
- How to use meshlib
- How to use meshplotlib
- Using proxy models for nuclear waste heat production
- Features of propertylib
- Features of studies
- API reference
- ogstools package
- Subpackages
- ogstools.feflowlib package
combine_material_properties()
component_transport()
convert_geometry_mesh()
convert_properties_mesh()
deactivate_cells()
extract_cell_boundary_conditions()
extract_point_boundary_conditions()
get_material_properties_of_CT_model()
get_material_properties_of_HT_model()
get_species()
get_specific_surface()
helpFormat
hydro_thermal()
liquid_flow()
points_and_cells()
setup_prj_file()
steady_state_diffusion()
update_geometry()
write_mesh_of_combined_properties()
write_point_boundary_conditions()
- Submodules
- ogstools.feflowlib.templates module
- ogstools.feflowlib.tools module
helpFormat
get_specific_surface()
assign_bulk_ids()
remove_bulk_ids()
get_dimension()
extract_point_boundary_conditions()
write_point_boundary_conditions()
extract_cell_boundary_conditions()
get_material_properties()
get_material_properties_of_HT_model()
get_material_properties_of_CT_model()
get_species()
add_species_to_prj_file()
combine_material_properties()
write_mesh_of_combined_properties()
materials_in_steady_state_diffusion()
materials_in_liquid_flow()
materials_in_HT()
materials_in_HC()
RequestParams
setup_prj_file()
deactivate_cells()
- ogstools.logparser package
parse_file()
analysis_convergence_coupling_iteration()
analysis_simulation()
analysis_convergence_newton_iteration()
analysis_simulation_termination()
analysis_time_step()
fill_ogs_context()
time_step_vs_iterations()
ogs_regexes()
- Submodules
- ogstools.logparser.common_ogs_analyses module
- ogstools.logparser.log_parser module
- ogstools.logparser.regexes module
Log
Info
WarningType
ErrorType
CriticalType
MPIProcess
AssemblyTime
TimeStep
Iteration
IterationTime
TimeStepStartTime
TimeStepOutputTime
TimeStepSolutionTime
TimeStepSolutionTimeCoupledScheme
TimeStepFinishedTime
DirichletTime
LinearSolverTime
MeshReadTime
SimulationExecutionTime
ComponentConvergenceCriterion
TimeStepConvergenceCriterion
CouplingIterationConvergence
GenericCodePoint
PhaseFieldEnergyVar
ErrorMessage
CriticalMessage
WarningMessage
ogs_regexes()
- ogstools.meshlib package
Surface
Layer
Raster
LocationFrame
Boundary
MeshSeries
LayerSet
difference()
difference_pairwise()
difference_matrix()
rect()
cuboid()
- Subpackages
- Submodules
- ogstools.meshlib.boundary module
- ogstools.meshlib.boundary_set module
- ogstools.meshlib.boundary_subset module
- ogstools.meshlib.data_processing module
- ogstools.meshlib.gmsh_meshing module
- ogstools.meshlib.mesh_series module
- ogstools.meshlib.refine_mesh module
- ogstools.meshlib.xdmf_reader module
- ogstools.meshplotlib package
plot()
plot_contour()
plot_on_top()
plot_probe()
subplot()
update_font_sizes()
label_spatial_axes()
clear_labels()
- Submodules
- ogstools.meshplotlib.animation module
- ogstools.meshplotlib.core module
- ogstools.meshplotlib.levels module
- ogstools.meshplotlib.plot_features module
- ogstools.meshplotlib.plot_setup module
PlotSetup
PlotSetup.combined_colorbar
PlotSetup.dpi
PlotSetup.fig_scale
PlotSetup.min_ax_aspect
PlotSetup.max_ax_aspect
PlotSetup.invert_colorbar
PlotSetup.layout
PlotSetup.length
PlotSetup.material_names
PlotSetup.num_levels
PlotSetup.num_streamline_interp_pts
PlotSetup.p_max
PlotSetup.p_min
PlotSetup.__init__()
PlotSetup.rcParams
PlotSetup.show_element_edges
PlotSetup.title_center
PlotSetup.title_left
PlotSetup.title_right
PlotSetup.x_label
PlotSetup.y_label
PlotSetup.log_scaled
PlotSetup.show_region_bounds
PlotSetup.embedded_region_names_color
PlotSetup.rcParams_scaled
PlotSetup.from_dict()
PlotSetup.reset()
- ogstools.meshplotlib.plot_setup_defaults module
- ogstools.meshplotlib.utils module
- ogstools.msh2vtu package
- ogstools.physics package
- ogstools.propertylib package
Property
Property.data_name
Property.data_unit
Property.output_unit
Property.output_name
Property.mask
Property.func()
Property.mesh_dependent
Property.process_with_units
Property.cmap
Property.bilinear_cmap
Property.categoric
Property.type_name
Property.replace()
Property.__init__()
Property.from_property()
Property.transform()
Property.get_output_unit()
Property.difference
Property.is_mask()
Property.get_mask()
Property.magnitude
Property.mask_used()
Property.get_label()
Scalar
Vector
Matrix
Matrix.__getitem__()
Matrix.magnitude
Matrix.trace
Matrix.eigenvalues
Matrix.eigenvectors
Matrix.det
Matrix.invariant_1
Matrix.invariant_2
Matrix.invariant_3
Matrix.mean
Matrix.hydrostatic_component
Matrix.deviator
Matrix.deviator_invariant_1
Matrix.deviator_invariant_2
Matrix.deviator_invariant_3
Matrix.octahedral_shear
Matrix.von_Mises
Matrix.qp_ratio
Matrix.__init__()
- Submodules
- ogstools.propertylib.custom_colormaps module
- ogstools.propertylib.matrix module
Matrix
Matrix.__getitem__()
Matrix.magnitude
Matrix.trace
Matrix.eigenvalues
Matrix.eigenvectors
Matrix.det
Matrix.invariant_1
Matrix.invariant_2
Matrix.invariant_3
Matrix.mean
Matrix.hydrostatic_component
Matrix.deviator
Matrix.deviator_invariant_1
Matrix.deviator_invariant_2
Matrix.deviator_invariant_3
Matrix.octahedral_shear
Matrix.von_Mises
Matrix.qp_ratio
Matrix.__init__()
- ogstools.propertylib.mesh_dependent module
- ogstools.propertylib.presets module
- ogstools.propertylib.property module
Property
Property.data_name
Property.data_unit
Property.output_unit
Property.output_name
Property.mask
Property.func()
Property.mesh_dependent
Property.process_with_units
Property.cmap
Property.bilinear_cmap
Property.categoric
Property.type_name
Property.replace()
Property.__init__()
Property.from_property()
Property.transform()
Property.get_output_unit()
Property.difference
Property.is_mask()
Property.get_mask()
Property.magnitude
Property.mask_used()
Property.get_label()
Scalar
- ogstools.propertylib.tensor_math module
identity()
sym_tensor_to_mat()
trace()
eigenvalues()
eigenvectors()
det()
frobenius_norm()
invariant_1()
invariant_2()
invariant_3()
mean()
effective_pressure()
hydrostatic_component()
deviator()
deviator_invariant_1()
deviator_invariant_2()
deviator_invariant_3()
octahedral_shear()
von_mises()
qp_ratio()
- ogstools.propertylib.unit_registry module
- ogstools.propertylib.vector module
- ogstools.studies package
- Subpackages
- ogstools.studies.convergence package
add_grid_spacing()
convergence_metrics()
convergence_metrics_evolution()
grid_convergence()
log_fit()
plot_convergence()
plot_convergence_errors()
plot_convergence_error_evolution()
plot_convergence_order_evolution()
richardson_extrapolation()
run_convergence_study()
- Submodules
- ogstools.studies.convergence package
- Subpackages
- ogstools.workflow package
- ogstools.feflowlib package
- Submodules
- Subpackages
- ogstools package
- Development setup
- Development in a container with VSCode
- Container usage without VSCode
- Release procedure
- Release notes
- Motivation
The ogstools
pip-package is a collection of Python tools aimed at evolving into a modeling toolchain around OpenGeoSys, a finite element solver for coupled thermo-hydro-chemo-mechanical problems in the subsurface.
Date: Apr 25, 2024 Version: 0.3.0.post1.dev42+g8a18bcc
Useful links: Source repository | Issues | OpenGeoSys Website | OpenGeoSys Forum
Get an overview over the key concepts of ogstools
and the included tools.
Examples of ogstools usage, especially in combination with other tools or even complete modeling workflows.
The reference guide contains a detailed description of the ogstools API. It describes which methods are available, how they work and which parameters can be used.
Learn how to setup a development environment and how contribute your code to help improving the OpenGeoSys tools ecosystem.