Functions/Subroutines | |
| integer function | var_set_fluxvar (name_cons, name_prim, ix, need_bc) |
| Set generic flux variable. | |
| integer function | var_set_extravar (name_cons, name_prim, ix) |
| Set extra variable in w, which is not advected and has no boundary conditions. This has to be done after defining flux variables and auxiliary variables. | |
| integer function | var_set_wextra () |
| Set extra variable in wextra, which is not advected and has no boundary conditions and not output in dat. This has to be done after defining flux variables and auxiliary variables. | |
| integer function | var_set_auxvar (name_cons, name_prim, ix) |
| Set auxiliary variable, which is not advected but has boundary conditions. This has to be done after defining flux variables. | |
| integer function | var_set_rho () |
| Set density variable. | |
| subroutine | errormsg (message) |
| Exit MPI-AMRVAC with an error message. | |
| integer function, dimension(ndir) | var_set_momentum (ndir) |
| Set momentum variables. | |
| integer function | var_set_energy () |
| Set energy variable. | |
| integer function | var_set_q () |
| integer function | var_set_radiation_energy () |
| integer function, dimension(ndir) | var_set_bfield (ndir) |
| Set magnetic field variables. | |
Variables | |
| integer | nwflux = 0 |
| Number of flux variables. | |
| integer | nwfluxbc = 0 |
| Number of flux variables which need user to specify boundary type. | |
| integer | nwaux = 0 |
| Number of auxiliary variables in w. | |
| integer | nwextra = 0 |
| Number of extra variables in w. | |
| integer | nw_extra = 0 |
| Number of extra variables in wextra seperated from w. | |
| integer | nw_recon = 0 |
| Number of variables need reconstruction in w. | |
| integer | nw = 0 |
| Total number of variables. | |
| integer | nws = 0 |
| Total number of stagger variables. | |
| integer | nwgc = 0 |
| Number of variables which need to be updated in ghost cells. | |
| integer | nvector = 0 |
| Number of vector variables (used for writing output) | |
| integer, dimension(:), allocatable | iw_vector |
| Indices of vector variables. | |
| integer | iwstart =1 |
| integer, parameter | max_nw = 50 |
| Maximum number of variables. | |
| integer | iw_rho = -1 |
| Index of the (gas) density. | |
| integer, dimension(:), allocatable | iw_mom |
| Indices of the momentum density. | |
| integer | iw_e = -1 |
| Index of the energy density. | |
| integer | iw_r_e = -1 |
| Index of the radiation energy density. | |
| integer | iw_q = -1 |
| Index of heat flux. | |
| integer, dimension(:), allocatable, protected | iw_mag |
| Indices of the magnetic field components. | |
| integer | iw_tcoff = -1 |
| Index of the cutoff temperature for the TRAC method. | |
| integer | iw_tweight = -1 |
| integer | number_species = 1 |
| number of species: each species has different characterictic speeds and should be used accordingly in mod_finite_volume and mod_finite_difference | |
| integer | index_v_mag = 1 |
| index of the var whose velocity appears in the induction eq. | |
| integer, dimension(:), allocatable | start_indices |
| the indices in 1:nwflux array are assumed consecutive for each species this array should be of size number_species and contain the first index in the array of the number_species | |
| integer, dimension(:), allocatable | stop_indices |
| the indices in 1:nwflux array are assumed consecutive for each species this array should be of size number_species and contain the last index in the array of the first number_species, the last index for the last one is nwflux | |
| integer | iw_equi_rho = -1 |
| integer | iw_equi_p = -1 |
| character(len=name_len), dimension(max_nw) | prim_wnames |
| Primitive variable names. | |
| character(len=name_len), dimension(max_nw) | cons_wnames |
| Conservative variable names. | |
Function/Subroutine Documentation
◆ errormsg()
| subroutine mod_variables::errormsg | ( | character(len=*), intent(in) | message | ) |
Exit MPI-AMRVAC with an error message.
- Parameters
-
[in] message The error message
Definition at line 192 of file mod_variables.t.
◆ var_set_auxvar()
| integer function mod_variables::var_set_auxvar | ( | character(len=*), intent(in) | name_cons, |
| character(len=*), intent(in) | name_prim, | ||
| integer, intent(in), optional | ix | ||
| ) |
Set auxiliary variable, which is not advected but has boundary conditions. This has to be done after defining flux variables.
Definition at line 158 of file mod_variables.t.
◆ var_set_bfield()
| integer function, dimension(ndir) mod_variables::var_set_bfield | ( | integer, intent(in) | ndir | ) |
Set magnetic field variables.
Definition at line 259 of file mod_variables.t.
◆ var_set_energy()
| integer function mod_variables::var_set_energy |
Set energy variable.
Definition at line 222 of file mod_variables.t.
◆ var_set_extravar()
| integer function mod_variables::var_set_extravar | ( | character(len=*), intent(in) | name_cons, |
| character(len=*), intent(in) | name_prim, | ||
| integer, intent(in), optional | ix | ||
| ) |
Set extra variable in w, which is not advected and has no boundary conditions. This has to be done after defining flux variables and auxiliary variables.
Definition at line 128 of file mod_variables.t.
◆ var_set_fluxvar()
| integer function mod_variables::var_set_fluxvar | ( | character(len=*), intent(in) | name_cons, |
| character(len=*), intent(in) | name_prim, | ||
| integer, intent(in), optional | ix, | ||
| logical, intent(in), optional | need_bc | ||
| ) |
Set generic flux variable.
- Parameters
-
[in] name_cons Conservative name [in] name_prim Primitive name [in] ix Optional index (to make var1, var2, ...) [in] need_bc Require boundary condition (default: true)
Definition at line 101 of file mod_variables.t.
◆ var_set_momentum()
| integer function, dimension(ndir) mod_variables::var_set_momentum | ( | integer, intent(in) | ndir | ) |
Set momentum variables.
Definition at line 202 of file mod_variables.t.
◆ var_set_q()
| integer function mod_variables::var_set_q |
Definition at line 234 of file mod_variables.t.
◆ var_set_radiation_energy()
| integer function mod_variables::var_set_radiation_energy |
Definition at line 246 of file mod_variables.t.
◆ var_set_rho()
| integer function mod_variables::var_set_rho |
Set density variable.
Definition at line 177 of file mod_variables.t.
◆ var_set_wextra()
| integer function mod_variables::var_set_wextra |
Set extra variable in wextra, which is not advected and has no boundary conditions and not output in dat. This has to be done after defining flux variables and auxiliary variables.
Definition at line 148 of file mod_variables.t.
Variable Documentation
◆ cons_wnames
Conservative variable names.
Definition at line 96 of file mod_variables.t.
◆ index_v_mag
| integer mod_variables::index_v_mag = 1 |
index of the var whose velocity appears in the induction eq.
Definition at line 76 of file mod_variables.t.
◆ iw_e
| integer mod_variables::iw_e = -1 |
Index of the energy density.
Definition at line 55 of file mod_variables.t.
◆ iw_equi_p
| integer mod_variables::iw_equi_p = -1 |
Definition at line 90 of file mod_variables.t.
◆ iw_equi_rho
| integer mod_variables::iw_equi_rho = -1 |
Definition at line 89 of file mod_variables.t.
◆ iw_mag
| integer, dimension(:), allocatable, protected mod_variables::iw_mag |
Indices of the magnetic field components.
Definition at line 64 of file mod_variables.t.
◆ iw_mom
| integer, dimension(:), allocatable mod_variables::iw_mom |
Indices of the momentum density.
Definition at line 52 of file mod_variables.t.
◆ iw_q
| integer mod_variables::iw_q = -1 |
Index of heat flux.
Definition at line 61 of file mod_variables.t.
◆ iw_r_e
| integer mod_variables::iw_r_e = -1 |
Index of the radiation energy density.
Definition at line 58 of file mod_variables.t.
◆ iw_rho
| integer mod_variables::iw_rho = -1 |
Index of the (gas) density.
Definition at line 49 of file mod_variables.t.
◆ iw_tcoff
| integer mod_variables::iw_tcoff = -1 |
Index of the cutoff temperature for the TRAC method.
Definition at line 67 of file mod_variables.t.
◆ iw_tweight
| integer mod_variables::iw_tweight = -1 |
Definition at line 68 of file mod_variables.t.
◆ iw_vector
| integer, dimension(:), allocatable mod_variables::iw_vector |
Indices of vector variables.
Definition at line 38 of file mod_variables.t.
◆ iwstart
| integer mod_variables::iwstart =1 |
Definition at line 41 of file mod_variables.t.
◆ max_nw
| integer, parameter mod_variables::max_nw = 50 |
Maximum number of variables.
Definition at line 44 of file mod_variables.t.
◆ number_species
| integer mod_variables::number_species = 1 |
number of species: each species has different characterictic speeds and should be used accordingly in mod_finite_volume and mod_finite_difference
Definition at line 72 of file mod_variables.t.
◆ nvector
| integer mod_variables::nvector = 0 |
Number of vector variables (used for writing output)
Definition at line 35 of file mod_variables.t.
◆ nw
| integer mod_variables::nw = 0 |
Total number of variables.
Definition at line 26 of file mod_variables.t.
◆ nw_extra
| integer mod_variables::nw_extra = 0 |
Number of extra variables in wextra seperated from w.
Definition at line 20 of file mod_variables.t.
◆ nw_recon
| integer mod_variables::nw_recon = 0 |
Number of variables need reconstruction in w.
Definition at line 23 of file mod_variables.t.
◆ nwaux
| integer mod_variables::nwaux = 0 |
Number of auxiliary variables in w.
Definition at line 14 of file mod_variables.t.
◆ nwextra
| integer mod_variables::nwextra = 0 |
Number of extra variables in w.
Definition at line 17 of file mod_variables.t.
◆ nwflux
| integer mod_variables::nwflux = 0 |
Number of flux variables.
Definition at line 8 of file mod_variables.t.
◆ nwfluxbc
| integer mod_variables::nwfluxbc = 0 |
Number of flux variables which need user to specify boundary type.
Definition at line 11 of file mod_variables.t.
◆ nwgc
| integer mod_variables::nwgc = 0 |
Number of variables which need to be updated in ghost cells.
Definition at line 32 of file mod_variables.t.
◆ nws
| integer mod_variables::nws = 0 |
Total number of stagger variables.
Definition at line 29 of file mod_variables.t.
◆ prim_wnames
Primitive variable names.
Definition at line 93 of file mod_variables.t.
◆ start_indices
| integer, dimension(:), allocatable mod_variables::start_indices |
the indices in 1:nwflux array are assumed consecutive for each species this array should be of size number_species and contain the first index in the array of the number_species
Definition at line 81 of file mod_variables.t.
◆ stop_indices
| integer, dimension(:), allocatable mod_variables::stop_indices |
the indices in 1:nwflux array are assumed consecutive for each species this array should be of size number_species and contain the last index in the array of the first number_species, the last index for the last one is nwflux
Definition at line 85 of file mod_variables.t.
