Parameters

Following is a list of parameters that can be used to configure physics and numerics of a simulation and the behavior of the program.

Active Parameters

For numerical parameters, the range of choices are abreviated as follows:

  • ‘-’ : the range includes negative numbers.

  • ‘0’ : the range includes zero.

  • ‘+’ : the range includes positive numbers.

Parameter

Choices

Default

Type

Unit Support

Description

AccreteWithoutDiskFeedback

yes, no

False

bool

False

Let planets accrete without disk feedback being enabled.

AdiabaticIndex

+

1.4

double

False

Numerical value or FIT_ISOTHERMAL (only for polytropic equation of state)

AlphaCold

0+

0.01

double

False

Alpha value for the cold state in scurve alpha.

AlphaHot

0+

0.1

double

False

Alpha value for the hot state in scurve alpha.

AlphaMode

0, 1, 2, 3

0

int

False

Select how the viscosity is calculated. 0: Const alpha 1: Scurve Alpha 2: Nbody distance dependend 3: Scurve Alpha with ion fraction

ArtificialViscosity

none, TW, SN

SN

string

False

Type of artificial viscosity [default = SN] TODO: change default to TW

ArtificialViscosityDissipation

yes, no

True

bool

False

Use artificial viscosity in dissipation function.

ArtificialViscosityFactor

+

1.41

double

False

Artificial viscosity factor/constant (von Neumann-Richtmyer constant).

AspectRatio

+

0.05

double

False

Set the reference value for the aspect ratio: h = ASPECTRATIO * r^{1+flaringindex}

AspectRatioMode

0, 1, 2

0

int

False

Compute aspectratio with respect to: 0: Primary object, 1: Nbody system, 2: Nbody center of mass

BitwiseExactRestarting

yes, no

False

bool

False

Write out Qplus and Qminus 2D arrays to snapshot for bitwise exact restarting. This is really usefull to test development changes in the code.

BodyForceFromPotential

yes, no

True

bool

False

Consider the gravitational force from the Nbody onto the disk via the potential.

CFL

+

0.5

double

False

CFL factor.

CFLmaxVar

+

1.1

double

False

Maximum variation of the CFL timestep over one iteration.

CICPLANET

yes, no

False

bool

False

Initialize planets in center of cell. Only works for zero eccentricity.

CartesianParticles

yes, no

False

bool

False

Particle coordinates are stored in memory and in output files in cartesian coordinates.

CenterProfileDensityCorrectionFactor

1

double

False

?

CircumBinaryDecayExponent

0.75

double

False

?

CircumBinaryDecayWidth

0.84

double

True

?

CircumBinaryRing

yes, no

False

bool

False

Initialize a circumbinary ring.

CircumBinaryRingEnhancementFactor

2.5

double

False

?

CircumBinaryRingPosition

4.5

double

True

Position of the circumbinary ring.

CircumBinaryRingWidth

0.6

double

True

Width of the circumbinary ring.

CompatibilityNoStarSmoothing

False

bool

False

Disable smoothing of the gravitational interaction for the central star. This is included for compatibility reasons to compare to simulations of other codes which do not smooth gravity from the central star. . See Mueller & Kley (2013) doi:10.1051/0004-6361/201322503 for why this is important.

CompatibilitySmoothingPlanetLoc

yes, no

False

bool

False

Use the scale height at the planet position for the smoothing length calculation instead of the scaleheight at the cell. This is included for compatibility reasons to compare to simulations of other codes which do not use the scale height at the location of the cell. See Mueller & Kley (2013) doi:10.1051/0004-6361/201322503 for why this is important.

ConstantViscosity

0+

0

double

True

Set a constant kinetic viscosity.

CoolingBeta

0+

1

double

False

Paramter value of beta for the beta cooling.

CoolingBetaLocal

yes, no

False

bool

False

Enable beta cooling Q- = T * Omega/beta

CoolingBetaRampUp

0+

0

double

True

Increase beta cooling on this timescale.

CoolingBetaReference

zero, reference, diskmodel, floor

Zero

string

False

Reference temperature/energy profile for beta cooling.

CoolingRadiativeFactor

+

1

double

False

Fudge factor for radiative cooling. Leave this at 1.

CorotationReferenceBody

+

1

unsigned int

False

Select the Nbody object which is the reference object for the automatic calculation of the corotation angular velocity for a rotating frame.

CorrectDiskSelfgravity

yes, no

True

bool

False

Substract the azimuthal average of the surface density in the calculation of torques on Nbody object to make the disk and Nbody have the same central mass around which they orbit. See Baruteau & Masset (2008). [default=not selfgravity turned on]

