deriv_alt

Module

Description

$Id$

** AUTOMATIC CPARAM.INC GENERATION ************************ Declare (for generation of cparam.inc) the number of f array variables and auxiliary variables added by this module

CPARAM integer, parameter :: nghost = 3


Quick access

Variables:

bval_from_3rd, bval_from_3rd_arr, bval_from_3rd_scl, bval_from_4th, bval_from_4th_arr, bval_from_4th_scl, bval_from_neumann, bval_from_neumann_arr, bval_from_neumann_scl, der, der2, der2_coef0, der2_coef1, der2_coef2, der2_coef3, der2_coef4, der2_coef5, der2_main, der2_other, der6, der6_main, der6_other, der_main, der_onesided_4_slice, der_onesided_4_slice_main, der_onesided_4_slice_main_pt, der_onesided_4_slice_other_pt, der_other, deri, deri_2d, deri_3d, derij, derij_main, derij_other, derivative_1, set_ghosts_for_onesided_ders_1d, test

Routines:

calc_coeffs_1(), der2_minmod(), der2_pencil(), der2_x(), der2_z(), der2i2j2k(), der3(), der3i2j1k(), der3i3j(), der4(), der4i1j1k(), der4i2j(), der5(), der5_single(), der5i1j(), der6(), der6_pencil(), der_onesided_4_slice_other(), der_pencil(), der_upwind1st(), der_x(), der_z(), deri_3d_inds(), distr_der(), finalize_deriv(), heatflux_deriv_x(), initialize_deriv(), set_ghosts_for_onesided_ders()

Needed modules

Variables

  • deriv/bval_from_3rd [public]
  • deriv/bval_from_4th [public]
  • deriv/bval_from_neumann [public]
  • deriv/calc_coeffs [private]
  • deriv/der [public]
  • deriv/der2 [public]
  • deriv/der2_main [private]
  • deriv/der2_other [private]
  • deriv/der6 [public]
  • deriv/der6_main [private]
  • deriv/der6_other [private]
  • deriv/der_main [private]
  • deriv/der_onesided_4_slice [public]
  • deriv/der_onesided_4_slice_main [private]
  • deriv/der_onesided_4_slice_main_pt [private]
  • deriv/der_onesided_4_slice_other_pt [private]
  • deriv/der_other [private]
  • deriv/deri [private]
  • deriv/deri_2d [private]
  • deriv/deri_3d [private]
  • deriv/derij [public]
  • deriv/derij_main [private]
  • deriv/derij_other [private]
  • deriv/derivative [private]
  • deriv/derivative_1 [private]
  • deriv/minmod [private]
  • deriv/test [private]

Subroutines and functions

subroutine  deriv/initialize_deriv()

Initialize stencil coefficients

Call to:

fatal_error(), calc_coeffs_1(), not_implemented(), warning(), der6(), heatflux_deriv_x()

subroutine  deriv/finalize_deriv()
Call to:

fatal_error(), not_implemented(), warning(), der6(), heatflux_deriv_x()

subroutine  deriv/deri_3d_inds(f, df, inds, j[, lnometric])

only for first derivatives, i.e., inds(i) = 1,7,8 !!!

Parameters:
  • f (mx,my,mz) [real,in]

  • df (nx) [real,out]

  • inds (nx) [integer,in]

  • j [integer,in]

  • lnometric [logical,in,]

Call to:

fatal_error(), not_implemented(), warning(), der6(), heatflux_deriv_x()

subroutine  deriv/der_z(f, df)

first z derivative operating on a z-dependent 1-D array

9-feb-07/axel: adapted from der_main; note that f is not the f array!

Parameters:
  • f (mz) [real,in]

  • df (nz) [real,out]

Call to:

fatal_error(), not_implemented(), warning(), der6(), heatflux_deriv_x()

subroutine  deriv/der2_z(f, df2)

z derivative operating on a z-dependent 1-D array

2-jan-10/axel: adapted from der_z and der_main

Parameters:
  • f (mz) [real,in]

  • df2 (nz) [real,out]

Call to:

fatal_error(), not_implemented(), warning(), der6(), heatflux_deriv_x()

subroutine  deriv/der_pencil(j, pencil, df)

Calculate first derivative of any x, y or z pencil.

01-nov-07/anders: adapted from der

Parameters:
  • j [integer,in]

  • pencil (*) [real,in]

  • df (*) [real,out]

Call to:

fatal_error(), not_implemented(), warning(), der6(), heatflux_deriv_x()

subroutine  deriv/distr_der(arr, idir, der[, order])

Dummy

Parameters:
  • arr (,) [real]

  • idir [integer]

  • der (,) [real]

  • order [integer]

Call to:

not_implemented(), fatal_error(), warning(), der6(), heatflux_deriv_x()

subroutine  deriv/der2_pencil(j, pencil, df2)

Calculate 2nd derivative of any x, y or z pencil.

01-nov-07/anders: adapted from der2

non-cartesian???

Parameters:
  • j [integer,in]

  • pencil (*) [real,in]

  • df2 (*) [real,out]

