FLASH-X
Doxygen Generated Documentation From Interface Source Code
Functions/Subroutines
Multispecies_getProperty.F90 File Reference

Go to the source code of this file.

Functions/Subroutines

subroutine Multispecies_getProperty (name, property, value)
 
subroutine Multispecies_getIntegerProperty (name, property, value)
 
subroutine Multispecies_getStringProperty (name, property, value)
 
subroutine Multispecies_getRealArrProperty (name, property, value)
 
subroutine Multispecies_getIntArrProperty (name, property, value)
 

Function/Subroutine Documentation

◆ Multispecies_getIntArrProperty()

subroutine Multispecies_getIntArrProperty ( integer, intent(in)  name,
integer, intent(in)  property,
integer, dimension(:), intent(out)  value 
)

Definition at line 145 of file Multispecies_getProperty.F90.

◆ Multispecies_getIntegerProperty()

subroutine Multispecies_getIntegerProperty ( integer, intent(in)  name,
integer, intent(in)  property,
integer, intent(out)  value 
)

Returns the value of an integer property of the species name in value. The name is an integer because it is defined in Simulation.h based on Config data.

description integer property(defined as integer in Multispecies.h) -------------------------------------------------------------- EOS type MS_EOSTYPE Type of EOS for this species

name - name of species defined in Simulation.h, e.g., NI56_SPEC property - name of property define as an integer value - value of the returned property

NOTES

Species properties are normally set in Simulation_initSpecies. The simulation's Config file defines the number and name of species as SPECIES AIR SPECIES SF6

Definition at line 82 of file Multispecies_getProperty.F90.

◆ Multispecies_getProperty()

subroutine Multispecies_getProperty ( integer, intent(in)  name,
integer, intent(in)  property,
real, intent(out)  value 
)

Returns the value of a property of the species name in value. The name is an integer because it is defined in Simulation.h based on Config data.

description property(defined as integer in Multispecies.h) -------------------------------------------------------------- numTotal A Total number of protons and neutrons in nucleus numPositive Z Atomic number; number of protons in nucleus numNeutral N Number of neutrons numNegative E Number of electrons bindingEnergy EB Binding energy adiabatic index GAMMA Ratio of heat capacities: Cp / Cv

name - name of species defined in Simulation.h, e.g., NI56_SPEC property - name of property define as an integer value - value of the returned property

NOTES

Species properties are normally set in Simulation_initSpecies. The simulation's Config file defines the number and name of species as SPECIES AIR SPECIES SF6

Definition at line 43 of file Multispecies_getProperty.F90.

◆ Multispecies_getRealArrProperty()

subroutine Multispecies_getRealArrProperty ( integer, intent(in)  name,
integer, intent(in)  property,
real, dimension(:), intent(out)  value 
)

Definition at line 133 of file Multispecies_getProperty.F90.

◆ Multispecies_getStringProperty()

subroutine Multispecies_getStringProperty ( integer, intent(in)  name,
integer, intent(in)  property,
character(len=*), intent(out)  value 
)

Returns the value of an string property of the species name in value. The name is an integer because it is defined in Simulation.h based on Config data.

description integer property(defined as integer in Multispecies.h) -------------------------------------------------------------- EOS type MS_EOSTYPE Type of EOS for this species

name - name of species defined in Simulation.h, e.g., NI56_SPEC property - name of property define as an integer value - value of the returned property

NOTES

Species properties are normally set in Simulation_initSpecies. The simulation's Config file defines the number and name of species as SPECIES AIR SPECIES SF6

Definition at line 121 of file Multispecies_getProperty.F90.