Damping

yes, no

False

bool

False

Use a wave-damping zone. Exponentially damp to a profile.

DampingEnergyInner

reference, mean, zero, none

None

string

False

Target quantity of energy at inner boundary

DampingEnergyOuter

reference, mean, zero, none

None

string

False

Target quantity of energy at outer boundary

DampingInnerLimit

+

1.05

double

False

Set the outer limit of the inner wave damping zone: Rmin*Limit. Zone is diabled for limit < 1. Rmin is the radius of the inner boundary.

DampingOuterLimit

+

0.95

double

False

Set the inner limit of the outer wave damping zone: Rmax*Limit. Zone is diabled for limit > 1. Rmax is the radius of the outer boundary.

DampingSurfaceDensityInner

reference, mean, zero, none

None

string

False

Target quantity of surface density at inner boundary

DampingSurfaceDensityOuter

reference, mean, zero, none

None

string

False

Target quantity of surface density at outer boundary

DampingTimeFactor

+

1

double

False

Damping time factor. Values will be exponentially damped on a timescale of factor*Keplerian Period at boundary radius.

DampingTimeRadiusOuter

+

2.5

double

False

Reference radius for the outer damping time. default: Outer domain radius RMAX

DampingVAzimuthalInner

reference, mean, zero, none

None

string

False

Target quantity of azimuthal velocity at inner boundary

DampingVAzimuthalOuter

reference, mean, zero, none

None

string

False

Target quantity of azimuthal velocity at outer boundary

DampingVRadialInner

reference, mean, zero, visc, none

None

string

False

Target quantity of radial velocity at inner boundary. For damping to viscous speed, use visc.

DampingVRadialOuter

reference, mean, zero, none

None

string

False

Target quantity of radial velocity at outer boundary

DensityFactor

+

2.5066282746310002

double

False

Factor for convertion from surface density to density. Leave this as it is! [default = sqrt(2.0*pi)]

Disk

yes, no

True

bool

False

Turn on hydro part of the simulation. Set this to no to, e.g., test the dust module.

DiskFeedback

yes, no

True

bool

False

Enable gravitational forces from the disk onto the planets. Enable migration.

DiskMass

+

0.01

double

True

In case of SetSigma0=yes, use this mass as diskmass.

DiskRadiusMassFraction

+

0.99

double

False

Calculation of the disk radius: this fraction of the total mass is contained within the disk radius.

DoWrite1DFiles

yes, no

True

bool

False

Write out 1D files additional to the 2D output.

EnergyCondition

Profile, 1D, 2D, Nbody

Profile

string

False

Initialize energy by Profile, 1D data file or 2D data file, or by profile centered on nbody.

EnergyFilename

string

False

File to read energy from (when Condition = 1D or 2D)

EquationOfState

Isothermal, Ideal/Adiabatic, PVTE, Polytropic

Isothermal

string

False

Select the equation of state.

ExponentialCellSizeFactor

+

1.41

double

False

Cell size increase factor to build an exponential grid. Only relevant for exponential grid type.

FeatureSize

+

0.014000000000000002

double

True

Feature size of the open somplex algorithm.

FirstDT

+

1e-09

double

True

Initialization value for the hydro dt in case of hydro simulations turned off. Otherwise CFL dt is used.

FlaringIndex

0+

0

double

False

Specify the flaring index. H = H0 * r^{1+FlaringIndex}.

FluxLimiter

VanLeer, MC

VanLeer

string

False

Selec the flux limiter for the upwind scheme.

Frame

F, C

Fixed

string

False

Select whether the rotating frame has a fixed angular velocity (F) or if it is updated (C). F: Fixed, C: Corotating

HeatingCoolingCFLlimit

+

10

double

False

Energy change dT/T in substep3 only allowed to change by this fraction times CFL.

HeatingViscous

yes, no

True

bool

False

Enable viscous heating. TODO: change default to yes

HeatingViscousFactor

positive float.

1

double

False

Fudge factor for viscous heating. Leave this at 1.

HydroFrameCenter

primary, binary, tertiary, quatirary, all

primary

string

False

Specify the origin of the simulation grid. Primary uses the central object, binary/tertiary/quatirary/all uses the center of mass of the first 2/3/4/all nbody objects

HydrogenMassFraction

+

0.75

double

False

Mass fraction of hydrogen in the gas for the case of scurve cooling.

ImposedDiskDrift

0+

0

double

False

