Skip to content

Commit

Permalink
Merge pull request #145 from svalinn/split_chamber-documentation-hotfix
Browse files Browse the repository at this point in the history
Update documentation to clarify behavior of `split_chamber`
  • Loading branch information
Edgar-21 authored Sep 3, 2024
2 parents 02e7087 + de47b3d commit 6624cbc
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
6 changes: 5 additions & 1 deletion parastell/invessel_build.py
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
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

0 comments on commit 6624cbc

Please sign in to comment.