PLUTO  4.4-patch2
Macros | Variables
shearingbox.h File Reference

Shearing-Box module header file. More...

Go to the source code of this file.

Macros

#define SB_ORDER   2
 
#define SB_SYMMETRIZE_HYDRO   YES
 
#define SB_SYMMETRIZE_EY   (YES && (DIMENSIONS == 3))
 
#define SB_SYMMETRIZE_EZ   YES
 
#define SB_FORCE_EMF_PERIODS   NO
 
#define SB_Q   1.5
 
#define SB_OMEGA   1.0
 
#define SB_A   (-0.5*SB_OMEGA*SB_Q)
 

Variables

double sb_vy
 

Detailed Description

The Shearing-Box module header file contains basic macro definitions, function prototypes and declaration of global variables used by the sheraring-box module. The variable ::sb_q and ::sb_Omega are the most important ones and must be defined and initialized in your init.c in order to configure your shearing-box problem.

Optionally, the order of interpolation (default is 2) at physical boundaries may be changed using the SB_ORDER macro.

The additional macros SB_SYMMETRIZE_HYDRO, SB_SYMMETRIZE_EY and SB_SYMMETRIZE_EZ may be set to YES/NO to enable/disable enforcement of conservation at the radial (x) boundaries.

Authors
A. Mignone (migno.nosp@m.ne@t.nosp@m.o.inf.nosp@m.n.it)
G. Muscianisi (g.mus.nosp@m.cian.nosp@m.isi@c.nosp@m.inec.nosp@m.a.it)
Date
Dec 04, 2019
Todo:
Check if sb_vy and sb_Ly are really needed as global variables.

Macro Definition Documentation

◆ SB_A

#define SB_A   (-0.5*SB_OMEGA*SB_Q)

Short-hand definition for the Oort constant $ A = -q\Omega_0/2 $.

◆ SB_FORCE_EMF_PERIODS

#define SB_FORCE_EMF_PERIODS   NO

Force periodicity at y- and z- boundaries.

◆ SB_OMEGA

#define SB_OMEGA   1.0

Disk local orbital frequency $ \Omega_0 = \Omega(R_0)$.

◆ SB_ORDER

#define SB_ORDER   2

Sets the order of interpolation at physical boundaries (1, 2 or 3).

◆ SB_Q

#define SB_Q   1.5

The shear parameter, $\DS q = -\HALF\frac{d\log \Omega^2}{d\log R} $.

◆ SB_SYMMETRIZE_EY

#define SB_SYMMETRIZE_EY   (YES && (DIMENSIONS == 3))

Symmetrize the y-component of the electric field at the left and right x-boundaries to enforce conservation of magnetic field (only in 3D).

◆ SB_SYMMETRIZE_EZ

#define SB_SYMMETRIZE_EZ   YES

Symmetrize the z-component of electric field at the left and right x-boundaries to enforce conservation of magnetic field.

◆ SB_SYMMETRIZE_HYDRO

#define SB_SYMMETRIZE_HYDRO   YES

Symmetrize the hydrodynamical fluxes at the left and right x-boundaries in order to enforce conservation of hydrodynamic variables like density, momentum and energy (no magnetic field). Default is YES.

Variable Documentation

◆ sb_vy

double sb_vy

Velocity offset (>0), in SB_Boundary().