Be careful and check the code! This is old code! Initialize vrad with an imposed accretion through the disk and add an additional torque during the simulation. vrad = ImposedDiskDrift * Sigma0 / Sigma_avg_azimuthal / R.

IndirectTermMode

0, 1

0

int

False

Select the way the indirect term is calculated. You likely want 0. 0: indirect term from rebound with shift; 1: euler with shift (original)

InitializePureKeplerian

yes, no

False

bool

False

Initialize VRadial=0 and VAzimuthal=(GM/r)^(1/2)

InitializeVradialZero

yes, no

False

bool

False

Initialize VRadial=0 [default = no]

InnerBoundary

Zerogradient, Outflow, Viscous, Reflecting, Reference, CenterOfMass, Custom, Individual

individual

string

False

Boundary condition at the inner boundary.

InnerBoundaryEnergy

Zerogradient, DiskModel, Reference, Infer

infer

string

False

Boundary condition for the energy at the inner boundary.

InnerBoundarySigma

Zerogradient, DiskModel, Reference, Infer

infer

string

False

Boundary condition for the surface density at the inner boundary.

InnerBoundaryVazi

ZeroGradient, Reference, ZeroShear, Balanced, Keplerian, Infer

keplerian

string

False

Boundary condition for the azimuthal velocity at the inner boundary.

InnerBoundaryVaziKeplerianFactor

0+

1

double

False

For InnerBoundaryVazi = Keplerian, the inner ghostcell vazi is set to this factor times the keplerian velocity.

InnerBoundaryVrad

ZeroGradient, Reference, Reflecting, Outflow, Viscous, Keplerian, Infer

infer

string

False

Boundary condition for the radial velocity at the inner boundary.

InnerBoundaryVradKeplerianFactor

0+

0.1

double

False

For InnerBoundaryVrad = Keplerian, the inner ghostcell vrad is set to this factor times the keplerian velocity.

IntegrateParticles

yes, no

False

bool

False

Enable the particle module.

Integrator

Euler, LeapFrog

Euler

string

False

Select timestepping for hydro simulation: Euler or LeapFrog

KappaConst

0+

1

double

True

Opacity value for the cases of Opacity = constant or Opacity = simple.

KappaFactor

0+

1

double

False

Danger zone: Fudge factor for kappa. Use this to increase/decrease to scale the restults of fixed opacity laws.

KeepDiskMassConstant

yes, no

False

bool

False

Danger zone: Rescale the mass of the disk periodically. You likely want to keep this turned off.

KlahrSmoothingRadius

0+

0.3

double

False

Smoothing radius for Klahr & Kley smoothing around the secondary if H is calculated using all Nbody objects.

LogAfterRealSeconds

positive integers

600

double

False

Write a log message to console after this number of real seconds. Setting to 0 disables this feature.

LogAfterSteps

positive integers

0

unsigned int

False

Write a log message to console after this number hydro steps. Setting to 0 disables this feature.

MassAccretionRadius

0+

1

double

False

When accretion onto Nbody abjects is turned on, accrete from the disk within MassAccretionRadius*RRoche.

MaximumTemperature

+

1.0e300 K

double

True

Temperature ceiling.

MinimumTemperature

0+

3 K

double

True

Temperature floor.

MonitorTimestep

+

1

double

True

Calculate scalar quatities every MonitorTimestep in code units. For default units 2PI = 1 orbit at r=1. This is analogous to the DT parameter in other FARGO versions.

Naz

+

64

unsigned int

False

Number of azimuthal cells in the hydro grid.

Nmonitor

+

10

unsigned int

False

Number of monitor outputs between two snapshots.

Nrad

+

64

unsigned int

False

Number of radial cells in the hydro grid.

Nsnapshots

+

1000

unsigned int

False

Number of snapshots. The final time will be tfinal = NsnapshotsNmonitorMonitorTimestep. Please note that this is a different from FARGO3D!

NumberOfParticles

+

0

unsigned int

False

Number of particles.

OmegaFrame

0+

0

double

True

Specify the angular velocity with which the frame rotates. Units of 1/T0. Specifying 2pi is equivalent to a corotating frame at R=R0.

Opacity

Lin, Bell, Constant, Simple

Lin

string

False

Opacity table to use.

OuterBoundary

Zerogradient, Outflow, Reflecting, Reference, CenterOfMass, Custom, Individual

individual

string

False

Boundary condition at the outer boundary.

OuterBoundaryEnergy

Zerogradient, DiskModel, Reference, Infer

infer

string

False

Boundary condition for the energy at the outer boundary.

OuterBoundarySigma

Zerogradient, DiskModel, Reference, Infer

