ASCOT5
Loading...
Searching...
No Matches
sim_data Struct Reference

Simulation data struct. More...

#include <simulate.h>

Data Fields

B_field_data B_data
 
E_field_data E_data
 
plasma_data plasma_data
 
neutral_data neutral_data
 
wall_data wall_data
 
boozer_data boozer_data
 
mhd_data mhd_data
 
asigma_data asigma_data
 
nbi_data nbi_data
 
diag_data diag_data
 
random_data random_data
 
mccc_data mccc_data
 
int sim_mode
 
int enable_ada
 
int record_mode
 
int fix_usrdef_use
 
real fix_usrdef_val
 
int fix_gyrodef_nstep
 
real ada_tol_orbfol
 
real ada_tol_clmbcol
 
real ada_max_drho
 
real ada_max_dphi
 
int enable_orbfol
 
int enable_clmbcol
 
int enable_mhd
 
int enable_atomic
 
int disable_gctransform
 
int disable_energyccoll
 
int disable_pitchccoll
 
int disable_gcdiffccoll
 
int reverse_time
 
int endcond_active
 
real endcond_lim_simtime
 
real endcond_max_mileage
 
real endcond_max_cputime
 
real endcond_min_rho
 
real endcond_max_rho
 
real endcond_min_ekin
 
real endcond_min_thermal
 
real endcond_max_tororb
 
real endcond_max_polorb
 
int endcond_torandpol
 
char hdf5_in [256]
 
char hdf5_out [256]
 
char qid [256]
 
char description [256]
 
int mpi_root
 
int mpi_rank
 
int mpi_size
 
char qid_options [256]
 
char qid_bfield [256]
 
char qid_efield [256]
 
char qid_marker [256]
 
char qid_wall [256]
 
char qid_plasma [256]
 
char qid_neutral [256]
 
char qid_boozer [256]
 
char qid_mhd [256]
 
char qid_asigma [256]
 
char qid_nbi [256]
 

Detailed Description

Simulation data struct.

This structure holds all data required to simulate markers except the markers themselves. Options, initialized input data, etc. are all stored here.

Even though most fields are identical to sim_offload_data, a separate struct is required as pointers cannot be offloaded.

Definition at line 57 of file simulate.h.

Field Documentation

◆ B_data

B_field_data sim_data::B_data

Magnetic field interface

Definition at line 59 of file simulate.h.

◆ E_data

E_field_data sim_data::E_data

Electric field interface

Definition at line 60 of file simulate.h.

◆ plasma_data

plasma_data sim_data::plasma_data

Plasma data interface

Definition at line 61 of file simulate.h.

◆ neutral_data

neutral_data sim_data::neutral_data

Neutral data interface

Definition at line 62 of file simulate.h.

◆ wall_data

wall_data sim_data::wall_data

Wall data interface

Definition at line 63 of file simulate.h.

◆ boozer_data

boozer_data sim_data::boozer_data

Boozer data interface

Definition at line 64 of file simulate.h.

◆ mhd_data

mhd_data sim_data::mhd_data

MHD data interface

Definition at line 65 of file simulate.h.

◆ asigma_data

asigma_data sim_data::asigma_data

Atomic sigma data interface

Definition at line 66 of file simulate.h.

◆ nbi_data

nbi_data sim_data::nbi_data

Neutral beam injection data interface

Definition at line 67 of file simulate.h.

◆ diag_data

diag_data sim_data::diag_data

Diagnostics data interface

Definition at line 68 of file simulate.h.

◆ random_data

random_data sim_data::random_data

Random number generator

Definition at line 71 of file simulate.h.

◆ mccc_data

mccc_data sim_data::mccc_data

Tabulated special functions and collision operator parameters

Definition at line 72 of file simulate.h.

◆ sim_mode

int sim_data::sim_mode

Which simulation mode is used

Definition at line 76 of file simulate.h.

◆ enable_ada

int sim_data::enable_ada

Is adaptive time-step used

Definition at line 77 of file simulate.h.

◆ record_mode

int sim_data::record_mode

Which record mode is used

Definition at line 78 of file simulate.h.

◆ fix_usrdef_use

int sim_data::fix_usrdef_use

Use user defined value for (initial) time-step

Definition at line 81 of file simulate.h.

◆ fix_usrdef_val

real sim_data::fix_usrdef_val

User defined time-step value

Definition at line 82 of file simulate.h.

◆ fix_gyrodef_nstep

int sim_data::fix_gyrodef_nstep

Time-step = gyrotime/fix_stepsPerGO if not explicitly user defined

Definition at line 83 of file simulate.h.

◆ ada_tol_orbfol

real sim_data::ada_tol_orbfol

Tolerance for relative error in orbit-following

Definition at line 87 of file simulate.h.

◆ ada_tol_clmbcol

real sim_data::ada_tol_clmbcol

Tolerance for relative error in Coulomb collisions

Definition at line 89 of file simulate.h.

◆ ada_max_drho

real sim_data::ada_max_drho

Maximum rho distance marker is allowed to travel during single adaptive time-step

Definition at line 91 of file simulate.h.

◆ ada_max_dphi

real sim_data::ada_max_dphi

Maximum phi distance marker is allowed to travel during single adaptive time-step

Definition at line 93 of file simulate.h.

