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 documentation to clarify behavior of split_chamber #145

Merged
merged 1 commit into from
Sep 3, 2024
Merged

Update documentation to clarify behavior of split_chamber #145

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
6 changes: 5 additions & 1 deletion parastell/invessel_build.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,11 @@ class RadialBuild(object):
}.
split_chamber (bool): if wall_s > 1.0, separate interior vacuum
chamber into plasma and scrape-off layer components (optional,
defaults to False).
defaults to False). If an item with a 'sol' key is present in the
radial_build dictionary, settting this to False will not combine
the resultant 'chamber' with 'sol'. To include a custom scrape-off
layer definition for 'chamber', add an item with a 'chamber' key
and desired 'thickness_matrix' value to the radial_build dictionary.
logger (object): logger object (optional, defaults to None). If no
logger is supplied, a default logger will be instantiated.

Expand Down
7 changes: 6 additions & 1 deletion parastell/parastell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,12 @@ def construct_invessel_build(
}.
split_chamber (bool): if wall_s > 1.0, separate interior vacuum
chamber into plasma and scrape-off layer components (optional,
defaults to False).
defaults to False). If an item with a 'sol' key is present in
the radial_build dictionary, settting this to False will not
combine the resultant 'chamber' with 'sol'. To include a custom
scrape-off layer definition for 'chamber', add an item with a
'chamber' key and desired 'thickness_matrix' value to the
radial_build dictionary.

Optional attributes:
plasma_mat_tag (str): alternate DAGMC material tag to use for
Expand Down