infer

string

False

Boundary condition for the surface density at the outer boundary.

OuterBoundaryVazi

ZeroGradient, Reference, ZeroShear, Balanced, Keplerian, Infer

keplerian

string

False

Boundary condition for the azimuthal velocity at the outer boundary.

OuterBoundaryVaziKeplerianFactor

0+

1

double

False

For OuterBoundaryVazi = Keplerian, the inner ghostcell vazi is set to this factor times the keplerian velocity.

OuterBoundaryVrad

ZeroGradient, Reference, Reflecting, Outflow, Viscous, Keplerian, Infer

infer

string

False

Boundary condition for the radial velocity at the outer boundary.

OuterBoundaryVradKeplerianFactor

0+

0.1

double

False

For OuterBoundaryVrad = Keplerian, the inner ghostcell vrad is set to this factor times the keplerian velocity.

OutputDir

setupfile name

string

False

Specify the output directory.

ParticleDensity

+

2.65 g/cm3

double

True

Particle material density. [default = 2.65 g/cm3, Siliciumdioxid].

ParticleDiskGravityEnabled

yes, no

False

bool

False

Enable disk self-gravity acting on particles. TODO: this should be set to default to reflect the self-gravity flag.

ParticleDustDiffusion

yes, no

False

bool

False

Enable dust diffusion.

ParticleEccentricity

0+

0

double

False

Initialize the particles with eccentricities drawn from a uniform random distribution between 0 and this number.

ParticleGasDragEnabled

yes, no

True

bool

False

Enable particle gas drag.

ParticleIntegrator

explicit, midpoint

m

string

False

Select the particle integrator. Explicit (Cash-Carp with adaptive timesteping), Midpoint (Mignone 2019)

ParticleMaximumEscapeRadius

+

2.5

double

True

Eject particles that move outside this radius. [default = ParticleMaximumRadius]

ParticleMaximumRadius

+

2.5

double

True

Initialize particles up to this radius. [default = RMAX]

ParticleMinimumEscapeRadius

0+

0.4

double

True

Eject particles that move inside this radius. [default = ParticleMinimumRadius]

ParticleMinimumRadius

0+

0.4

double

True

Initialize particles starting at this radius. [default = RMIN]

ParticleRadius

+

100.0 cm

double

True

Radius of a single particle (assumed to be spherical).

ParticleRadiusIncreaseFactor

+

10

double

False

Increase the size of each particle species by this factor. The size of the nth particle species is then ParticleRadius*IncreaseFactor^{n-1}.

ParticleSpeciesNumber

+

1

unsigned int

False

Number of particle species/sizes. This works in tandem with ParticleRadiusIncreaseFactor.

ParticleSurfaceDensitySlope

-0+

0

double

False

Slope of particle surface density distribution: Sigma(r) = Sigma0 * r^(-ParticleSurfaceDensitySlope). [default = SigmaSlope]

PlanetOrbitDiskTest

yes, no

False

bool

False

Danger zone: Enable test mode for a planet orbiting around just a disk. You likely never need this.

PolytropicConstant

+

12.753

string

False

Set the polytropic constant for the polytropic equation of state.

ProfileCutoffInner

yes, no

False

bool

False

Enable exponential cutoff for the density profile at the inner boundary.

ProfileCutoffOuter

yes, no

False

bool

False

Enable exponential cutoff for the density profile at the outer boundary.

ProfileCutoffPointInner

0+

0

double

True

Location of the cuttoff at the inner boundary.

ProfileCutoffPointOuter

+

1e+300

double

True

Location of the cuttoff at the outer boundary.

ProfileCutoffWidthInner

+

1

double

True

Width of the cutoff at the inner boundary.

ProfileCutoffWidthOuter

+

1

double

True

Width of the cutoff at the outer boundary.

QuantitiesRadiusLimit

+

5

double

True

Limit the calculation of disk quantities to inside this radius. [default = RMAX]

ROFVariableTransfer

yes, no

False

bool

False

Rochlobe overflow, variable transfer. TODO describe this better.

ROFaveragingtime

+

10

double

False

Rochlobe overflow, variable transfer averaging time. TODO describe this better.

ROFgamma

+

0.5

double

False

Rochlobe overflow, variable transfer gamma

ROFplanet

+

1

int

False

Rochlobe overflow, number of Nbody object from which the stream originates

ROFrampingtime

0+

30

double

False

Ramp-up time for Rochlobe overflow in units of the reference planets orbital period.

ROFtemperature

+

1000.0 K

double

True

Rochlobe overflow, sets initial temperature and width of stream

