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

#include <particleparameters.h>

Collaboration diagram for ParticleParameters:
Collaboration graph
[legend]

Static Public Member Functions

static bool addParameters ()
static bool getParameters ()

Static Public Attributes

static std::string input_filename_pattern
static std::string output_filename_pattern
static std::string mode
static Real init_x
static Real init_y
static Real init_z
static Real dt
static Real start_time
static Real end_time
static Real input_dt
static uint64_t num_particles
static std::string V_field_name
static std::string rho_field_name
static bool divide_rhov_by_rho
static Boundary * boundary_behaviour_x
static Boundary * boundary_behaviour_y
static Boundary * boundary_behaviour_z
static Real precip_inner_boundary
static Real precip_start_x
static Real precip_stop_x
static Real reflect_start_y
static Real reflect_stop_y
static Real reflect_y_scale
static Real reflect_x_offset
static Real reflect_upstream_boundary
static Real reflect_downstream_boundary
static Real ipshock_inject_x0
static Real ipshock_inject_x1
static Real ipshock_inject_y0
static Real ipshock_inject_y1
static Real ipshock_inject_z0
static Real ipshock_inject_z1
static Real ipshock_transmit
static Real ipshock_reflect
static std::default_random_engine::result_type random_seed
static Distribution *(* distribution )(std::default_random_engine &)
static Real temperature
static Real particle_vel
static Real mass
static Real charge

Detailed Description

Definition at line 33 of file particleparameters.h.

Member Function Documentation

◆ addParameters()

bool ParticleParameters::addParameters ( )
static

Definition at line 78 of file particleparameters.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getParameters()

bool ParticleParameters::getParameters ( )
static

Definition at line 155 of file particleparameters.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ boundary_behaviour_x

Boundary* ParticleParameters::boundary_behaviour_x
static

What to do with particles that reach the x boundary

Definition at line 52 of file particleparameters.h.

◆ boundary_behaviour_y

Boundary* ParticleParameters::boundary_behaviour_y
static

What to do with particles that reach the y boundary

Definition at line 53 of file particleparameters.h.

◆ boundary_behaviour_z

Boundary* ParticleParameters::boundary_behaviour_z
static

What to do with particles that reach the z boundary

Definition at line 54 of file particleparameters.h.

◆ charge

Real ParticleParameters::charge
static

Charge of the test particles

Definition at line 82 of file particleparameters.h.

◆ distribution

Distribution *(* ParticleParameters::distribution) (std::default_random_engine &)
static

Type of distribution from which to sample the particles

Definition at line 77 of file particleparameters.h.

◆ divide_rhov_by_rho

bool ParticleParameters::divide_rhov_by_rho
static

Does the file store rho_v and rho separately?

Definition at line 50 of file particleparameters.h.

◆ dt

Real ParticleParameters::dt
static

Particle pusher timestep

Definition at line 42 of file particleparameters.h.

◆ end_time

Real ParticleParameters::end_time
static

Simulation time at which the particle-simulation should be stopped

Definition at line 44 of file particleparameters.h.

◆ init_x

Real ParticleParameters::init_x
static

Particle starting point, x-coordinate

Definition at line 38 of file particleparameters.h.

◆ init_y

Real ParticleParameters::init_y
static

Particle starting point, y-coordinate

Definition at line 39 of file particleparameters.h.

◆ init_z

Real ParticleParameters::init_z
static

Particle starting point, z-coordinate

Definition at line 40 of file particleparameters.h.

◆ input_dt

Real ParticleParameters::input_dt
static

Time interval between input files

Definition at line 45 of file particleparameters.h.

◆ input_filename_pattern

std::string ParticleParameters::input_filename_pattern
static

printf() - like pattern giving the input filenames

Definition at line 34 of file particleparameters.h.

◆ ipshock_inject_x0

Real ParticleParameters::ipshock_inject_x0
static

Smaller x-coordinate for particle injection (meters)

Definition at line 67 of file particleparameters.h.

◆ ipshock_inject_x1

Real ParticleParameters::ipshock_inject_x1
static

Larger x-coordinate for particle injection (meters)

Definition at line 68 of file particleparameters.h.

◆ ipshock_inject_y0

Real ParticleParameters::ipshock_inject_y0
static

Smaller y-coordinate for particle injection (meters)

