Vlasiator ebf0dd394 on dev (v5.4.0 + 1054 commits)
Loading...
Searching...
No Matches
Scenario Struct Reference

#include <scenario.h>

Inheritance diagram for Scenario:

Public Member Functions

virtual ParticleContainer initialParticles (Field &E, Field &B, Field &V)
virtual void newTimestep (int input_file_counter, int step, double time, ParticleContainer &particles, Field &E, Field &B, Field &V)
virtual void beforePush (ParticleContainer &particles, Field &E, Field &B, Field &V)
virtual void afterPush (int step, double time, ParticleContainer &particles, Field &E, Field &B, Field &V)
virtual void finalize (ParticleContainer &particles, Field &E, Field &B, Field &V)
 Scenario ()

Public Attributes

bool needV

Detailed Description

Definition at line 35 of file scenario.h.

Constructor & Destructor Documentation

◆ Scenario()

Scenario::Scenario ( )
inline

Definition at line 57 of file scenario.h.

Member Function Documentation

◆ afterPush()

virtual void Scenario::afterPush ( int step,
double time,
ParticleContainer & particles,
Field & E,
Field & B,
Field & V )
inlinevirtual

Reimplemented in ipShockScenario, precipitationScenario, shockReflectivityScenario, and singleParticleScenario.

Definition at line 49 of file scenario.h.

Here is the caller graph for this function:

◆ beforePush()

virtual void Scenario::beforePush ( ParticleContainer & particles,
Field & E,
Field & B,
Field & V )
inlinevirtual

Definition at line 46 of file scenario.h.

Here is the caller graph for this function:

◆ finalize()

virtual void Scenario::finalize ( ParticleContainer & particles,
Field & E,
Field & B,
Field & V )
inlinevirtual

Reimplemented in distributionScenario, ipShockScenario, and shockReflectivityScenario.

Definition at line 52 of file scenario.h.

Here is the caller graph for this function:

◆ initialParticles()

virtual ParticleContainer Scenario::initialParticles ( Field & E,
Field & B,
Field & V )
inlinevirtual

Reimplemented in analysatorScenario, distributionScenario, ipShockScenario, and singleParticleScenario.

Definition at line 39 of file scenario.h.

Here is the caller graph for this function:

◆ newTimestep()

virtual void Scenario::newTimestep ( int input_file_counter,
int step,
double time,
ParticleContainer & particles,
Field & E,
Field & B,
Field & V )
inlinevirtual

Reimplemented in analysatorScenario, distributionScenario, ipShockScenario, precipitationScenario, and shockReflectivityScenario.

Definition at line 42 of file scenario.h.

Here is the caller graph for this function:

Member Data Documentation

◆ needV

bool Scenario::needV

Definition at line 55 of file scenario.h.


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