ROFvalue

0+

1e-08

double

True

Mass accretion rate through the stream of the Rochelobe overflow.

RadialSpacing

Logarithmic, Arithmetic, Exponential

Arithmetic

string

False

Type of the radial grid spacing of the hydro grid.

RadialViscosityFactor

+

1

double

False

Danger zone! Check the code for what this does! Viscosity in radial direction is mutliplied with this factor to avoid oscillations.

RadiativeDiffusion

yes, no

False

bool

False

Turn on radiation transport using FLD to simulate radiative transport in the midplane.

RadiativeDiffusionAutoOmega

yes, no

False

bool

False

Danger zone! Testing needed! Automatically update SOR omega.

RadiativeDiffusionCheckSolution

yes, no

False

bool

False

For RadiativeDiffusionTest2D enabled, check the solution.

RadiativeDiffusionDumpData

yes, no

False

bool

False

Write out internal variables (matrix elements and diffusion coefficents) for debugging.

RadiativeDiffusionInnerBoundary

ZeroFlux, ZeroGradient, Outflow

none

string

False

Inner boundary condition for the diffusion equation. You need to set this when using the FLD module.

RadiativeDiffusionMaxIterations

+

50000

unsigned int

False

Maximum number of SOR iterations for FLD.

RadiativeDiffusionOmega

+

1.5

double

False

Parameter for the succesive-overrelaxation (SOR) solver for the linear system of the FLD radiative transport.

RadiativeDiffusionOuterBoundary

ZeroFlux, ZeroGradient, Outflow

none

string

False

Outer boundary condition for the diffusion equation. You need to set this when using the FLD module.

RadiativeDiffusionTest1D

yes, no

False

bool

False

Enable the 1D test case for the FLD module.

RadiativeDiffusionTest2D

yes, no

False

bool

False

Enable the 2D test case for the FLD module. This simulates a 2D diffusion process.

RadiativeDiffusionTest2DDensity

+

1.0 g/cm3

double

True

Set the constant density for the 2D test.

RadiativeDiffusionTest2DK

+

1

double

False

Set the diffusion coefficient for the 2D test.

RadiativeDiffusionTest2DSteps

+

1

unsigned int

False

Number of times to repleat SOR during the 2D test.

RadiativeDiffusionTolerance

+

1e-10

double

True

Absolute value of tolerance for the SOR solver. This is in units of temperature. If specified without temperature, it’s a multiple of the code unit of temperature.

RandomFactor

+

0.1

double

False

Randomize the initial surface density by this factor times noise of order 1.

RandomSeed

+

0

int

False

Random seed integer value for noise on initial profile.

RandomSigma

yes, no

False

bool

False

Put random noise on surface density at start values.

Rmax

+

none

double

True

Outer domain radius of the hydro grid.

Rmin

+

none

double

True

Inner domain radius of the hydro grid.

RocheLobeOverflow

yes, no

False

bool

False

Add a stream of mass from a secondary to the disk. This is added ontop of the outer boundary condition.

ScurveType

Kimura

string

False

Type of the scurve cooling. This sets the F_hot constant to 23.405 (Kimura) or 25.49 (Ichikawa).

SecondaryDisk

yes, no

False

bool

False

Initialize a secondary disk. This is used for binary star systems.

SelfGravity

Yes, Z, No

False

bool

False

Enable self-gravity. This uses the Fourier-Convolution technique from Clement Baruteau with a modification for the scale height by Tobias Modlenhauer to make the accelerations symmetric.

SelfGravityAspectRatioChangeThreshold

+

0.001

double

False

The self-gravity modules updates the kernel only if the aspect ratio changes by more than this threshold.

SelfGravityMode

basic, symmetric, besselkernel

besselkernel

string

False

Type of kernel to use. Likely ‘besselkernel’ is the best choice (by Steven Rendon Restrepo). Its valid in the limit of large Toomre parameter. It avoids introducing a smoothing length. ‘symmetric’ also shares this feature by introducing a corrected self-gravity smoothing length (by Tobias Moldenhauer). Its best in the limit of Toomre parameter close to 1. ‘basic’ is the original implementation by Clement Baruteau. This formulation is not symmetric.

SelfGravityStepsBetweenKernelUpdate

+

20

unsigned int

False

Only update the kernel every SelfGravityStepsBetweenKernelUpdate steps. This is important for the besselkernel mode because the kernel update is computationally expensive then.

SetSigma0

yes, no

False

bool

False

Renormalize Sigma0 to have M_disc = discmass in units.

ShockTube

