Skip to content

Commit ed20d19

Browse files
authored
Merge pull request #3038 from boutproject/deprecation-hidden-default-option
Deprecate options that are only used as default for other options
2 parents 0c733e4 + 2bc063f commit ed20d19

147 files changed

Lines changed: 1265 additions & 1027 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

examples/6field-simple/data/BOUT.inp

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# settings file for BOUT++
2-
# High-Beta reduced MHD case
3-
4-
##################################################
5-
# Global settings used by the core code
6-
7-
nout = 100 # number of time-steps
8-
timestep = 1.0 # time between outputs
91
wall_limit = 0.45 # wall time limit (in hours)
102

113
twistshift = true # use twist-shift condition?
@@ -17,7 +9,9 @@ zperiod = 15 # Fraction of a torus to simulate
179
MXG = 2
1810
MYG = 2
1911

20-
grid = "cbm18_dens8.grid_nx68ny64.nc"
12+
[mesh]
13+
14+
file = "cbm18_dens8.grid_nx68ny64.nc"
2115

2216
[mesh:paralleltransform]
2317
type = shifted # Use shifted metric method
@@ -70,6 +64,14 @@ rtol = 1e-05 # relative tolerance
7064
use_precon = false # Use preconditioner: User-supplied or BBD
7165

7266
mxstep = 10000 # Number of internal steps between outputs
67+
output_step = 1.0 # time between outputs
68+
# settings file for BOUT++
69+
# High-Beta reduced MHD case
70+
71+
##################################################
72+
# Global settings used by the core code
73+
74+
nout = 100 # number of time-steps
7375

7476
##################################################
7577
# settings for high-beta reduced MHD

examples/IMEX/advection-diffusion/data/BOUT.inp

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
# Settings for ImEx example case
2-
3-
##################################################
4-
# settings used by the core code
5-
6-
nout = 50 # number of time-steps
7-
timestep = 0.01 # time between outputs
81

92
periodicX = true # Make domain periodic in X
103

@@ -52,6 +45,13 @@ type = splitrk
5245
timestep = 0.0001 # Internal timestep
5346
nstages = 9 # Stages in RKL steps for diffusive component
5447
adapt_period = 5 # Internal steps between accuracy checks
48+
output_step = 0.01 # time between outputs
49+
# Settings for ImEx example case
50+
51+
##################################################
52+
# settings used by the core code
53+
54+
nout = 50 # number of time-steps
5555

5656
##################################################
5757
# settings for split operator model

examples/IMEX/advection-reaction/data/BOUT.inp

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,14 @@
1-
# Settings for split operator test case
2-
3-
##################################################
4-
# settings used by the core code
5-
6-
nout = 100 # number of time-steps
7-
timestep = 0.01 # time between outputs
81

92
MZ = 64 # number of points in z direction (2^n)
103

11-
grid = "simple_xz.nc"
12-
134
NXPE = 1
145

156
periodicX = true # Make domain periodic in X
167

8+
[mesh]
9+
10+
file = "simple_xz.nc"
11+
1712
##################################################
1813
# derivative methods
1914

@@ -45,6 +40,13 @@ flux = U1
4540

4641
type = splitrk
4742
timestep = 0.0001
43+
output_step = 0.01 # time between outputs
44+
# Settings for split operator test case
45+
46+
##################################################
47+
# settings used by the core code
48+
49+
nout = 100 # number of time-steps
4850

4951
##################################################
5052
# settings for split operator model

examples/IMEX/diffusion-nl/data/BOUT.inp

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11

2-
nout = 10
3-
timestep = 1
4-
52
alpha = 2.5 # Diffusion exponent: D = f ^ alpha
63

74
MXG = 0
@@ -22,3 +19,8 @@ ixseps2 = ny
2219

2320
scale = 1
2421
function = 1 + 0.5*sin(y)
22+
23+
[solver]
24+
output_step = 1
25+
26+
nout = 10

examples/IMEX/drift-wave-constraint/data/BOUT.inp

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
# Drift wave test
2-
# All variables in normalised units
3-
4-
timestep = 100
5-
nout = 100
61

72
[mesh]
83

@@ -22,6 +17,11 @@ Ne0 = 1 + 0.1*(0.5 - x)
2217

2318
[solver]
2419
type = imexbdf2
20+
# Drift wave test
21+
# All variables in normalised units
22+
23+
output_step = 100
24+
nout = 100
2525

