gs2_heating Module

FIXME : Add documentation

GGH


Contents


Interfaces

public interface init_htype

Allocate the array components of heating_diagnostics

FIXME: Could be replaced with elemental constructor

  • private subroutine init_htype_0(h, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout) :: h
    integer, intent(in) :: nspec
  • private subroutine init_htype_1(h, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:) :: h
    integer, intent(in) :: nspec
  • private subroutine init_htype_2(h, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:,:) :: h
    integer, intent(in) :: nspec
  • private subroutine init_htype_3(h, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:,:,:) :: h
    integer, intent(in) :: nspec

public interface zero_htype

  • private subroutine zero_htype_0(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout) :: h
  • private subroutine zero_htype_1(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:) :: h
  • private subroutine zero_htype_2(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:,:) :: h
  • private subroutine zero_htype_3(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:,:,:) :: h

public interface del_htype

  • private subroutine del_htype_0(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout) :: h
  • private subroutine del_htype_1(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:) :: h
  • private subroutine del_htype_2(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:,:) :: h
  • private subroutine del_htype_3(h)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(heating_diagnostics), intent(inout), dimension(:,:,:) :: h

public interface init_dvtype

  • private subroutine init_dvtype_0(dv, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout) :: dv
    integer, intent(in) :: nspec
  • private subroutine init_dvtype_1(dv, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:) :: dv
    integer, intent(in) :: nspec
  • private subroutine init_dvtype_2(dv, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:,:) :: dv
    integer, intent(in) :: nspec
  • private subroutine init_dvtype_3(dv, nspec)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:,:,:) :: dv
    integer, intent(in) :: nspec

public interface zero_dvtype

  • private subroutine zero_dvtype_0(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout) :: dv
  • private subroutine zero_dvtype_1(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:) :: dv
  • private subroutine zero_dvtype_2(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:,:) :: dv
  • private subroutine zero_dvtype_3(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:,:,:) :: dv

public interface del_dvtype

  • private subroutine del_dvtype_0(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout) :: dv
  • private subroutine del_dvtype_1(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:) :: dv
  • private subroutine del_dvtype_2(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:,:) :: dv
  • private subroutine del_dvtype_3(dv)

    FIXME : Add documentation

    Arguments

    Type IntentOptional Attributes Name
    type(dens_vel_diagnostics), intent(inout), dimension(:,:,:) :: dv

Derived Types

type, public ::  heating_diagnostics

FIXME : Add documentation

Components

Type Visibility Attributes Name Initial
real, public :: energy
real, public :: energy_dot
real, public :: antenna
real, public :: eapar
real, public :: ebpar
real, public, dimension(:), pointer :: delfs2 => null()
real, public, dimension(:), pointer :: hs2 => null()
real, public, dimension(:), pointer :: phis2 => null()
real, public, dimension(:), pointer :: hypervisc => null()
real, public, dimension(:), pointer :: hyperres => null()
real, public, dimension(:), pointer :: hypercoll => null()
real, public, dimension(:), pointer :: collisions => null()
real, public, dimension(:), pointer :: imp_colls => null()
real, public, dimension(:), pointer :: gradients => null()
real, public, dimension(:), pointer :: heating => null()

type, public ::  dens_vel_diagnostics

Density-velocity perturbations

Components

Type Visibility Attributes Name Initial
real, public, dimension(:), pointer :: dvpar => null()
real, public, dimension(:), pointer :: dvperp => null()
real, public, dimension(:), pointer :: dn => null()

Subroutines

private subroutine init_htype_0(h, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout) :: h
integer, intent(in) :: nspec

private subroutine init_htype_1(h, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:) :: h
integer, intent(in) :: nspec

private subroutine init_htype_2(h, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:,:) :: h
integer, intent(in) :: nspec

private subroutine init_htype_3(h, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:,:,:) :: h
integer, intent(in) :: nspec

private subroutine zero_htype_0(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout) :: h

private subroutine zero_htype_1(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:) :: h

private subroutine zero_htype_2(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:,:) :: h

private subroutine zero_htype_3(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:,:,:) :: h

private subroutine del_htype_0(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout) :: h

private subroutine del_htype_1(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:) :: h

private subroutine del_htype_2(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:,:) :: h

private subroutine del_htype_3(h)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:,:,:) :: h

public subroutine avg_h(h, h_hist, istep, navg)

Calculate the average of various heating quantities

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout) :: h

The heating diagnostics at the current timestep

type(heating_diagnostics), intent(inout), dimension (0:) :: h_hist

The last navg timesteps of heating diagnostics

integer, intent(in) :: istep
integer, intent(in) :: navg

public subroutine avg_hk(hk, hk_hist, istep, navg)

Calculate the average of various heating quantities as a function of

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(inout), dimension(:,:) :: hk

Heating diagnostics as a function of at the current timestep

type(heating_diagnostics), intent(inout), dimension(:,:,0:) :: hk_hist

Heating diagnostics as a function of over the last navg timesteps

integer, intent(in) :: istep
integer, intent(in) :: navg

public subroutine hk_repack(hk, i, tmp)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(heating_diagnostics), intent(in), dimension (:,:) :: hk
integer, intent(in) :: i
real, intent(out), dimension(:,:,:) :: tmp

private subroutine init_dvtype_0(dv, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout) :: dv
integer, intent(in) :: nspec

private subroutine init_dvtype_1(dv, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:) :: dv
integer, intent(in) :: nspec

private subroutine init_dvtype_2(dv, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:,:) :: dv
integer, intent(in) :: nspec

private subroutine init_dvtype_3(dv, nspec)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:,:,:) :: dv
integer, intent(in) :: nspec

private subroutine zero_dvtype_0(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout) :: dv

private subroutine zero_dvtype_1(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:) :: dv

private subroutine zero_dvtype_2(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:,:) :: dv

private subroutine zero_dvtype_3(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:,:,:) :: dv

private subroutine del_dvtype_0(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout) :: dv

private subroutine del_dvtype_1(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:) :: dv

private subroutine del_dvtype_2(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:,:) :: dv

private subroutine del_dvtype_3(dv)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:,:,:) :: dv

public subroutine avg_dv(dv, dv_hist, istep, navg)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout) :: dv
type(dens_vel_diagnostics), intent(inout), dimension (0:) :: dv_hist
integer, intent(in) :: istep
integer, intent(in) :: navg

public subroutine avg_dvk(dvk, dvk_hist, istep, navg)

FIXME : Add documentation

Arguments

Type IntentOptional Attributes Name
type(dens_vel_diagnostics), intent(inout), dimension(:,:) :: dvk
type(dens_vel_diagnostics), intent(inout), dimension (:,:,0:) :: dvk_hist
integer, intent(in) :: istep
integer, intent(in) :: navg