ogstools.logparser package

functions used by logparser.

ogstools.logparser.parse_file(file_name, maximum_lines=None, force_parallel=False, ogs_res=None)

Parses a log file from OGS, applying regex patterns to extract specific information,

The function supports processing files in serial or parallel mode. In parallel mode, a specific regex is used to match log entries from different processes.

Parameters:

• file_name (str | Path) – The path to the log file, as a string or Path object.

• maximum_lines (int | None) – Optional maximum number of lines to read from the file. If not provided, the whole file is read.

• force_parallel (bool) – Should only be set to True if OGS run with MPI with a single core

• ogs_res (list | None)

Returns:

A list of extracted records based on the applied regex patterns. The exact type and structure of these records depend on the regex patterns and their associated processing functions.

Return type:

list[Any]

ogstools.logparser.analysis_convergence_coupling_iteration(df)

Parameters:

df (Any)

Return type:

Any

ogstools.logparser.analysis_simulation(df)

Parameters:

df (DataFrame)

Return type:

DataFrame

ogstools.logparser.analysis_convergence_newton_iteration(df)

Convergence metrics need to be interpreted as norm |x|,`|dx|`, |dx|/|x| and are specific to defined <convergence_criterion> in prj - file.

Parameters:

df (DataFrame)

Return type:

DataFrame

ogstools.logparser.analysis_simulation_termination(df)

Parameters:

df (DataFrame)

Return type:

DataFrame

ogstools.logparser.analysis_time_step(df)

Analysis with focus on computation time per time step. It combines time step specific measurements ‘output time’ and ‘time step solution time’ with iteration specific measurements ‘assembly time’, ‘linear solver time’, ‘Dirichlet time’. Time from iteration are accumulated.

Parameters:

df (DataFrame)

Return type:

DataFrame

ogstools.logparser.fill_ogs_context(df_raw_log)

Fill missing values in OpenGeoSys (OGS) log DataFrame by context. This function fills missing values in an OpenGeoSys (OGS) log DataFrame by context.

Parameters:

df_raw_log (DataFrame) – DataFrame containing the raw OGS log data. Usually, the result of pd.DataFrame(parse_file(file))

Returns:

pd.DataFrame with missing values filled by context.

Return type:

DataFrame

References: Pandas documentation : https://pandas.pydata.org/pandas-docs/stable/user_guide/

Notes: Some logs do not contain information about time_step and iteration. The information must be collected by context (by surrounding log lines from same mpi_process). Logs are grouped by mpi_process to get only surrounding log lines from same mpi_process. There are log lines that give the current time step (when time step starts). It can be assumed that in all following lines belong to this time steps, until next collected value of time step. Some columns that contain actual integer values are converted to float. See https://pandas.pydata.org/pandas-docs/stable/user_guide/integer_na.html ToDo list of columns with integer values are known from regular expression

ogstools.logparser.time_step_vs_iterations(df)

Parameters:

df (DataFrame)

Return type:

DataFrame

ogstools.logparser.ogs_regexes()

Defines regular expressions for parsing OpenGeoSys log messages.

Returns:

A list of tuples, each containing a regular expression pattern and the corresponding message class.

Return type:

list[tuple[str, type[Log]]]

Submodules

• ogstools.logparser.common_ogs_analyses module
  • pre_post_check()
  • analysis_time_step()
  • analysis_simulation()
  • analysis_convergence_newton_iteration()
  • analysis_convergence_coupling_iteration()
  • time_step_vs_iterations()
  • analysis_simulation_termination()
  • fill_ogs_context()
• ogstools.logparser.log_parser module
  • mpi_processes()
  • parse_file()
• ogstools.logparser.regexes module
  • Log
    • Log.type
    • Log.line
    • Log.type_str()
    • Log.__init__()
  • Info
    • Info.type_str()
  • WarningType
    • WarningType.type_str()
  • ErrorType
    • ErrorType.type_str()
  • CriticalType
    • CriticalType.type_str()
  • MPIProcess
    • MPIProcess.mpi_process
    • MPIProcess.__init__()
  • AssemblyTime
    • AssemblyTime.assembly_time
    • AssemblyTime.__init__()
  • TimeStep
    • TimeStep.time_step
    • TimeStep.__init__()
  • Iteration
    • Iteration.iteration_number
    • Iteration.__init__()
  • IterationTime
    • IterationTime.iteration_number
    • IterationTime.iteration_time
    • IterationTime.__init__()
  • TimeStepStartTime
    • TimeStepStartTime.time_step
    • TimeStepStartTime.step_start_time
    • TimeStepStartTime.step_size
    • TimeStepStartTime.__init__()
  • TimeStepOutputTime
    • TimeStepOutputTime.time_step
    • TimeStepOutputTime.output_time
    • TimeStepOutputTime.__init__()
  • TimeStepSolutionTime
    • TimeStepSolutionTime.process
    • TimeStepSolutionTime.time_step_solution_time
    • TimeStepSolutionTime.time_step
    • TimeStepSolutionTime.__init__()
  • TimeStepSolutionTimeCoupledScheme
    • TimeStepSolutionTimeCoupledScheme.process
    • TimeStepSolutionTimeCoupledScheme.time_step_solution_time
    • TimeStepSolutionTimeCoupledScheme.time_step
    • TimeStepSolutionTimeCoupledScheme.coupling_iteration
    • TimeStepSolutionTimeCoupledScheme.__init__()
  • TimeStepFinishedTime
    • TimeStepFinishedTime.time_step
    • TimeStepFinishedTime.time_step_finished_time
    • TimeStepFinishedTime.__init__()
  • DirichletTime
    • DirichletTime.dirichlet_time
    • DirichletTime.__init__()
  • LinearSolverTime
    • LinearSolverTime.linear_solver_time
    • LinearSolverTime.__init__()
  • MeshReadTime
    • MeshReadTime.mesh_read_time
    • MeshReadTime.__init__()
  • SimulationExecutionTime
    • SimulationExecutionTime.execution_time
    • SimulationExecutionTime.__init__()
  • ComponentConvergenceCriterion
    • ComponentConvergenceCriterion.component
    • ComponentConvergenceCriterion.dx
    • ComponentConvergenceCriterion.x
    • ComponentConvergenceCriterion.dx_x
    • ComponentConvergenceCriterion.__init__()
  • TimeStepConvergenceCriterion
    • TimeStepConvergenceCriterion.dx
    • TimeStepConvergenceCriterion.x
    • TimeStepConvergenceCriterion.dx_x
    • TimeStepConvergenceCriterion.__init__()
  • CouplingIterationConvergence
    • CouplingIterationConvergence.coupling_iteration_process
    • CouplingIterationConvergence.__init__()
  • GenericCodePoint
    • GenericCodePoint.message
    • GenericCodePoint.__init__()
  • PhaseFieldEnergyVar
    • PhaseFieldEnergyVar.elastic_energy
    • PhaseFieldEnergyVar.surface_energy
    • PhaseFieldEnergyVar.pressure_work
    • PhaseFieldEnergyVar.total_energy
    • PhaseFieldEnergyVar.__init__()
  • ErrorMessage
    • ErrorMessage.message
    • ErrorMessage.__init__()
  • CriticalMessage
    • CriticalMessage.message
    • CriticalMessage.__init__()
  • WarningMessage
    • WarningMessage.message
    • WarningMessage.__init__()
  • ogs_regexes()