base_benchmark_process.BaseBenchmarkProcess Class Reference

The base class for the benchmarks. More...

Inheritance diagram for base_benchmark_process.BaseBenchmarkProcess:

Collaboration diagram for base_benchmark_process.BaseBenchmarkProcess:

Public Member Functions
def	__init__ (self, model, settings)
	The constructor of the BaseBenchmarkProcess. More...
def	ExecuteInitialize (self)
	Set the topography and the initial conditions. More...
def	ExecuteBeforeOutputStep (self)
	Compute the exact values of the benchmark and the error of the simulation. More...
def	Check (self)
	Check if the input values have physical sense. More...

Public Attributes
	model
	settings
	model_part
	variables
	exact_variables
	error_variables

Detailed Description

The base class for the benchmarks.

Constructor & Destructor Documentation

__init__()

def base_benchmark_process.BaseBenchmarkProcess.__init__	(		self,
			model,
			settings
	)

The constructor of the BaseBenchmarkProcess.

    It is intended to be called from the constructor of deriving classes.

Member Function Documentation

Check()

def base_benchmark_process.BaseBenchmarkProcess.Check

(

self

)

Check if the input values have physical sense.

ExecuteBeforeOutputStep()

def base_benchmark_process.BaseBenchmarkProcess.ExecuteBeforeOutputStep

(

self

)

Compute the exact values of the benchmark and the error of the simulation.

ExecuteInitialize()

def base_benchmark_process.BaseBenchmarkProcess.ExecuteInitialize

(

self

)

Set the topography and the initial conditions.

Member Data Documentation

error_variables

base_benchmark_process.BaseBenchmarkProcess.error_variables

exact_variables

base_benchmark_process.BaseBenchmarkProcess.exact_variables

model

base_benchmark_process.BaseBenchmarkProcess.model

model_part

base_benchmark_process.BaseBenchmarkProcess.model_part

settings

base_benchmark_process.BaseBenchmarkProcess.settings

variables

base_benchmark_process.BaseBenchmarkProcess.variables

---

The documentation for this class was generated from the following file:

• /home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/python_scripts/benchmarks/base_benchmark_process.py