◆ enable_orbfol

int sim_data::enable_orbfol

Is orbit-following enabled

Definition at line 97 of file simulate.h.

◆ enable_clmbcol

int sim_data::enable_clmbcol

Are Coulomb collisions enabled

Definition at line 98 of file simulate.h.

◆ enable_mhd

int sim_data::enable_mhd

Are MHD modes enabled

Definition at line 99 of file simulate.h.

◆ enable_atomic

int sim_data::enable_atomic

Are atomic reactions enabled

Definition at line 100 of file simulate.h.

◆ disable_gctransform

int sim_data::disable_gctransform

Disables first order velocity terms in guiding center transformation

Definition at line 101 of file simulate.h.

◆ disable_energyccoll

int sim_data::disable_energyccoll

Disables energy component from Coulomb collisions

Definition at line 103 of file simulate.h.

◆ disable_pitchccoll

int sim_data::disable_pitchccoll

Disables pitch component from Coulomb collisions

Definition at line 105 of file simulate.h.

◆ disable_gcdiffccoll

int sim_data::disable_gcdiffccoll

Disables guiding center spatial diffusion from Coulomb collisions

Definition at line 107 of file simulate.h.

◆ reverse_time

int sim_data::reverse_time

Set time running backwards in simulation

Definition at line 109 of file simulate.h.

◆ endcond_active

int sim_data::endcond_active

Bit array notating active end conditions

Definition at line 112 of file simulate.h.

◆ endcond_lim_simtime

real sim_data::endcond_lim_simtime

Simulation time limit [s]

Definition at line 113 of file simulate.h.

◆ endcond_max_mileage

real sim_data::endcond_max_mileage

Maximum simulation duration [s]

Definition at line 114 of file simulate.h.

◆ endcond_max_cputime

real sim_data::endcond_max_cputime

Maximum wall-clock time [s]

Definition at line 115 of file simulate.h.

◆ endcond_min_rho

real sim_data::endcond_min_rho

Minimum rho limit

Definition at line 116 of file simulate.h.

◆ endcond_max_rho

real sim_data::endcond_max_rho

Maximum rho limit

Definition at line 117 of file simulate.h.

◆ endcond_min_ekin

real sim_data::endcond_min_ekin

Fixed minimum kinetic energy limit [J]

Definition at line 118 of file simulate.h.

◆ endcond_min_thermal

real sim_data::endcond_min_thermal

Thermal minimum energy limit is this parameter times local thermal energy

Definition at line 119 of file simulate.h.

◆ endcond_max_tororb

real sim_data::endcond_max_tororb

Maximum limit for toroidal distance [rad]

Definition at line 121 of file simulate.h.

◆ endcond_max_polorb

real sim_data::endcond_max_polorb

Maximum limit for poloidal distance [rad]

Definition at line 122 of file simulate.h.

◆ endcond_torandpol

int sim_data::endcond_torandpol

Flag whether both tor and pol must be met

Definition at line 123 of file simulate.h.

◆ hdf5_in

char sim_data::hdf5_in[256]

Name of the input HDF5 file

Definition at line 126 of file simulate.h.

◆ hdf5_out

char sim_data::hdf5_out[256]

Name of the output HDF5 file

Definition at line 127 of file simulate.h.

◆ qid

char sim_data::qid[256]

QID of current run

Definition at line 128 of file simulate.h.

◆ description

char sim_data::description[256]

Current run's description

Definition at line 129 of file simulate.h.

◆ mpi_root

int sim_data::mpi_root

Rank of the root process

Definition at line 131 of file simulate.h.

◆ mpi_rank

int sim_data::mpi_rank

Rank of this MPI process

Definition at line 132 of file simulate.h.

◆ mpi_size

int sim_data::mpi_size

Total number of MPI processes

Definition at line 133 of file simulate.h.

◆ qid_options

char sim_data::qid_options[256]

Options QID if active not used

Definition at line 136 of file simulate.h.

◆ qid_bfield

char sim_data::qid_bfield[256]

Bfield QID if active not used

Definition at line 137 of file simulate.h.

◆ qid_efield

char sim_data::qid_efield[256]

Efield QID if active not used

Definition at line 138 of file simulate.h.

◆ qid_marker

char sim_data::qid_marker[256]

Marker QID if active not used

Definition at line 139 of file simulate.h.

◆ qid_wall

char sim_data::qid_wall[256]

Wall QID if active not used

Definition at line 140 of file simulate.h.

◆ qid_plasma

char sim_data::qid_plasma[256]

Plasma QID if active not used

Definition at line 141 of file simulate.h.

◆ qid_neutral

char sim_data::qid_neutral[256]

Neutral QID if active not used

Definition at line 142 of file simulate.h.

◆ qid_boozer

char sim_data::qid_boozer[256]

Boozer QID if active not used

Definition at line 143 of file simulate.h.

◆ qid_mhd

char sim_data::qid_mhd[256]

MHD QID if active not used

Definition at line 144 of file simulate.h.

◆ qid_asigma

char sim_data::qid_asigma[256]

Asigma QID if active not used

Definition at line 145 of file simulate.h.

◆ qid_nbi

char sim_data::qid_nbi[256]

NBI QID if active not used

Definition at line 146 of file simulate.h.


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