Plotter of face structure. More...

Inheritance diagram for api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat:

[legend]

Collaboration diagram for api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat:

[legend]

Public Member Functions
	__init__ (self, filename, patch, dataset_name, description, time_stamp_evaluation, plot_cell_data=True, metadata="", mapping=[], guard="true", additional_includes="", precision=3, select_dofs=None, dataType="double")
	Construct the block plotter.

	get_constructor_body (self)
	Define a tailored constructor body.

	get_destructor_body (self)

	get_body_of_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

	get_action_set_name (self)
	Return unique action set name.

	user_should_modify_template (self)
	Is the user allowed to modify the output.

	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.

	get_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	get_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_includes (self)
	Return include statements that you need.

	get_static_initialisations (self, full_qualified_classname)

Public Member Functions inherited from peano4.api.solversteps.ActionSet.ActionSet
	get_implementation_of_createGridControlEventsForNextTraversal (self)
	Return the C++ implementation of createGridControlEventsForNextTraversal()

	get_body_of_prepareTraversal (self)

	get_implementation_of_prepareTraversal (self)
	Return the C++ implementation of prepareTraversal()

	get_body_of_unprepareTraversal (self)

	get_implementation_of_unprepareTraversal (self)
	Return the C++ implementation of unprepareTraversal()

	get_implementation_of_operation (self, operation_name)
	Return the C++ implementation of an operation.

bool	may_run_in_background_task (self)
	May a task graph compiler move touchCellFirstTime() into a task.

Data Fields
	d

	additional_includes

Data Fields inherited from peano4.api.solversteps.ActionSet.ActionSet
	descend_invocation_order

	parallel

Protected Attributes
	_plot_cell_data

Static Private Attributes
str	__Template_Constructor

str	__Template_EndTraversal

str	__Template_TouchFaceFirstTime_CellPlot

str	__Template_TouchFaceFirstTime_VertexPlot

str	__Template_BeginTraversal_Generic

str	__Template_BeginTraversal_CellPlot

str	__Template_BeginTraversal_VertexPlot

Additional Inherited Members
Static Public Attributes inherited from peano4.api.solversteps.ActionSet.ActionSet
int	descend_invocation_order = 0

bool	parallel = False

str	OPERATION_BEGIN_TRAVERSAL = "beginTraversal"

str	OPERATION_END_TRAVERSAL = "endTraversal"

str	OPERATION_CREATE_PERSISTENT_VERTEX = "createPersistentVertex"

str	OPERATION_DESTROY_PERSISTENT_VERTEX = "destroyPersistentVertex"

str	OPERATION_CREATE_HANGING_VERTEX = "createHangingVertex"

str	OPERATION_DESTROY_HANGING_VERTEX = "destroyHangingVertex"

str	OPERATION_CREATE_PERSISTENT_FACE = "createPersistentFace"

str	OPERATION_DESTROY_PERSISTENT_FACE = "destroyPersistentFace"

str	OPERATION_CREATE_HANGING_FACE = "createHangingFace"

str	OPERATION_DESTROY_HANGING_FACE = "destroyHangingFace"

str	OPERATION_CREATE_CELL = "createCell"

str	OPERATION_DESTROY_CELL = "destroyCell"

str	OPERATION_TOUCH_VERTEX_FIRST_TIME = "touchVertexFirstTime"

str	OPERATION_TOUCH_VERTEX_LAST_TIME = "touchVertexLastTime"

str	OPERATION_TOUCH_FACE_FIRST_TIME = "touchFaceFirstTime"

str	OPERATION_TOUCH_FACE_LAST_TIME = "touchFaceLastTime"

str	OPERATION_TOUCH_CELL_FIRST_TIME = "touchCellFirstTime"

str	OPERATION_TOUCH_CELL_LAST_TIME = "touchCellLastTime"

Detailed Description

Plotter of face structure.

Definition at line 8 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Constructor & Destructor Documentation

◆ init()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__init__	(	self,
		filename,
		patch,
		dataset_name,
		description,
		time_stamp_evaluation,
		plot_cell_data = `True`,
		metadata = `""`,
		mapping = `[]`,
		guard = `"true"`,
		additional_includes = `""`,
		precision = `3`,
		select_dofs = `None`,
		dataType = `"double"`
	)

Construct the block plotter.

plot_cell_data: Boolean Shall I plot cell data or vertex data. If you map the patches onto vertex data, then I have to decrease the dofs pre axis, as we basically plot the dual grid.

description: String

mapping: Series of d-tuples which describe how to distort quadrature/sampling points within a reference cube/square. Can be empty alternatively.

select_dofs: [Int] or None You can make the plotter only plot some of the dofs of interest

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 16 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

References api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__init__().

Referenced by api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_action_set_name ( self )

Return unique action set name.

Returns a description (word) for the mapping which is also used as class name for the generated type. As a consequence, the result should be one word (if possible) and uppercase. Also, every subclass should overwrite this routine.

The generator will take the result and construct eventually classes similar to MyStep2Dummy.h and MyStep2Dummy.cpp or similar for the example below, where we return Dummy.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 149 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

◆ get_attributes()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_attributes ( self )

Return attributes as copied and pasted into the generated class.

Please note that action sets are not persistent, i.e. there is one object creation per grid sweep per tree.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 298 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

References api.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat._plot_cell_data, and api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat._plot_cell_data.