2626
[drift]
2727
nu = 0.1

examples/IMEX/drift-wave/data/BOUT.inp

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
# Drift wave test
2-
# All variables in normalised units
3-
4-
timestep = 100
5-
nout = 100
61

72
[mesh]
83

@@ -31,3 +26,10 @@ function = sin(y-z)
3126
[Ne]
3227
scale = 0
3328
function = 0
29+
30+
[solver]
31+
# Drift wave test
32+
# All variables in normalised units
33+
34+
output_step = 100
35+
nout = 100

examples/blob2d-laplacexz/data/BOUT.inp

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
# settings file for BOUT++
2-
#
3-
# Blob simulation in a 2D slab
4-
#
5-
6-
# settings used by the core code
7-
8-
nout = 50 # number of time-steps
9-
timestep = 100.0 # time between outputs
101

112
MXG = 2
123
MYG = 0 # No y derivatives, so no guard cells needed in y
@@ -49,6 +40,15 @@ upwind = W3
4940
atol = 1e-10 # absolute tolerance
5041
rtol = 1e-05 # relative tolerance
5142
mxstep = 10000 # Maximum internal steps per output
43+
output_step = 100.0 # time between outputs
44+
# settings file for BOUT++
45+
#
46+
# Blob simulation in a 2D slab
47+
#
48+
49+
# settings used by the core code
50+
51+
nout = 50 # number of time-steps
5252

5353
###################################################
5454
# Electrostatic potential solver

examples/blob2d-outerloop/data/BOUT.inp

Lines changed: 29 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,3 @@
1-
# settings file for BOUT++
2-
#
3-
# Blob simulation in a 2D slab
4-
#
5-
# This case has blob size
6-
#
7-
# delta = 0.3*256 ~ 10 * delta_*
8-
9-
10-
# settings used by the core code
11-
12-
nout = 3 # number of time-steps
13-
timestep = 50 # time between outputs [1/wci]
141

152

163
MXG = 2 # Number of X guard cells
@@ -20,7 +7,7 @@ MYG = 0 # No y derivatives, so no guard cells needed in y
207

218
nx = 260 # Note: 4 guard cells
229
ny = 1
23-
nz = 256
10+
nz = 256
2411

2512
dx = 0.3 # Grid spacing [rho_s]
2613
dz = 0.3
@@ -30,7 +17,7 @@ dz = 0.3
3017

3118
[mesh:ddx]
3219

33-
first = C2
20+
first = C2
3421
second = C2
3522
upwind = W3
3623

@@ -51,9 +38,22 @@ upwind = W3
5138

5239
[solver]
5340

54-
atol = 1.0e-10 # absolute tolerance
55-
rtol = 1.0e-5 # relative tolerance
41+
atol = 1e-10 # absolute tolerance
42+
rtol = 1e-05 # relative tolerance
5643
mxstep = 10000 # Maximum internal steps per output
44+
output_step = 50 # time between outputs [1/wci]
45+
# settings file for BOUT++
46+
#
47+
# Blob simulation in a 2D slab
48+
#
49+
# This case has blob size
50+
#
51+
# delta = 0.3*256 ~ 10 * delta_*
52+
53+
54+
# settings used by the core code
55+
56+
nout = 3 # number of time-steps
5757

5858
###################################################
5959
# Electrostatic potential solver
@@ -66,19 +66,17 @@ pctype = user # Preconditioning type
6666
fourth_order = true # 4th order or 2nd order
6767

6868
flags = 0 # inversion flags for phi
69-
# 0 = Zero value
70-
# 10 = Zero gradient AC inner & outer
71-
# 15 = Zero gradient AC and DC
72-
# 768 = Zero laplace inner & outer
69+
# 0 = Zero value
70+
# 10 = Zero gradient AC inner & outer
71+
# 15 = Zero gradient AC and DC
72+
# 768 = Zero laplace inner & outer
7373

7474
[phiSolver:precon] # Preconditioner (if pctype=user)
75-
filter = 0. # Must not filter solution
76-
flags = 49152 # set_rhs i.e. identity matrix in boundaries
75+
filter = 0.0 # Must not filter solution
76+
flags = 49152 # set_rhs i.e. identity matrix in boundaries
7777