0, 1, 2

0

int

False

Initialize shocktube problem with 0:no shocktube 1:Ideal EOS (perfect gas) 2: PVTE EOS (variableGamma)

Sigma0

+

173 g/cm2

double

True

Set the scale for the Surface density profile: Sigma = Sigma0 * r^-SigmaSlope.

SigmaCondition

Profile, 1D, 2D, Nbody

Profile

string

False

Initialize surface density by Profile, 1D data file or 2D data file, or Profile centered on nbody.

SigmaFilename

string

False

File to read surface density from (when Condition = 1D or 2D)

SigmaFloor

+

1e-09

double

False

Floor surface density in multiples of sigma0.

SigmaSlope

float

0

double

False

Powerlaw exponent (the nagative of it) of the initial surface density profile. Sigma = Sigma0 * r^-SigmaSlope.

SpreadingRing

yes, no

False

bool

False

Initialize the simulation with the spreading ring test case.

StabilizeArtViscosity

0+

0

double

False

Artificially stabilize artificial viscosity to avoid numerical issues.

StabilizeViscosity

0+

0

int

False

Artificially stabilize viscosity to avoid numerical issues.

SurfaceCooling

no, thermal, scurve

False

string

False

Enable surface cooling. Thermal: cooling by blackbody radiation. Scurve: cooling by scurve cooling.

TauFactor

+

0.5

double

False

Danger zone! Fudge factor for tau. Leave this as it is! [default = 0.5] TODO: change default value.

TauMin

+

0.01

double

False

Tau min for the effective optical depth calculation. See Hubney (1990), Mueller & Kley (2012) and DAngelo & Marzari (2015).

Temperature0

-0+

-1

double

True

If > 0, set the reference temperature at l0 instead of using the reference aspect ratio.

ThicknessSmoothing

+

0.6

double

False

Smoothing/softening parameters for the Nbody-disk gravitional interaction in multiples of the disk scaleheight.

ThicknessSmoothingSG

1.2

double

False

Smoothing/softening parameter for SG [default = ThicknessSmoothing]

Transport

fast, slow

Fast

string

False

Specify whether or not to use the Fargo method (fast) or the standard method (slow).

VazimuthalConsidersQuadropoleMoment

yes, no

False

bool

False

Add quadropole moment support in initialization of azimuthal velocity.

ViscAccretMassflowTest

yes, no

False

bool

False

Enable viscous accretion massflow test.

ViscousAlpha

0+

0

double

False

Specify the value of alpha for the alpha viscosity model.

ViscousOutflowSpeed

+

1

double

False

# Viscous outflow speed vr(0) = -3/2 nu / R(0) * ViscousOutflowSpeed used for Inner/OuterBoundaryVrad = Viscous.

WriteAlpha

yes, no

False

bool

False

Write 2D data of viscous alpha.

WriteAlphaGrav

yes, no

False

bool

False

Write 2D array of alpha value gravitational strees.

WriteAlphaGravMean

yes, no

False

bool

False

Write 2D array of azimuthal mean of the alpha value of gravitational stress.

WriteAlphaReynolds

yes, no

False

bool

False

Write 2D array of alpha value Reynolds strees.

WriteAlphaReynoldsMean

yes, no

False

bool

False

Write 2D array of azimuthal mean of the alpha value of Reynolds stress.

WriteAspectratio

yes, no

False

bool

False

Write 2D array of the aspect ratio.

WriteAtEveryTimestep

yes, no

True

bool

False

Write some quantities (planet positions, disk quantities, …) at every Timestep.

WriteDefaultValues

yes, no

False

bool

False

Write a yaml file to the output directory containing all default values hardcoded in the code.

WriteDensity

yes, no

True

bool

False

Write surface density. This is needed for restart of simulations.

WriteDiskQuantities

yes, no

True

bool

False

Write a collection of disk quantities (mass, eccentricity, periastron, semi_major_axis, …)

WriteDivV

yes, no

False

bool

False

Write 2D array of divergence of velocity.

WriteEccentricity

yes, no

False

bool

False

Write 2D array of eccentricity based on specific angular momentum of the cell.

WriteEccentricityChange

yes, no

False

bool

False

Eccentricity change monitor.

WriteEffectiveGamma

yes, no

False

bool

False

Write 2D effective adiabatic index.

WriteEnergy

yes, no

True

bool

False

Write energy. This is needed for restart of (adiabatic) simulations.

WriteFirstAdiabaticIndex

yes, no

False

bool

False

Write 2D data of the first adiabatic index. Usefull for PVTE EoS.

