Skip to content
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

Update comments on Source runtime params. #696

Merged
merged 1 commit into from
Jan 29, 2025
Merged

Update comments on Source runtime params. #696

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
3 changes: 2 additions & 1 deletion docs/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -911,7 +911,8 @@ The configurable runtime parameters of each source are as follows:

* ``'PRESCRIBED'``
Source values are arbitrarily prescribed by the user. The value is set by ``prescribed_values``, and can contain the same
data structures as :ref:`Time-varying arrays`.
data structures as :ref:`Time-varying arrays`. Currently, this is only supported for sources that have a 1D output
along the cell grid or face grid.

For example, to set 'fusion_power' to zero, e.g. for testing or sensitivity purposes, set:

Expand Down
6 changes: 3 additions & 3 deletions torax/sources/runtime_params.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,16 @@
class Mode(enum.Enum):
"""Defines how to compute the source terms for this source/sink."""

# Source is set to zero always. This is an explicit source by definition.
# Source is set to zero always.
ZERO = 0

# Source values come from a model in code. These terms can be implicit or
# explicit depending on the model implementation.
MODEL_BASED = 1

# Source values come from a pre-determined set of values, that may evolve in
# time. Values can be drawn from a file or an array. These sources are always
# explicit.
# time. Currently, this is only supported for sources that have a 1D output
# along the cell grid or face grid.
PRESCRIBED = 2


Expand Down