FLASH4.5 API

Generated from /asc/asci2/site/flashcode/secure/release_4p5/source/Multispecies/Multispecies_getProperty.F90 with ROBODoc v4.99.8 on Tue Mar 05 16:16:16 2019

TABLE OF CONTENTS


[Functions] source/Multispecies/Multispecies_getProperty

[top][index]

NAME

  Multispecies_getProperty

SYNOPSIS

  Multispecies_getProperty(integer(in) :: name,
                           integer(in) :: property,
                           real(out)   :: value)

DESCRIPTION

  Returns the value of a property of the species name in value.
  The name is an integer because it is defined in Flash.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

ARGUMENTS

    name - name of species defined in Flash.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