Peano

Searching...

No Matches

Simple patch plotter. More...

Inheritance diagram for peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat:

[legend]

Collaboration diagram for peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat:

[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", restart_preprocess=False)
	Construct the block plotter.

	get_constructor_body (self)
	Define a tailored constructor body.

	get_destructor_body (self)

	get_body_of_getGridControlEvents (self)

	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_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.solversteps.ActionSet.ActionSet
	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

Data Fields
	d

	additional_includes

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

	parallel

Protected Attributes
	_plot_cell_data

	_restart_preprocess

Static Private Attributes
str	__Template_Constructor

str	__Template_EndTraversal

str	__Template_TouchCellFirstTime_CellPlot

str	__Template_TouchCellFirstTime_VertexPlot

str	__Template_BeginTraversal_Generic

str	__Template_BeginTraversal_Generic_Restart

str	__Template_BeginTraversal_CellPlot

str	__Template_BeginTraversal_CellPlot_Restart

str	__Template_BeginTraversal_VertexPlot

str	__Template_BeginTraversal_VertexPlot_Restart

Additional Inherited Members
Static Public Attributes inherited from peano4.solversteps.ActionSet.ActionSet
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

Simple patch plotter.

Very simple plotter that should be used in combination with Patches. Patches with varying datatypes are supported via the "dataType" parameter, but this defaults to doubles. This parameter should contain the C-style- name of the type of the variable in the patch, e.g. float, double, etc. This plotter works only for cell patches, i.e. patches associated with faces or vertices are not supported.

At the moment, I can only plot one dataset (patch type) per plotter. In theory, the underlying Peano plotter however could dump multiple patches at once.

Also, this dump expects incoming data to be AoS.

Definition at line 8 of file PlotPatchesInPeanoBlockFormat.py.

Constructor & Destructor Documentation

◆ init()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__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",
		restart_preprocess = False )

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.solversteps.ActionSet.ActionSet.

Definition at line 27 of file PlotPatchesInPeanoBlockFormat.py.

References peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__init__().

Referenced by peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.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.solversteps.ActionSet.ActionSet.

Definition at line 163 of file PlotPatchesInPeanoBlockFormat.py.

◆ get_attributes()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.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.solversteps.ActionSet.ActionSet.

Definition at line 333 of file PlotPatchesInPeanoBlockFormat.py.

References peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat._plot_cell_data, and peano4.toolbox.blockstructured.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat._plot_cell_data.

◆ get_body_of_getGridControlEvents()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 159 of file PlotPatchesInPeanoBlockFormat.py.

◆ get_body_of_operation()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.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.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 309 of file PlotPatchesInPeanoBlockFormat.py.

◆ get_constructor_body()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.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.solversteps.ActionSet.ActionSet.

Definition at line 136 of file PlotPatchesInPeanoBlockFormat.py.

◆ get_destructor_body()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_destructor_body ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 155 of file PlotPatchesInPeanoBlockFormat.py.

◆ get_includes()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.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.solversteps.ActionSet.ActionSet.

Definition at line 354 of file PlotPatchesInPeanoBlockFormat.py.

Here is the call graph for this function:

◆ get_static_initialisations()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_static_initialisations	(		self,
			full_qualified_classname )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 366 of file PlotPatchesInPeanoBlockFormat.py.

◆ user_should_modify_template()

peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.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.solversteps.ActionSet.ActionSet.

Definition at line 167 of file PlotPatchesInPeanoBlockFormat.py.

Field Documentation

◆ __Template_BeginTraversal_CellPlot

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__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 291 of file PlotPatchesInPeanoBlockFormat.py.

Referenced by peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_body_of_operation(), and peano4.toolbox.blockstructured.PlotPatchesOverFacesInPeanoBlockFormat.PlotPatchesOverFacesInPeanoBlockFormat.get_body_of_operation().

◆ __Template_BeginTraversal_CellPlot_Restart

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__Template_BeginTraversal_CellPlot_Restart

staticprivate

Initial value:

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

Definition at line 295 of file PlotPatchesInPeanoBlockFormat.py.

Referenced by peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_body_of_operation().

◆ __Template_BeginTraversal_Generic

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__Template_BeginTraversal_Generic

staticprivate

Initial value:

=  """
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 244 of file PlotPatchesInPeanoBlockFormat.py.

◆ __Template_BeginTraversal_Generic_Restart

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__Template_BeginTraversal_Generic_Restart

staticprivate

Initial value:

=  """
tarch::mpi::Lock lock( _semaphore );
 
static int counter = -1;
counter++;
 
static bool preprocessFinished=false;
if (not preprocessFinished){
    if ( tarch::mpi::Rank::getInstance().isGlobalMaster()){
          counter=tarch::plotter::griddata::blockstructured::restartPreprocess("{{FILENAME}}", CheckpointTimeStamp);
    }
    MPI_Bcast(&counter, 1, MPI_INT, 0, MPI_COMM_WORLD);
    preprocessFinished=true;
}
 
"""+__Template_BeginTraversal_Generic

Definition at line 265 of file PlotPatchesInPeanoBlockFormat.py.

◆ __Template_BeginTraversal_VertexPlot

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__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 300 of file PlotPatchesInPeanoBlockFormat.py.

◆ __Template_BeginTraversal_VertexPlot_Restart

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__Template_BeginTraversal_VertexPlot_Restart

staticprivate

Initial value:

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

Definition at line 304 of file PlotPatchesInPeanoBlockFormat.py.

Referenced by peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.get_body_of_operation().

◆ __Template_Constructor

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__Template_Constructor

staticprivate

Initial value:

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

Definition at line 127 of file PlotPatchesInPeanoBlockFormat.py.

◆ __Template_EndTraversal

str peano4.toolbox.blockstructured.PlotPatchesInPeanoBlockFormat.PlotPatchesInPeanoBlockFormat.__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;
"""