Definition at line 69 of file particleparameters.h.

◆ ipshock_inject_y1

Real ParticleParameters::ipshock_inject_y1
static

Larger y-coordinate for particle injection (meters)

Definition at line 70 of file particleparameters.h.

◆ ipshock_inject_z0

Real ParticleParameters::ipshock_inject_z0
static

Smaller z-coordinate for particle injection (meters)

Definition at line 71 of file particleparameters.h.

◆ ipshock_inject_z1

Real ParticleParameters::ipshock_inject_z1
static

Larger z-coordinate for particle injection (meters)

Definition at line 72 of file particleparameters.h.

◆ ipshock_reflect

Real ParticleParameters::ipshock_reflect
static

X-Coordinate for particle reflection (upstream) (meters)

Definition at line 74 of file particleparameters.h.

◆ ipshock_transmit

Real ParticleParameters::ipshock_transmit
static

X-Coordinate for particle transmission (downstream) (meters)

Definition at line 73 of file particleparameters.h.

◆ mass

Real ParticleParameters::mass
static

Mass of the test particles

Definition at line 81 of file particleparameters.h.

◆ mode

std::string ParticleParameters::mode
static

Particle tracing mode

Definition at line 36 of file particleparameters.h.

◆ num_particles

uint64_t ParticleParameters::num_particles
static

Number of particles to generate

Definition at line 47 of file particleparameters.h.

◆ output_filename_pattern

std::string ParticleParameters::output_filename_pattern
static

printf() - like pattern giving the output filenames

Definition at line 35 of file particleparameters.h.

◆ particle_vel

Real ParticleParameters::particle_vel
static

Initial particle velocity (for distributions with a single initial velocity)

Definition at line 79 of file particleparameters.h.

◆ precip_inner_boundary

Real ParticleParameters::precip_inner_boundary
static

Distance of the inner boundary from the coordinate centre (meters)

Definition at line 56 of file particleparameters.h.

◆ precip_start_x

Real ParticleParameters::precip_start_x
static

X-Coordinate at which precipitation injection starts (meters)

Definition at line 57 of file particleparameters.h.

◆ precip_stop_x

Real ParticleParameters::precip_stop_x
static

X-Coordinate at which precipitation injection stops (meters)

Definition at line 58 of file particleparameters.h.

◆ random_seed

std::default_random_engine::result_type ParticleParameters::random_seed
static

Random seed for particle creation

Definition at line 76 of file particleparameters.h.

◆ reflect_downstream_boundary

Real ParticleParameters::reflect_downstream_boundary
static

Distance from particle injection point at which particles are to be counted as 'transmitted'

Definition at line 65 of file particleparameters.h.

◆ reflect_start_y

Real ParticleParameters::reflect_start_y
static

Y-Coordinate of the bottom end of the parabola, at which shock reflection scenario particles are injected

Definition at line 60 of file particleparameters.h.

◆ reflect_stop_y

Real ParticleParameters::reflect_stop_y
static

Y-Coordinate of the top end of the parabola, at which shock reflection scenario particles are injected

Definition at line 61 of file particleparameters.h.

◆ reflect_upstream_boundary

Real ParticleParameters::reflect_upstream_boundary
static

Distance from particle injection point at which particles are to be counted as 'reflected'

Definition at line 64 of file particleparameters.h.

◆ reflect_x_offset

Real ParticleParameters::reflect_x_offset
static

X-Coordinate of the tip of the injection parabola for the reflection scenario

Definition at line 63 of file particleparameters.h.

◆ reflect_y_scale

Real ParticleParameters::reflect_y_scale
static

Curvature scale of the injection parabola for the reflection scenario

Definition at line 62 of file particleparameters.h.

◆ rho_field_name

std::string ParticleParameters::rho_field_name
static

Name of the Density data set to read

Definition at line 49 of file particleparameters.h.

◆ start_time

Real ParticleParameters::start_time
static

Simulation time at which the particles are injected

Definition at line 43 of file particleparameters.h.

◆ temperature

Real ParticleParameters::temperature
static

Initial particle temperature (for distributions where a temperature is meaningful)

Definition at line 78 of file particleparameters.h.

◆ V_field_name

std::string ParticleParameters::V_field_name
static

Name of the Velocity data set to read

Definition at line 48 of file particleparameters.h.

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