Peano

Searching...

No Matches

Inheritance diagram for peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat:

[legend]

Collaboration diagram for peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat:

[legend]

Public Member Functions
	__init__ (self, filename, vertex_unknown, getter, description, time_stamp_evaluation, number_of_unknows_per_vertex=1, guard_predicate="true", additional_includes="")
	Plot grid and assume all data are associated with vertices.

	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

Static Public Attributes
str	NoMetaFile = "no-meta-file"

str	CountTimeSteps = "count-time-steps"

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"

Static Private Attributes
str	__Template_Constructor

str	__Template_EndTraversal

str	__Template_TouchCellFirstTime

str	__Template_BeginTraversal

Detailed Description

Definition at line 8 of file PlotVertexDataInPeanoBlockFormat.py.

Constructor & Destructor Documentation

◆ init()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__init__	(	self,
		filename,
		vertex_unknown,
		getter,
		description,
		time_stamp_evaluation,
		number_of_unknows_per_vertex = 1,
		guard_predicate = "true",
		additional_includes = "" )

Plot grid and assume all data are associated with vertices.

filename: String Name of the output file

vertex_unknown: (DaStGen) object tied to a vertex The object you have associated with a vertex and that you want to print. The code will access its name via

 fineGridVertices{VERTEX_UNKNOWN_NAME}

in the generated source code

getter: String (C++ code) Getter acting on the vertex. Could be something alike getU() for example. If there's no getter but you want to directly access the data, remove any brackets from the passed string. Please note that Peano's plotter routines usually require plain value (double) pointers. So if a string like

  getU()

returns a tarch vector, you have to pass in

  getU().data()

to make the getter compatible with plotters' interface.

time_stamp_evaluation: String C++ expression returning a double. This is used to write the time series file for a series of snapshots. Pass in "0" if you solve a stationary problem, e.g. You can also hand in the constants NoMetaFile or CountTimeSteps.

number_of_unknows_per_vertex: Integer Has to match to the getter.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 12 of file PlotVertexDataInPeanoBlockFormat.py.

References peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__init__().

Referenced by peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__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.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.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 112 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_attributes()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.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 195 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_body_of_getGridControlEvents()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 108 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_body_of_operation()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.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 184 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_constructor_body()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.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 85 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_destructor_body()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_destructor_body ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 104 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_includes()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.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 206 of file PlotVertexDataInPeanoBlockFormat.py.

Here is the call graph for this function:

◆ get_static_initialisations()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_static_initialisations	(		self,
			full_qualified_classname )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 218 of file PlotVertexDataInPeanoBlockFormat.py.

◆ user_should_modify_template()

peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.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 116 of file PlotVertexDataInPeanoBlockFormat.py.

Field Documentation

◆ __Template_BeginTraversal

str peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__Template_BeginTraversal

staticprivate

Definition at line 140 of file PlotVertexDataInPeanoBlockFormat.py.

Referenced by peano4.toolbox.particles.api.UpdateParallelState.UpdateParallelState.get_body_of_operation(), peano4.toolbox.particles.PlotParticlesInVTKFormat.PlotParticlesInVTKFormat.get_body_of_operation(), peano4.toolbox.PlotCellDataInPeanoBlockFormat.PlotCellDataInPeanoBlockFormat.get_body_of_operation(), peano4.toolbox.PlotGridInPeanoBlockFormat.PlotGridInPeanoBlockFormat.get_body_of_operation(), peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_body_of_operation(), solvers.api.actionsets.PlotDGDataInPeanoBlockFormat.PlotDGDataInPeanoBlockFormat.get_body_of_operation(), solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_body_of_operation(), and api.actionsets.PlotDGDataInPeanoBlockFormat.PlotDGDataInPeanoBlockFormat.get_body_of_operation().

◆ __Template_Constructor

str peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__Template_Constructor

staticprivate

Initial value:

=  """
_writer      = nullptr;
_dataWriter  = nullptr;
_treeNumber  = treeNumber;
 
// An MPI lock (critical section) would be important!
  
logDebug( "PlotGrid2PlotGridInPeanoBlockFormat1()", "created tree instance for " << treeNumber );
"""

Definition at line 74 of file PlotVertexDataInPeanoBlockFormat.py.

◆ __Template_EndTraversal

str peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__Template_EndTraversal

staticprivate

Initial value:

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

Definition at line 89 of file PlotVertexDataInPeanoBlockFormat.py.

◆ __Template_TouchCellFirstTime

str peano4.toolbox.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__Template_TouchCellFirstTime

staticprivate

Initial value:

=  """ 
if ( {{GUARD_PREDICATE}} ) {
int vertexIndices[TwoPowerD];
 
int patchIndex = _writer->plotPatch(
  marker.x()-0.5 * marker.h(),
  marker.h()
);
 
assertion( _dataWriter!=nullptr );
int vertexIndex  = _dataWriter->getFirstVertexWithinPatch(patchIndex);
dfor2(k)
  auto data = fineGridVertices{{VERTEX_UNKNOWN_NAME}}(kScalar).{{GETTER}};
  _dataWriter->plotVertex( vertexIndex, data );
  vertexIndex++;
enddforx
}
"""