7878
###################################################
7979
# Electrostatic potential solver (Boussinesq)
80-
81-
[phiBoussinesq]
8280
# By default type is tri (serial) or spt (parallel)
8381
#flags = 0
8482

@@ -89,16 +87,16 @@ flags = 49152 # set_rhs i.e. identity matrix in boundaries
8987

9088
Te0 = 5 # Electron Temperature (eV)
9189

92-
n0 = 2e18 # Background plasma density (m^-3)
90+
n0 = 2e+18 # Background plasma density (m^-3)
9391

94-
compressible = false # Compressibility?
92+
compressible = false # Compressibility?
9593

9694
boussinesq = true # Boussinesq approximation (no perturbed n in vorticity)
9795

98-
D_vort = 1e-6 # Viscosity
99-
D_n = 1e-6 # Diffusion
100-
101-
R_c = 1.5 # Radius of curvature (m)
96+
D_vort = 1e-06 # Viscosity
97+
D_n = 1e-06 # Diffusion
98+
99+
R_c = 1.5 # Radius of curvature (m)
102100

103101
# settings for individual variables
104102
# The section "All" defines default settings for all variables
@@ -117,5 +115,3 @@ height = 0.5
117115
width = 0.05
118116

119117
function = 1 + height * exp(-((x-0.25)/width)^2 - ((z/(2*pi) - 0.5)/width)^2)
120-
121-

examples/blob2d/delta_0.25/BOUT.inp

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,3 @@
1-
# settings file for BOUT++
2-
#
3-
# Blob simulation in a 2D slab
4-
#
5-
# This case has blob size
6-
#
7-
# delta = 0.3*256 ~ 10 * delta_*
8-
9-
10-
# settings used by the core code
11-
12-
nout = 100 # number of time-steps
13-
timestep = 20 # time between outputs [1/wci]
141

152

163
MXG = 2 # Number of X guard cells
@@ -54,6 +41,19 @@ upwind = W3
5441
atol = 1e-10 # absolute tolerance
5542
rtol = 1e-05 # relative tolerance
5643
mxstep = 10000 # Maximum internal steps per output
44+
output_step = 20 # time between outputs [1/wci]
45+
# settings file for BOUT++
46+
#
47+
# Blob simulation in a 2D slab
48+
#
49+
# This case has blob size
50+
#
51+
# delta = 0.3*256 ~ 10 * delta_*
52+
53+
54+
# settings used by the core code
55+
56+
nout = 100 # number of time-steps
5757

5858
###################################################
5959
# Electrostatic potential solver
@@ -76,8 +76,6 @@ flags = 49152 # set_rhs i.e. identity matrix in boundaries
7676

7777
###################################################
7878
# Electrostatic potential solver (Boussinesq)
79-
80-
[phiBoussinesq]
8179
# By default type is tri (serial) or spt (parallel)
8280

8381
##################################################

examples/blob2d/delta_1/BOUT.inp

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,3 @@
1-
# settings file for BOUT++
2-
#
3-
# Blob simulation in a 2D slab
4-
#
5-
# This case has blob size
6-
#
7-
# delta = 0.3*256 ~ 10 * delta_*
8-
9-
10-
# settings used by the core code
11-
12-
nout = 50 # number of time-steps
13-
timestep = 50 # time between outputs [1/wci]
141

152

163
MXG = 2 # Number of X guard cells
@@ -54,6 +41,19 @@ upwind = W3
5441
atol = 1e-10 # absolute tolerance
5542
rtol = 1e-05 # relative tolerance
5643
mxstep = 10000 # Maximum internal steps per output
44+
output_step = 50 # time between outputs [1/wci]
45+
# settings file for BOUT++
46+
#
47+
# Blob simulation in a 2D slab
48+
#
49+
# This case has blob size
50+
#
51+
# delta = 0.3*256 ~ 10 * delta_*
52+
53+
54+
# settings used by the core code
55+
56+
nout = 50 # number of time-steps
5757

5858
###################################################
5959
# Electrostatic potential solver
@@ -76,8 +76,6 @@ flags = 49152 # set_rhs i.e. identity matrix in boundaries
7676

7777
###################################################
7878
# Electrostatic potential solver (Boussinesq)
79-
80-
[phiBoussinesq]
8179
# By default type is tri (serial) or spt (parallel)
8280

8381
##################################################

0 commit comments

Comments
 (0)