Back to Scrambler Intro

Field Objects

Field Objects are sub-objects of various processing routines. They essentially define what quantity (derived or not) you are interested in processing. For example, the Total Objects use a field to determine what quantity to sum over the entire mesh. The Field object has three properties:

• ID - a unique integer that determines which physical property (mass, kinetic energy, etc…)
• component - an integer that determines whether we are interested in the properties of the gas component (GASCOMP), the particle component (PARTICLECOMP), or both (BOTHCOMP)
• name - a string identifying the name of the quantity.

Here is a list of valid ID's

  Mass_Field
  Px_Field
  Py_Field
  Pz_Field
  E_Field
  Bx_Field
  By_Field
  Bz_Field
  KE_Field
  iE_Field
  BE_Field
  P_Field
  Temp_Field
  GravEnergy_Field
  MixingRatio12_Field

Additionally, any integer between 1 and NrVars can be used if the quantity is already stored in the q-array

You can also get the default name for fields by the GetName(ID) function. It is important that the names have no spaces in them.

  USE Fields
  TYPE(FieldDef) :: Field
  Field%ID=Mass_Field
  Field%component=GASCOMP
  Field%name=GetName(Mass_Field)

For more information about each field look in processing/fields.f90 for the GetField and GetParticleField routines where the definitions of each field are given