|
ASCOT5
|
Plasma interface. More...
#include <stdio.h>#include <stdlib.h>#include "ascot5.h"#include "error.h"#include "print.h"#include "plasma.h"#include "plasma/plasma_1D.h"#include "plasma/plasma_1DS.h"#include "consts.h"Go to the source code of this file.
Functions | |
| int | plasma_init_offload (plasma_offload_data *offload_data, real **offload_array) |
| Load plasma data and prepare parameters. | |
| void | plasma_free_offload (plasma_offload_data *offload_data, real **offload_array) |
| Free offload array and reset parameters. | |
| int | plasma_init (plasma_data *pls_data, plasma_offload_data *offload_data, real *offload_array) |
| Initialize plasma data struct on target. | |
| 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. | |
| 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. | |
| 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. | |
| int | plasma_get_n_species (plasma_data *pls_data) |
| Get the number of plasma species. | |
| const real * | plasma_get_species_mass (plasma_data *pls_data) |
| Get mass of all plasma species. | |
| const real * | plasma_get_species_charge (plasma_data *pls_data) |
| Get charge of all plasma species. | |
| const int * | plasma_get_species_znum (plasma_data *pls_data) |
| Get charge number of ion species. | |
| const int * | plasma_get_species_anum (plasma_data *pls_data) |
| Get atomic mass number of ion species. | |
Plasma interface.
This is an interface through which plasma data is initialized and accessed. Reading e.g. from disk is done elsewhere.
To add a new plasma instance, make sure these functions are implemented and called from this interface, and that plasma.h contains enum type for the new instance.
The interface checks which instance given data corresponds to from the "type"-field in plasma_offload_data or plasma_data that is given as an argument, and calls the relevant function for that instance.
Plasma species are referred by their index number: if a function returns e.g. an array containing species densities these are ordered as electrons first by different ion species in no particular order. However, the order is invariant and consistent across all functions.
Maximum number of plasma species is defined by MAX_SPECIES in ascot5.h.
Definition in file plasma.c.
| int plasma_init_offload | ( | plasma_offload_data * | offload_data, |
| real ** | offload_array ) |
Load plasma data and prepare parameters.
This function fills the relevant plasma offload struct with parameters and allocates and fills the offload array. Sets offload array length in the offload struct.
The offload data has to have a type when this function is called as it should be set when the offload data is constructed from inputs.
This function is host only.
| offload_data | pointer to offload data struct |
| offload_array | pointer to pointer to offload array |
| void plasma_free_offload | ( | plasma_offload_data * | offload_data, |
| real ** | offload_array ) |
| int plasma_init | ( | plasma_data * | pls_data, |
| plasma_offload_data * | offload_data, | ||
| real * | offload_array ) |
Initialize plasma data struct on target.
This function copies the plasma parameters from the offload struct to the struct on target and sets the plasma data pointers to correct offsets in the offload array.
| pls_data | pointer to data struct on target |
| offload_data | pointer to offload data struct |
| offload_array | pointer to offload array |
| 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.
| 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 |
| 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.
| 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 |
| 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.
| 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 |
| int plasma_get_n_species | ( | plasma_data * | pls_data | ) |
| const real * plasma_get_species_mass | ( | plasma_data * | pls_data | ) |
| const real * plasma_get_species_charge | ( | plasma_data * | pls_data | ) |
| const int * plasma_get_species_znum | ( | plasma_data * | pls_data | ) |
| const int * plasma_get_species_anum | ( | plasma_data * | pls_data | ) |
1.10.0