extern_staticsine

Module

Description

This module contains routines relating to the computation of a static sinusoid potential (in 1D), i.e. phi = A cos(k(x+B))

References:

None

Owner:

Daniel Price

Runtime parameters:

• amplitude : Amplitude of sine perturbation

• inclination : Orientation angle of perturbation (rad, 0.0=aligned with x axis)

• phase : Phase of perturbation

• wavek : Wavenumber of perturbation

Dependencies:

infile_utils, io, physcon

Quick access

Variables:

amplitude, inclination, phase, wavek

Routines:

read_options_staticsine(), staticsine_force(), write_options_staticsine()

Needed modules

• physcon (pi(), twopi()): Physical and mathematical constants (as in sphNG)

Variables

• extern_staticsine/amplitude [real,public/optional/default=100.0]

• extern_staticsine/inclination [real,public/optional/default=0.0]

• extern_staticsine/phase [real,public/optional/default=2.0]

• extern_staticsine/wavek [real,public/optional/default=real(pi)/4.0]

Subroutines and functions

subroutine  extern_staticsine/staticsine_force(xi, yi, fxi, fyi, fzi, phi)

Parameters:

• xi [real,in]

• yi [real,in]

• fxi [real,out]

• fyi [real,out]

• fzi [real,out]

• phi [real,out]

subroutine  extern_staticsine/write_options_staticsine(iunit)

Parameters:

iunit [integer,in]

Use :

infile_utils (write_inopt())

subroutine  extern_staticsine/read_options_staticsine(name, valstring, imatch, igotall, ierr)

Parameters:

• name [character,in]

• valstring [character,in]

• imatch [logical,out]

• igotall [logical,out]

• ierr [integer,out]

Use :

physcon (pi()), io (fatal(), error())