Peano

Searching...

No Matches

Dump the tracer data into a csv database. More...

Inheritance diagram for exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase:

[legend]

Collaboration diagram for exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase:

[legend]

Public Member Functions
	__init__ (self, particle_set, solver, filename, number_of_entries_between_two_db_flushes=65536, data_delta_between_two_snapsots=1e-8, position_delta_between_two_snapsots=1e-8, time_delta_between_two_snapsots=0, output_precision=8, clear_database_after_flush=True, use_relative_deltas=False, initial_record_time=-1, last_record_time=1e8)
	Constructor.
	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.
	get_action_set_name (self)
	Return unique action set name.
	user_should_modify_template (self)
	Is the user allowed to modify the output.
	get_constructor_body (self)
	Define a tailored constructor body.
	get_includes (self)
	Return include statements that you need.
	get_attributes (self)
	Return attributes as copied and pasted into the generated class.
	get_static_initialisations (self, full_qualified_classname)
Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	__init__ (self, descend_invocation_order=0, parallel=False)
	get_destructor_body (self)
	get_body_of_getGridControlEvents (self)
	get_body_of_prepareTraversal (self)
	get_body_of_unprepareTraversal (self)

Data Fields
dict	d = {}
tuple	number_of_entries_between_two_db_flushes
Data Fields inherited from peano4.solversteps.ActionSet.ActionSet
	descend_invocation_order = descend_invocation_order
	parallel = parallel

Static Private Attributes
	__Template_TouchCellLastTime

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

Dump the tracer data into a csv database.

This action set is to be added to you code if you want to dump tracer data into a database. By default, Peano supports csv files. Please consult the constructor for information on the configuration of these dumps: The dumps are not synchronised with normal IO, but we keep track of the particles/tracers and allow codes to dump updated particle data whenver some attributes or the tracer position changes significantly. The term significantly can be controlled via relative deltas through the constructor.

This class uses the C++ class toolbox.particles.TrajectoryDatabase from the particles toolbox to realise the actual storage.

Definition at line 10 of file DumpTracerIntoDatabase.py.

Constructor & Destructor Documentation

◆ init()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.__init__	(	self,
		particle_set,
		solver,
		filename,
		number_of_entries_between_two_db_flushes = 65536,
		data_delta_between_two_snapsots = 1e-8,
		position_delta_between_two_snapsots = 1e-8,
		time_delta_between_two_snapsots = 0,
		output_precision = 8,
		clear_database_after_flush = True,
		use_relative_deltas = False,
		initial_record_time = -1,
		last_record_time = 1e8 )

Constructor.

data_delta_between_two_snapsots: Float See toolbox.particles.TrajectoryDatabase.TrajectoryDatabase(). The argument maps 1:1 to the constructor's argument dataDelta.

This flag has no impact whatsoever how often the data is dumped into a file. The frequency of datafile writes is solely controlled via number_of_entries_between_two_db_flushes.

position_delta_between_two_snapsots: Float See toolbox.particles.TrajectoryDatabase.TrajectoryDatabase(). The argument maps 1:1 to the constructor's argument positionDelta.

This flag has no impact whatsoever how often the data is dumped into a file. The frequency of datafile writes is solely controlled via number_of_entries_between_two_db_flushes.

time_delta_between_two_snapsots: Float See toolbox.particles.TrajectoryDatabase.TrajectoryDatabase(). The argument maps 1:1 to the constructor's argument timeDelta.

This flag has no impact whatsoever how often the data is dumped into a file. The frequency of datafile writes is solely controlled via number_of_entries_between_two_db_flushes.

number_of_entries_between_two_db_flushes: Int See toolbox.particles.TrajectoryDatabase.TrajectoryDatabase(). The argument maps 1:1 to the constructor's argument growthBetweenTwoDatabaseFlushes.

use_relative_deltas: Boolean See description of C++ class in toolbox.particles.TrajectoryDatabase

initial_record_time: Float you can specify from when does the tracer start to dump data to files.

last_record_time: Float you can specify at when does the tracer stop dumping data to files.

clear_database_after_flush: Boolean

Definition at line 28 of file DumpTracerIntoDatabase.py.

References __init__().

Referenced by __init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.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 156 of file DumpTracerIntoDatabase.py.

◆ get_attributes()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.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 187 of file DumpTracerIntoDatabase.py.

◆ get_body_of_operation()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.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 DumpTracerIntoDatabase.py.

◆ get_constructor_body()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.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 162 of file DumpTracerIntoDatabase.py.

◆ get_includes()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.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 175 of file DumpTracerIntoDatabase.py.

◆ get_static_initialisations()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.get_static_initialisations	(		self,
			full_qualified_classname )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 192 of file DumpTracerIntoDatabase.py.

References number_of_entries_between_two_db_flushes.

◆ user_should_modify_template()

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.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 159 of file DumpTracerIntoDatabase.py.

Field Documentation

◆ __Template_TouchCellLastTime

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.__Template_TouchCellLastTime

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 113 of file DumpTracerIntoDatabase.py.

Referenced by get_body_of_operation(), peano4.toolbox.particles.ParticleAMR.ParticleAMR.get_body_of_operation(), peano4.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.get_body_of_operation(), swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_body_of_operation(), and swift2.actionsets.UpdateParticleMarker.UpdateParticleMarker.get_body_of_operation().

◆ d

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.d = {}

Definition at line 87 of file DumpTracerIntoDatabase.py.

◆ number_of_entries_between_two_db_flushes

exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.number_of_entries_between_two_db_flushes

Initial value:

=  (
            number_of_entries_between_two_db_flushes
        )

Definition at line 109 of file DumpTracerIntoDatabase.py.

Referenced by get_static_initialisations().

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

python/exahype2/tracer/DumpTracerIntoDatabase.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_operation()

◆ get_constructor_body()

◆ get_includes()

◆ get_static_initialisations()

◆ user_should_modify_template()

Field Documentation

◆ __Template_TouchCellLastTime

◆ d

◆ number_of_entries_between_two_db_flushes

◆ init()