WriteGasTorques

yes, no

False

bool

False

Calculate and write gravitational/viscous and advection torques on gas. See Miranda et al. 2017

WriteKappa

yes, no

False

bool

False

Write 2D array of opacity.

WriteLightCurves

yes, no

False

bool

False

Danger zone! Check the code! Write light curves.

WriteLightCurvesRadii

yes, no

none

string

False

Danger zone! Check the code! Write radii for which the light curves are outputed.

WriteMassFlow

yes, no

False

bool

False

Write a 1D radial file with mass flow at each interface. Track accretion through the disk.

WriteMeanMolecularWeight

yes, no

False

bool

False

Write 2D data of mean molecular weight.

WritePotential

yes, no

False

bool

False

Write 2D array of the gravitational potential.

WritePressure

yes, no

False

bool

False

Write 2D array of pressure.

WriteQMinus

yes, no

False

bool

False

Write 2D array of cooling terms.

WriteQPlus

yes, no

False

bool

False

Write 2D array of heating terms.

WriteRadialDissipation

yes, no

False

bool

False

Write 1D raidal array of dissipated energy.

WriteRadialLuminosity

yes, no

False

bool

False

Write 1D radial array of luminosity.

WriteSGAccelAzi

yes, no

False

bool

False

Write 2D array of the azimuthal component of the gravitational stress.

WriteSGAccelRad

yes, no

False

bool

False

Write 2D array of the radial component of the gravitational stress.

WriteScaleHeight

yes, no

False

bool

False

Write 2D array of the scale height.

WriteSoundSpeed

yes, no

False

bool

False

Write 2D sound speed.

WriteTGravitational

yes, no

False

bool

False

Write 2D array of the gravitational stress.

WriteTReynolds

yes, no

False

bool

False

Write 2D array of the Reynolds stress.

WriteTau

yes, no

False

bool

False

Write 2D array of optical depth.

WriteTauCool

yes, no

False

bool

False

Write 2D array of optical depth for cooling.

WriteTemperature

yes, no

False

bool

False

Write 2D temperature.

WriteToomre

yes, no

False

bool

False

Write 2D array of Toomre parameter Q.

WriteTorques

False

bool

False

Calculate and write 2D array of torques acting on each planet/star.

WriteVelocity

yes, no

True

bool

False

Write velocites. This is needed for restart of simulations.

WriteVerticalOpticalDepth

yes, no

False

bool

False

Write 2D of optical depth in vertical direction (tau_eff by Hubeny [1990]).

WriteViscosity

yes, no

False

bool

False

Write 2D array of the kinematic viscosity.

WriteVisibility

yes, no

False

bool

False

Write 2D array of visibility.

WritepDV

yes, no

False

bool

False

Write 2D array of pressure * divergence of v.

cps

+

-1

double

False

Set the resolution in terms of cells per scaleheight ar r=1: if cps > 0, overrides Nrad and Nsec and initializes them according to domain size and AspectRatio.

l0

+

1.0

string

True

Base length unit of the simulation [default: 1.0 au]

m0

+

1.0

string

True

Base mass unit of the simulation [default: 1.0 solMass]

mu

positive float

1

double

False

Mean molecular weight of the gas. TODO: change default value.

t0

+

1.0

string

True

Base time unit of the simulation [default: 1/2pi * Keplerian orbital period at r=l0 around mass m0]

temp0

+

1.0

string

True

Base temperature unit of the simulation [default: such that Rgas = 1]

Nbody Parameters

Parameter

Choices

Default

Type

Unit Support

Description

accretion efficiency

0+

0

double

False

Accretion efficiency factor. Fraction of the mass in the Hill sphere to accrete every orbit.

argument of pericenter

0-2pi

0

double

False

Argument of pericenter of the initial orbit in radians.

eccentricity

0-1

0

double

False

Eccentricity of the initial orbit.

irradiation ramp-up time

0+

0

double

True

Ramp-up time for the irradiation in multiples of the orbital period.

mass

0+

none

double

True

Inital mass.

name

none

string

False

Name of the body.

radius

0+

0.009304813 au

double

True

Radius of the body (assumed to be a sphere). Is constant in time.

ramp-up time

0+

0

double

False

Ramp-up time for the mass of the planet. This only affects the gravitational interactions.

semi-major axis

0+

none

double

True

Semimajor axis of the initial orbit.

temperature

0+

0.0 K

double

True

Temperature of the body. Is constant in time.

trueanomaly

0+

0

double

False

True anomaly of the initial orbit in radians.

Deprecated Parameters

Parameter

Newname

