Peano

Searching...

No Matches

Inheritance diagram for swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File:

[legend]

Collaboration diagram for swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File:

[legend]

Public Member Functions
	__init__ (self, particle_set, filename)
	Read position from HDF5 and insert particles.

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

	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_includes (self)
	Return include statements that you need.

	get_static_initialisations (self, full_qualified_classname)

	get_constructor_body (self)
	Define a tailored constructor body.

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

Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	get_destructor_body (self)

	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

Protected Attributes
	_filename

Static Private Attributes
	__Template_TouchCellFirstTime

	__Template_EndTraversal

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 14 of file InsertParticlesFromHDF5File.py.

Constructor & Destructor Documentation

◆ init()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.__init__	(	self,
		particle_set,
		filename )

Read position from HDF5 and insert particles.

Read an HDF5 file and insert particles into the simulation box. This is
typically used to read an Initial Condition file.

particle_set: ParticleSet

filename: String
  Name of the HDF5 file that we want to read.

@TODO implement some bool checks, e.g. is this a cosmological simulation?
hydro scheme?

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 15 of file InsertParticlesFromHDF5File.py.

References swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.__init__().

Referenced by swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.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 247 of file InsertParticlesFromHDF5File.py.

◆ get_attributes()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.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 303 of file InsertParticlesFromHDF5File.py.

◆ get_body_of_getGridControlEvents()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 244 of file InsertParticlesFromHDF5File.py.

◆ get_body_of_operation()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.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 236 of file InsertParticlesFromHDF5File.py.

◆ get_constructor_body()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.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 288 of file InsertParticlesFromHDF5File.py.

References exahype2.tracer.InsertParticlesFromFile.InsertParticlesFromFile._filename, swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File._filename, and peano4::grid::TraversalVTKPlotter._filename.

◆ get_includes()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.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 253 of file InsertParticlesFromHDF5File.py.

◆ get_static_initialisations()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.get_static_initialisations	(		self,
			full_qualified_classname )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 276 of file InsertParticlesFromHDF5File.py.

◆ user_should_modify_template()

swift2.input.InsertParticlesFromHDF5File.InsertParticlesFromHDF5File.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 250 of file InsertParticlesFromHDF5File.py.