Skip to content

PENTRC: document atol_x/rtol_x controls and fix precision suffix (cleanup for #280) #290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
logan-nc merged 1 commit into from
Aug 5, 2026
Merged

PENTRC: document atol_x/rtol_x controls and fix precision suffix (cleanup for #280) #290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/examples/DIIID_ideal_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-6 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-6 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-4 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/DIIID_kinetic_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-3 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/DIIID_resistive_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-6 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-6 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-4 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/a10_ideal_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/a10_kinetic_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/a5_tearing_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/regression_solovev_ideal_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/regression_solovev_kinetic_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/regression_solovev_resistive_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/run_ideal_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-6 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-6 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/run_kinetic_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-4 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/solovev_ideal_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-6 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-6 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/solovev_kinetic_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/solovev_resistive_example/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-6 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-6 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_psi = 1e-9 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-5 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
6 changes: 4 additions & 2 deletions input/pentrc.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@

force_xialpha = .false. ! Calculates tangential displacement from radial displacement and toroidal force balance (overwrites peq_file values)

atol_xlmda = 1e-9 ! Absolute tolerance in energy and pitch integration
rtol_xlmda = 1e-5 ! Relative tolerance in energy and pitch integration
atol_xlmda = 1e-9 ! Absolute tolerance in pitch integration (energy tolerance derived from this unless atol_x is set)
rtol_xlmda = 1e-5 ! Relative tolerance in pitch integration (energy tolerance derived from this unless rtol_x is set)
atol_x = -1 ! Absolute tolerance in energy integration. Negative (default) derives 1e-2*atol_xlmda so the nested quadrature converges
rtol_x = -1 ! Relative tolerance in energy integration. Negative (default) derives 1e-2*rtol_xlmda so the nested quadrature converges
atol_psi = 1e-4 ! Absolute tolerance in psi_n integration
rtol_psi = 1e-4 ! Relative tolerance in psi_n integration
ntheta = 128 ! Poloidal angle grid for bounce integration
Expand Down
2 changes: 1 addition & 1 deletion pentrc/pentrc_interface.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ module pentrc_interface

!> How much tighter the energy integration is than the pitch integration
!> when atol_x/rtol_x are left at their derive-me default.
real(r8), parameter :: nested_tolerance_margin = 1e-2
real(r8), parameter :: nested_tolerance_margin = 1e-2_r8

real(r8) :: &
atol_xlmda=1e-6, &
Expand Down
Loading