◆ get_body_of_createGridControlEventsForNextTraversal()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_body_of_createGridControlEventsForNextTraversal ( self )

Return the grid control events that this action set wants to trigger.

Please consult the documentation of grid control events for details on what these events are and how they are used.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 145 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_createGridControlEventsForNextTraversal().

Here is the caller graph for this function:

◆ get_body_of_operation()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_body_of_operation	(	self,
		operation_name
	)

Return actual C++ code snippets to be inserted into C++ code.

See class' string constants starting with OPERATION_ for possible values of operation_name. The snippet is executed if and only if the guard returned by get_guard_of_operation() holds, i.e. the body should not evaluate the guard itself. See the section "Guard and body" in the class documentation.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 277 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_operation().

Here is the caller graph for this function:

◆ get_constructor_body()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_constructor_body ( self )

Define a tailored constructor body.

By default, the constructor of an action set is empty. If you you assign attributes to your action set, you however might want to initialise them here. We do not support initialisation lists, to all has to be done via setters unless you create attributes on the heap.

The constructor's signature will look similar to

   EnumerateAndInitSolution2petsc_actionsets_InitVertexDoFs0(int treeNumber);

where the treeNumber is -1 if this is the global instance of the action set owned by a rank, or a number greater or equal 0 if this action set is a clone of the glocal action set that's used by one tree traversal.

See also: get_attributes() to add attributes to your action set

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 122 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

◆ get_destructor_body()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_destructor_body ( self )

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 141 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

◆ get_guard_of_operation()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_guard_of_operation	(	self,
		operation_name
	)

Return the guard of an operation.

The guard is a C++ boolean expression. The body of the operation (see get_body_of_operation()) is executed if and only if the guard holds. The guard can use the same arguments as the body, i.e. the marker and the fine and coarse grid data. By default, the guard is true, i.e. the body is always executed.

See class' string constants starting with OPERATION_ for possible values of operation_name.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 292 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_operation().

Here is the caller graph for this function:

◆ get_includes()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_includes ( self )

Return include statements that you need.

All of these includes will eventually end up in the header of the generated C++ code.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 319 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Here is the call graph for this function:

◆ get_static_initialisations()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_static_initialisations	(	self,
		full_qualified_classname
	)

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 331 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

◆ user_should_modify_template()

api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.user_should_modify_template ( self )

Is the user allowed to modify the output.

Return whether you expect the user to modify the generated code. If this is the case, then the API places the generated output in the directory actions. Otherwise, it goes into the observer directory and will be overwritten in each and every Python run.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 153 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Field Documentation

◆ __Template_BeginTraversal_CellPlot

str api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__Template_BeginTraversal_CellPlot

staticprivate

Initial value:

=  __Template_BeginTraversal_Generic + """
_dataWriter = _writer->createCellDataWriter( "{{NAME}}", {{DOFS_PER_AXIS}}, {{PLOTTED_UNKNOWNS}}, "{{DESCRIPTION}}", "{{METADATA}}", mapping );
_dataWriter->setPrecision( {{PRECISION}} );
"""

Definition at line 265 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Referenced by api.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_body_of_operation(), and api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_body_of_operation().

◆ __Template_BeginTraversal_Generic

str api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__Template_BeginTraversal_Generic

staticprivate

Initial value:

=  """
tarch::mpi::Lock lock( _semaphore );
 
static int counter = -1;
counter++;
 
std::ostringstream snapshotFileName;
snapshotFileName << "{{FILENAME}}-" << counter;
 
if (tarch::mpi::Rank::getInstance().getNumberOfRanks()>1 ) {
  snapshotFileName << "-rank-" << tarch::mpi::Rank::getInstance().getRank();
}
 
_writer = new tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter(
  Dimensions, snapshotFileName.str(), "{{FILENAME}}",
  tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter::IndexFileMode::AppendNewData,
  {{TIMESTAMP}}
);    
    
#if Dimensions==2
{{MAPPING_2D}}
#else
{{MAPPING_3D}}
#endif
"""

Definition at line 237 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

◆ __Template_BeginTraversal_VertexPlot

str api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__Template_BeginTraversal_VertexPlot

staticprivate

Initial value:

=  __Template_BeginTraversal_Generic + """
_dataWriter = _writer->createVertexDataWriter( "{{NAME}}", {{DOFS_PER_AXIS}}, {{PLOTTED_UNKNOWNS}}, "{{DESCRIPTION}}", "{{METADATA}}", mapping );
_dataWriter->setPrecision( {{PRECISION}} );
"""

Definition at line 271 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

Referenced by api.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_body_of_operation(), and api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_body_of_operation().

◆ __Template_Constructor

str api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__Template_Constructor

staticprivate

Initial value:

=  """
_writer      = nullptr;
_dataWriter  = nullptr;
_treeNumber  = treeNumber;
 
logDebug( "PlotGrid2PlotGridInPeanoBlockFormat1()", "created tree instance for " << treeNumber );
"""

Definition at line 113 of file PlotPatchesOverFacesInPeanoBlockFormat.py.

◆ __Template_EndTraversal

str api.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.__Template_EndTraversal

staticprivate

Initial value:

=  """
assertion1( _dataWriter!=nullptr, _treeNumber );
assertion1( _writer!=nullptr,     _treeNumber );
 
_dataWriter->close();
_writer->writeToFile();
 
delete _dataWriter;
delete _writer;
 
_dataWriter = nullptr;
_writer     = nullptr;
"""