Hint

Choices

Default

Type

Unit Support

Description

ALPHAVISCOSITY

ViscousAlpha

0

Specify the value of alpha for the alpha viscosity model.

Adiabatic

none

EquationOfState: Ideal

False

string

False

Deprecated. Dont use this anymore.

AlphaThreshold

none

positive values

5000

double

False

?Threshold value for viscosity stabalized?

CoolingRadiativeLocal

none

SurfaceCooling: thermal

yes, no

False

Enable local radiative cooling Q- = 2 * sigma_R * T_eff^4.

CoolingScurve

none

SurfaceCooling: scurve

yes, no

False

Enable Scurve Cooling

DT

MonitorTimestep

1

Time between two analysis outputs. For default units, 2PI = 1 orbit at r=1.

DebugOutputs

none

yes, no

False

bool

False

Write out additional debug files.

DomegaDrZero

none

OuterBoundaryAzi = zeroshear

yes, no

False

Set dOmega/dr = 0 at outer boundary

ExplicitViscosity

none

Set ViscousAlpha > 0 or ConstantViscosity > 0

yes, no

False

bool

False

Consider explicit viscocsity.

ForcedCircular

none

yes, no

False

bool

False

Keep the eccentricity of the planet to zero. [default = no]

HeatingStar

none

Set temperature of any Nbody object > 0 to enable irradiation from this object.

yes, no

False

bool

False

Enable irradiation heating by the star.

HeatingStarFactor

none

Change the temperature of the Nbody object to modulate the heating.

positive value

double

False

Modulate the heating by this factor.

HeatingStarRampingTime

none

Use key ‘irradiation ramp-up time’ for Nbody objects.

positive value

double

False

Ramp up the heating over this time.

HeatingStarSimple

none

This is now the only option.

yes, no

False

bool

False

Enable simple irradiation heating by the star solely based on distance.

IntegratePlanets

none

yes, no

True

Evolve the Nbody system.

MassAccretionRate

none

1e-09

double

True

For inner boundary = boundary layer: Mass accretion rate (from secondary, young stellar cloud, etc.).

NSEC

Naz

64

Number of azimuthal cells

NTOT

Nsnapshots

1000

Number of snapshots to be written.

Ninterm

Nmonitor

none

unsigned int

False

Number of analysis outputs between two snapshots.

OuterSourceMass

none

False

bool

False

?

StarRadius

none

Use key ‘radius’ for Nbody objects.

positive value

double

False

Radius of the star used together with StarTemperature for computing the flux.

StarTemperature

none

Use key ‘temperature’ for Nbody objects.

positive value

double

False

Radius of the star used together with StarRadius for computing the flux.

StellarRotation

none

InnerBoundaryVaziKeplerianFactor, InnerBoundaryVazi = keplerian

0.1

For inner boundary = boundary layer: Stellar rotation rate (azimuthal velocity of the surface) in terms of Keplerian angular velocity at the inner boundary.

StsNu

none

The STS module has been removed.

positive value

0.01

double

False

Set the value of the viscosity for the STS module.

Temperaturecgs0

none

Use Temperature0 instead. Append a ‘K’ to the value to set the temperature in Kelvin.

positive value

none

double

False

Set the reference temperature in cgs units.

VISCOSITY

ConstantViscosity

0

Set a constant kinetic viscosity.

VRadIn

none

InnerBoundaryVradKeplerianFactor, InnerBoundaryVrad = keplerian

0.0016

For inner boundary = boundary layer: value of v_rad at inner boundary in terms of Keplerian velocity v_kepler at the inner boundary.

ViscosityInCGS

none

Use the ‘ConstantViscosity’ key instead. It supports specifying units.

yes, no

False

bool

False

Interpret the value of constant viscosity to be in cgs.

discmass

DiskMass

+

0.01

In case of SetSigma0=yes, use this mass as diskmass.

massoverflow

RocheLobeOverflow

yes, no

False

Enable a constant massflow coming though the outer boundary.

mofaveragingtime

ROFAveragingTime

10

?

mofgamma

ROFGamma

0.5

?

mofplanet

ROFPlanet

1

?

moframpingtime

ROFRampingTime

30

Gradual increase for the mass overflow.

moftemperature

ROFTemperature

1000.0 K

?

mofvalue

ROFValue

1e-08

?

variableTransfer

ROFVariableTransfer

False

?

zbufferMaxAngle

none

0.17453292519943295

zbufferSize

none

100

Deprecated Nbody Parameters

Parameter

Newname

Hint

Choices

Default

Type

Unit Support

Description