quantity.F90

Go to the documentation of this file.

!! Copyright (C) 2020 N. Tancogne-Dejean
!!
!! This program is free software; you can redistribute it and/or modify
!! it under the terms of the GNU General Public License as published by
!! the Free Software Foundation; either version 2, or (at your option)
!! any later version.
!!
!! This program is distributed in the hope that it will be useful,
!! but WITHOUT ANY WARRANTY; without even the implied warranty of
!! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!! GNU General Public License for more details.
!!
!! You should have received a copy of the GNU General Public License
!! along with this program; if not, write to the Free Software
!! Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
!! 02110-1301, USA.
!!
 
#include "global.h"
 
 
module quantity_oct_m
  use iteration_counter_oct_m
  implicit none
 
  private
  public ::                   &
    quantity_t
 
  !# doc_start quantity
  integer, public, parameter ::         &
    POSITION                     =  1,  &
    velocity                     =  2,  &
    current                      =  3,  &
    density                      =  4,  &
    scalar_potential             =  5,  &
    vector_potential             =  6,  &
    e_field                      =  7,  &
    b_field                      =  8,  &
    mass                         =  9,  &
    charge                       = 10,  &
    permittivity                 = 11,  &
    permeability                 = 12,  &
    e_conductivity               = 13,  &
    m_conductivity               = 14,  &
    dipole                       = 15,  &
    max_quantities               = 15
  !# doc_end
 
  character(len=17), public, parameter :: QUANTITY_LABEL(MAX_QUANTITIES) = (/ &
    "position        ", &
    "velocity        ", &
    "current         ", &
    "density         ", &
    "scalar potential", &
    "vector potential", &
    "E field         ", &
    "B field         ", &
    "mass            ", &
    "charge          ", &
    "permittivity    ", &
    "permeability    ", &
    "e_conductivity  ", &
    "m_conductivity  ", &
    "dipole          "  &
    /)
 
  type quantity_t
    private
    type(iteration_counter_t), public :: iteration
    !                                                   !!
    !                                                   !! @note quantities dont have a constructor. The iteration counter is initialized automatically
    !                                                   !! for extenstions of system_t, but needs to be initialized explicitly for extensions of
    !                                                   !! interaction_partner_t, which are not systems.
 
    logical,       public :: required = .false.         
    !                                                   !!
    !                                                   !! true means that they are needed by either some interaction
    !                                                   !! or because they are dynamical variables of the system
    !                                                   !! (i.e., they appear in the differential equations governing
    !                                                   !! the systems dynamics). This is just a flag saying that the
    !                                                   !! system needs to compute and store these quantities. It says
    !                                                   !! nothing about **when** they should be updated.
 
    logical,       public :: always_available = .false. 
    !                                                   !!
    !                                                   !! (e.g., this will be true for a static quantity,
    !                                                   !! but false for a quantity that is only updated at specific iterations)
 
    logical,       public :: updated_on_demand = .true. 
    !                                                   !!
    !                                                   !! If true, the quantity is only updated when requested. The quantity should be calculated (updated)
    !                                                   !! in the systems update_quantity() routine.
    !                                                   !!
    !                                                   !! If false, the quantity is updated automatically during the execution of an algorithm.
    !                                                   !! In this case, the quantity should be updated inside the do_algorithmic_operation() routine.
 
  end type quantity_t
 
contains
 
end module quantity_oct_m
 
!! Local Variables:
!! mode: f90
!! coding: utf-8
!! End: