#include <Event.h>

Collaboration diagram for toolbox::particles::assignmentchecks::internal::Event:

[legend]

Public Types
enum class	Type { NotFound , AssignToSieveSet , AssignToVertex , Erase , DetachFromVertex , MoveWhileAssociatedToVertex , ConsecutiveMoveWhileAssociatedToVertex }

Public Member Functions
	Event (Type type_, bool isLocal_, const tarch::la::Vector< Dimensions, double > &vertexX_, const tarch::la::Vector< Dimensions, double > &particleX, const tarch::la::Vector< Dimensions, double > &vertexH_, int treeId_, const std::string &trace_, int meshSweepIndex_)
	Construct an event where you can specify all the fields.

	Event (Type type_, bool isLocal_, const tarch::la::Vector< Dimensions, double > &vertexX_, const tarch::la::Vector< Dimensions, double > &particleX, const tarch::la::Vector< Dimensions, double > &vertexH_, int treeId_, const std::string &trace_)
	Construct an event which identifies a vertex assignment or the removal from a vertex.

	Event (Type type_, const tarch::la::Vector< Dimensions, double > &vertexX_, const tarch::la::Vector< Dimensions, double > &previousParticleX_, const tarch::la::Vector< Dimensions, double > &vertexH_, int treeId_, const std::string &trace_)
	Construct a move event.

	Event (Type type_, bool isLocal_, int treeId_, const std::string &trace_)
	Construct an event that identifies the association to the sieve set or an erase.

	Event (Type type_)
	Construct an invalid event.

std::string	toString () const

Data Fields
Type	type

bool	isLocal

tarch::la::Vector< Dimensions, double >	vertexX

tarch::la::Vector< Dimensions, double >	previousParticleX

tarch::la::Vector< Dimensions, double >	vertexH

int	treeId

std::string	trace

int	meshSweepIndex

Detailed Description

Event.

An event is any event related to the particle-grid association. That can be an assignmend or detaching to a vertex or sieve set, or particles being moved in space.

Definition at line 20 of file Event.h.

Member Enumeration Documentation

◆ Type

enum class toolbox::particles::assignmentchecks::internal::Event::Type

strong

Enumerator
NotFound
AssignToSieveSet
AssignToVertex
Erase
DetachFromVertex
MoveWhileAssociatedToVertex
ConsecutiveMoveWhileAssociatedToVertex

Definition at line 21 of file Event.h.

Constructor & Destructor Documentation

◆ Event() [1/5]

toolbox::particles::assignmentchecks::internal::Event::Event	(	Type	type_,
		bool	isLocal_,
		const tarch::la::Vector< Dimensions, double > &	vertexX_,
		const tarch::la::Vector< Dimensions, double > &	particleX,
		const tarch::la::Vector< Dimensions, double > &	vertexH_,
		int	treeId_,
		const std::string &	trace_,
		int	meshSweepIndex_
	)

Construct an event where you can specify all the fields.

◆ Event() [2/5]

toolbox::particles::assignmentchecks::internal::Event::Event	(	Type	type_,
		bool	isLocal_,
		const tarch::la::Vector< Dimensions, double > &	vertexX_,
		const tarch::la::Vector< Dimensions, double > &	particleX,
		const tarch::la::Vector< Dimensions, double > &	vertexH_,
		int	treeId_,
		const std::string &	trace_
	)

Construct an event which identifies a vertex assignment or the removal from a vertex.

◆ Event() [3/5]

toolbox::particles::assignmentchecks::internal::Event::Event	(	Type	type_,
		const tarch::la::Vector< Dimensions, double > &	vertexX_,
		const tarch::la::Vector< Dimensions, double > &	previousParticleX_,
		const tarch::la::Vector< Dimensions, double > &	vertexH_,
		int	treeId_,
		const std::string &	trace_
	)

Construct a move event.

This event should always be tied to an identifier in the global map which uses the new position as key.

◆ Event() [4/5]

toolbox::particles::assignmentchecks::internal::Event::Event	(	Type	type_,
		bool	isLocal_,
		int	treeId_,
		const std::string &	trace_
	)

Construct an event that identifies the association to the sieve set or an erase.

◆ Event() [5/5]

toolbox::particles::assignmentchecks::internal::Event::Event ( Type type_ )

Construct an invalid event.

Is used as return value if no data is found in the database.

Member Function Documentation

◆ toString()

std::string toolbox::particles::assignmentchecks::internal::Event::toString ( ) const

Field Documentation

◆ isLocal

bool toolbox::particles::assignmentchecks::internal::Event::isLocal

Definition at line 32 of file Event.h.

◆ meshSweepIndex

int toolbox::particles::assignmentchecks::internal::Event::meshSweepIndex

Definition at line 38 of file Event.h.

◆ previousParticleX

tarch::la::Vector<Dimensions, double> toolbox::particles::assignmentchecks::internal::Event::previousParticleX

Definition at line 34 of file Event.h.

◆ trace

std::string toolbox::particles::assignmentchecks::internal::Event::trace

Definition at line 37 of file Event.h.

◆ treeId

int toolbox::particles::assignmentchecks::internal::Event::treeId

Definition at line 36 of file Event.h.

◆ type

Type toolbox::particles::assignmentchecks::internal::Event::type

Definition at line 31 of file Event.h.

Referenced by exahype2.api.dslhype.SyntaxTree.Name::get_type().

◆ vertexH

tarch::la::Vector<Dimensions, double> toolbox::particles::assignmentchecks::internal::Event::vertexH

Definition at line 35 of file Event.h.

◆ vertexX

tarch::la::Vector<Dimensions, double> toolbox::particles::assignmentchecks::internal::Event::vertexX

Definition at line 33 of file Event.h.

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

src/toolbox/particles/assignmentchecks/Event.h

Public Types

Public Member Functions

Data Fields