plasma.h File Reference
Header file for plasma.c. More...
#include "ascot5.h"#include "error.h"#include "plasma/plasma_1D.h"#include "plasma/plasma_1Dt.h"#include "plasma/plasma_1DS.h"Go to the source code of this file.
Data Structures | |
| struct | plasma_data |
| Plasma simulation data. More... | |
Typedefs | |
| typedef enum plasma_type | plasma_type |
| Plasma data types. | |
Enumerations | |
| enum | plasma_type { plasma_type_1D , plasma_type_1Dt , plasma_type_1DS } |
| Plasma data types. More... | |
Functions | |
| void | plasma_free (plasma_data *data) |
| Free allocated resources. | |
| void | plasma_offload (plasma_data *data) |
| Offload data to the accelerator. | |
| a5err | plasma_eval_temp (real *temp, real rho, real r, real phi, real z, real t, int species, plasma_data *pls_data) |
| Evaluate plasma temperature. | |
| DECLARE_TARGET_END a5err | plasma_eval_dens (real *dens, real rho, real r, real phi, real z, real t, int species, plasma_data *pls_data) |
| Evaluate plasma density. | |
| DECLARE_TARGET_END a5err | plasma_eval_densandtemp (real *dens, real *temp, real rho, real r, real phi, real z, real t, plasma_data *pls_data) |
| Evaluate plasma density and temperature for all species. | |
| DECLARE_TARGET_END a5err | plasma_eval_flow (real *vflow, real rho, real r, real phi, real z, real t, plasma_data *pls_data) |
| Evalate plasma flow along the field lines. | |
| DECLARE_TARGET_END int | plasma_get_n_species (plasma_data *pls_data) |
| Get the number of plasma species. | |
| DECLARE_TARGET_END const real * | plasma_get_species_mass (plasma_data *pls_data) |
| Get mass of all plasma species. | |
| DECLARE_TARGET_END const real * | plasma_get_species_charge (plasma_data *pls_data) |
| Get charge of all plasma species. | |
| DECLARE_TARGET_END const int * | plasma_get_species_znum (plasma_data *pls_data) |
| Get charge number of ion species. | |
| DECLARE_TARGET_END const int * | plasma_get_species_anum (plasma_data *pls_data) |
| Get atomic mass number of ion species. | |
Detailed Description
Header file for plasma.c.
Contains a list declaring all plasma data, and declaration of plasma_offload_data and plasma_data structs.
Definition in file plasma.h.
Enumeration Type Documentation
◆ plasma_type
| enum plasma_type |
Function Documentation
◆ plasma_free()
| void plasma_free | ( | plasma_data * | data | ) |
◆ plasma_offload()
| void plasma_offload | ( | plasma_data * | data | ) |
◆ plasma_eval_temp()
| a5err plasma_eval_temp | ( | real * | temp, |
| real | rho, | ||
| real | r, | ||
| real | phi, | ||
| real | z, | ||
| real | t, | ||
| int | species, | ||
| plasma_data * | pls_data ) |
Evaluate plasma temperature.
This function evaluates the temperature of a given plasma species at the given position.
This is a SIMD function.
- Parameters
-
temp array where evaluated temperature [J] is stored rho normalized poloidal flux coordinate r R-coordinate [m] phi phi-coordinate [rad] z z-coordinate [m] t time coordinate [s] species index of plasma species, 1 refers to electrons pls_data pointer to plasma data struct
- Returns
- Non-zero a5err value if evaluation failed, zero otherwise
◆ plasma_eval_dens()
| DECLARE_TARGET_END a5err plasma_eval_dens | ( | real * | dens, |
| real | rho, | ||
| real | r, | ||
| real | phi, | ||
| real | z, | ||
| real | t, | ||
| int | species, | ||
| plasma_data * | pls_data ) |
Evaluate plasma density.
This function evaluates the density of a plasma species at the given radial coordinate.
This is a SIMD function.
- Parameters
-
dens array where evaluated density will be stored rho normalized poloidal flux coordinate r R-coordinate [m] phi phi-coordinate [rad] z z-coordinate [m] t time coordinate [s] species index of plasma species, 1 refers to electrons pls_data pointer to plasma data struct
- Returns
- Non-zero a5err value if evaluation failed, zero otherwise
◆ plasma_eval_densandtemp()
| DECLARE_TARGET_END a5err plasma_eval_densandtemp | ( | real * | dens, |
| real * | temp, | ||
| real | rho, | ||
| real | r, | ||
| real | phi, | ||
| real | z, | ||
| real | t, | ||
| plasma_data * | pls_data ) |
Evaluate plasma density and temperature for all species.
This function evaluates the density and temperature of all plasma species at the given radial coordinate.
This is a SIMD function.
- Parameters
-
dens pointer where density [m^-3] will be stored temp pointer where temperature [J] will be stored rho normalized poloidal flux coordinate r R-coordinate [m] phi phi-coordinate [rad] z z-coordinate [m] t time coordinate [s] pls_data pointer to plasma data struct
- Returns
- Non-zero a5err value if evaluation failed, zero otherwise
◆ plasma_eval_flow()
| DECLARE_TARGET_END a5err plasma_eval_flow | ( | real * | vflow, |
| real | rho, | ||
| real | r, | ||
| real | phi, | ||
| real | z, | ||
| real | t, | ||
| plasma_data * | pls_data ) |
Evalate plasma flow along the field lines.
- Parameters
-
vflow pointer where the flow value is stored [m/s] rho particle rho coordinate [1] r particle R coordinate [m] phi particle toroidal coordinate [rad] z particle z coordinate [m] t particle time coordinate [s] pls_data pointer to plasma data
◆ plasma_get_n_species()
| DECLARE_TARGET_END int plasma_get_n_species | ( | plasma_data * | pls_data | ) |
◆ plasma_get_species_mass()
| DECLARE_TARGET_END const real * plasma_get_species_mass | ( | plasma_data * | pls_data | ) |
◆ plasma_get_species_charge()
| DECLARE_TARGET_END const real * plasma_get_species_charge | ( | plasma_data * | pls_data | ) |
◆ plasma_get_species_znum()
| DECLARE_TARGET_END const int * plasma_get_species_znum | ( | plasma_data * | pls_data | ) |
◆ plasma_get_species_anum()
| DECLARE_TARGET_END const int * plasma_get_species_anum | ( | plasma_data * | pls_data | ) |
Generated on Wed Sep 24 2025 09:09:10 for ASCOT5 by
1.13.2