Call to:

fatal_error(), warning(), not_implemented(), der6(), heatflux_deriv_x()

subroutine  deriv/der3(f, k, df, j[, ignoredx])

Calculate 3rd derivative of a scalar, get scalar

10-feb-06/anders: adapted from der5

Parameters:
  • f (mx,my,mz,mfarray) [real,in]

  • k [integer,in]

  • df (nx) [real,out]

  • j [integer,in]

  • ignoredx [logical,in,]

Call to:

warning(), not_implemented(), fatal_error(), der6(), heatflux_deriv_x()

subroutine  deriv/der4(f, k, df, j[, ignoredx[, upwind]])
Calculate 4th derivative of a scalar, get scalar

Used for hyperdiffusion that affects small wave numbers as little as

possible (useful for density).

The optional flag IGNOREDX is useful for numerical purposes, where

you want to affect the Nyquist scale in each direction, independent of the ratios dx:dy:dz.

8-jul-02/wolf: coded 9-dec-03/nils: adapted from der6

10-feb-06/anders: corrected sign and factor

Parameters:
  • f (mx,my,mz,mfarray) [real,in]

  • k [integer,in]

  • df (nx) [real,out]

  • j [integer,in]

  • ignoredx [logical,in,]

  • upwind [logical,in,]

Call to:

warning(), not_implemented(), fatal_error(), der6(), heatflux_deriv_x()

subroutine  deriv/der5(f, k, df, j[, ignoredx])
Calculate 5th derivative of a scalar, get scalar

Used for hyperdiffusion that affects small wave numbers as little as

possible (useful for density).

The optional flag IGNOREDX is useful for numerical purposes, where

you want to affect the Nyquist scale in each direction, independent of the ratios dx:dy:dz.

29-oct-04/anders: adapted from der6

Parameters:
  • f (mx,my,mz,mfarray) [real,in]

  • k [integer,in]

  • df (nx) [real,out]

  • j [integer,in]

  • ignoredx [logical,in,]

Call to:

not_implemented(), fatal_error(), der6(), heatflux_deriv_x()

subroutine  deriv/der6_pencil(j, pencil, df6)

Calculate 6th derivative of any x, y or z pencil.

Parameters:
  • j [integer,in]

  • pencil (*) [real,in]

  • df6 (*) [real,out]

Call to:

not_implemented(), fatal_error(), der6(), heatflux_deriv_x()

subroutine  deriv/der2_minmod(f, j, delfk, delfkp1, delfkm1, k)

Calculates gradient of a scalar along the direction j but get for the derivatives at the point i-1,i,i+1

Parameters:
  • f (mx,my,mz,mfarray) [real,in]

  • j [integer,in]

  • delfk (nx) [real,out]

  • delfkp1 (nx) [real,out]

  • delfkm1 (nx) [real,out]

  • k [integer,in]

Call to:

fatal_error(), der6(), heatflux_deriv_x()

subroutine  deriv/der5i1j(f, k, df, i, j)

Calculate 6th derivative with respect to two different directions.

05-dec-06/anders: adapted from derij

Parameters:
  • f (mx,my,mz,mfarray) [real,in]

  • k [integer,in]

  • df (nx) [real,out]

  • i [integer,in]

  • j [integer,in]

Call to:

der6(), fatal_error(), heatflux_deriv_x()

subroutine  deriv/der_upwind1st(f, uu, k, df, j)

First order upwind derivative of variable

Useful for advecting non-logarithmic variables

Parameters:
  • f (mx,my,mz,mfarray) [real,in]

  • uu (nx,3) [real,in]

  • k [integer,in]

  • df (nx) [real,out]

  • j [integer,in]

Call to:

fatal_error(), heatflux_deriv_x()

subroutine  deriv/der_onesided_4_slice_other(f, sgn, df, pos, j)

Calculate x/y/z-derivative on a yz/xz/xy-slice at gridpoint pos. Uses a one-sided 4th order stencil. sgn = +1 for forward difference, sgn = -1 for backwards difference.

Because of its original intended use in relation to solving characteristic equations on boundaries (NSCBC), this sub should return only PARTIAL derivatives, NOT COVARIANT. Applying the right scaling factors and connection terms should instead be done when solving the characteristic equations.

7-jul-08/arne: coded.

Parameters:
  • f (mx,my,mz) [real,in]

  • sgn [integer,in]

  • df (,) [real,out]

  • pos [integer,in]

  • j [integer,in]

Call to:

heatflux_deriv_x(), fatal_error()

subroutine  deriv/calc_coeffs_1(grid, coeffs)
Parameters:
  • grid (4) [real,in]

  • coeffs (5,2) [real,out]

Call to:

heatflux_deriv_x(), fatal_error()

function  deriv/heatflux_deriv_x(f, inh, fac, topbot)
Parameters:
  • f (mx,my,mz,mfarray) [real,inout]

  • inh (my,mz) [real,in]

  • fac [real,in]

  • topbot [integer,in]

Return:

heatflux_deriv_x [logical]

Call to:

fatal_error()