This process writes results along a line to generate a graph. More...

Inheritance diagram for line_graph_output_process.LineGraphOutputProcess:

Collaboration diagram for line_graph_output_process.LineGraphOutputProcess:

Public Member Functions
def	GetDefaultParameters (self)

def	__init__ (self, model, settings)
	Constructor of the class. More...

def	Check (self)
	Check the file settings. More...

def	ExecuteBeforeSolutionLoop (self)
	Search the points and delete the existing files after the current time. More...

def	IsOutputStep (self)
	Return if the current step is an output step. More...

def	PrintOutput (self)
	The output file is created, filled and closed. More...

Public Attributes
	model_part

	interval

	positions

	entity_type

	variables

	nonhistorical_variables

	search_configuration

	search_tolerance

	print_format

	time_format

	file_settings

	output_control

	file_name

	entities

	area_coords

	found_positions

	sf_values

Detailed Description

This process writes results along a line to generate a graph.

Every output step, an output file will be generated containing the graph data. At the moment, MPI is not supported.

Constructor & Destructor Documentation

◆ init()

def line_graph_output_process.LineGraphOutputProcess.__init__	(	self,
		model,
		settings
	)

Constructor of the class.

Member Function Documentation

◆ Check()

def line_graph_output_process.LineGraphOutputProcess.Check ( self )

Check the file settings.

◆ ExecuteBeforeSolutionLoop()

def line_graph_output_process.LineGraphOutputProcess.ExecuteBeforeSolutionLoop ( self )

Search the points and delete the existing files after the current time.

◆ GetDefaultParameters()

def line_graph_output_process.LineGraphOutputProcess.GetDefaultParameters ( self )

◆ IsOutputStep()

def line_graph_output_process.LineGraphOutputProcess.IsOutputStep ( self )

Return if the current step is an output step.

◆ PrintOutput()

def line_graph_output_process.LineGraphOutputProcess.PrintOutput ( self )

The output file is created, filled and closed.

There will be one file for each printing step with the time as label.

Member Data Documentation

◆ area_coords

line_graph_output_process.LineGraphOutputProcess.area_coords

◆ entities

line_graph_output_process.LineGraphOutputProcess.entities

◆ entity_type

line_graph_output_process.LineGraphOutputProcess.entity_type

◆ file_name

line_graph_output_process.LineGraphOutputProcess.file_name

◆ file_settings

line_graph_output_process.LineGraphOutputProcess.file_settings

◆ found_positions

line_graph_output_process.LineGraphOutputProcess.found_positions

◆ interval

line_graph_output_process.LineGraphOutputProcess.interval

◆ model_part

line_graph_output_process.LineGraphOutputProcess.model_part

◆ nonhistorical_variables

line_graph_output_process.LineGraphOutputProcess.nonhistorical_variables

◆ output_control

line_graph_output_process.LineGraphOutputProcess.output_control

◆ positions

line_graph_output_process.LineGraphOutputProcess.positions

◆ print_format

line_graph_output_process.LineGraphOutputProcess.print_format

◆ search_configuration

line_graph_output_process.LineGraphOutputProcess.search_configuration

◆ search_tolerance

line_graph_output_process.LineGraphOutputProcess.search_tolerance

◆ sf_values

line_graph_output_process.LineGraphOutputProcess.sf_values

◆ time_format

line_graph_output_process.LineGraphOutputProcess.time_format

◆ variables

line_graph_output_process.LineGraphOutputProcess.variables

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

/home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/python_scripts/postprocess/line_graph_output_process.py

Public Member Functions

Public Attributes