Peano

Searching...

No Matches

Inheritance diagram for solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat:

[legend]

Collaboration diagram for solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat:

[legend]

Public Member Functions
	__init__ (self, solver, variable_name, getter, plot_predicate="true", cell_predicate="true")
	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

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

	parallel

Static Private Attributes
str	__Template_Constructor

str	__Template_EndTraversal

str	__Template_TouchCellFirstTime

str	__Template_BeginTraversal

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

Definition at line 8 of file PlotVertexDataInPeanoBlockFormat.py.

Constructor & Destructor Documentation

◆ init()

solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__init__	(	self,
		solver,
		variable_name,
		getter,
		plot_predicate = "true",
		cell_predicate = "true" )

Plot grid and assume all data are associated with vertices.

This is a copy of the one in toolbox, but for the time being we hardcode the number of unknowns per vertex that we plot to 1, and we make some important customisations. Particularly regarding the place we plot.

Parameters

plot_predicate	string This determines whether we want to plot in this cell. This prevents spurious creation of patch files that we don't want to print.
cell_predicate	string This determines whether we want to plot in this cell. For instance, we use this flag to prevent plotting on levels that are not the finest level.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 10 of file PlotVertexDataInPeanoBlockFormat.py.

References solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__init__().

Referenced by solvers.api.actionsets.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()

solvers.api.actionsets.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 86 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_attributes()

solvers.api.actionsets.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 161 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_body_of_getGridControlEvents()

solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 82 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_body_of_operation()

solvers.api.actionsets.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 150 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_constructor_body()

solvers.api.actionsets.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 57 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_destructor_body()

solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_destructor_body ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 78 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_includes()

solvers.api.actionsets.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 172 of file PlotVertexDataInPeanoBlockFormat.py.

◆ get_static_initialisations()

solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_static_initialisations	(		self,
			full_qualified_classname )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 185 of file PlotVertexDataInPeanoBlockFormat.py.

◆ user_should_modify_template()

solvers.api.actionsets.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 90 of file PlotVertexDataInPeanoBlockFormat.py.

Field Documentation

◆ __Template_BeginTraversal

str solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__Template_BeginTraversal

staticprivate

Initial value:

=  """
if ({{PLOT_PREDICATE}}) {
  tarch::mpi::Lock lock( _semaphore );
 
  static int counter = -1;
  counter++;
  
  std::ostringstream snapshotFileName;
  snapshotFileName << "{{SOLVER_NAME}}.{{VARIABLE}}-" << 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(), "{{SOLVER_NAME}}.{{VARIABLE}}",
    tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter::IndexFileMode::AppendNewData,
    counter
  );
        
  _dataWriter = _writer->createVertexDataWriter( 
    "{{VARIABLE}}", 
    2,  // number of dofs per axis per cell
    repositories::{{SOLVER_INSTANCE}}.VertexUnknowns,
    "Solution of {{SOLVER_NAME}}"
  );
  
  _dataWriter->setPrecision(16);
}
"""

Definition at line 118 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.PlotDGPatchesInPeanoBlockFormat.PlotDGPatchesInPeanoBlockFormat.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 solvers.api.actionsets.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 46 of file PlotVertexDataInPeanoBlockFormat.py.

◆ __Template_EndTraversal

str solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__Template_EndTraversal

staticprivate

Initial value:

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

Definition at line 61 of file PlotVertexDataInPeanoBlockFormat.py.

◆ __Template_TouchCellFirstTime

str solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.__Template_TouchCellFirstTime

staticprivate

Initial value:

=  """ 
if (
  fineGridCell{{SOLVER_NAME}}.getType() == celldata::{{SOLVER_NAME}}::Type::Interior
  and
  {{PLOT_PREDICATE}}
  and
  {{CELL_PREDICATE}}
) {
int vertexIndices[TwoPowerD];
 
int patchIndex = _writer->plotPatch(
  marker.x()-0.5 * marker.h(),
  marker.h()
);
 
int vertexIndex  = _dataWriter->getFirstVertexWithinPatch(patchIndex);
for (int i=0; i<TwoPowerD; i++) {
  double* value = fineGridVertices{{SOLVER_NAME}}(i).{{GETTER}}().data();
  _dataWriter->plotVertex( vertexIndex+i, value );
}
}
"""

Definition at line 94 of file PlotVertexDataInPeanoBlockFormat.py.

◆ d

solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.d

Definition at line 38 of file PlotVertexDataInPeanoBlockFormat.py.

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

src/mghype/matrixfree/solvers/api/actionsets/PlotVertexDataInPeanoBlockFormat.py

Public Member Functions

Data Fields

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_constructor_body()

◆ get_destructor_body()

◆ get_includes()

◆ get_static_initialisations()

◆ user_should_modify_template()

Field Documentation

◆ __Template_BeginTraversal

◆ __Template_Constructor

◆ __Template_EndTraversal

◆ __Template_TouchCellFirstTime

◆ d

◆ init()