ThermalScatteringLaw#

class montepy.ThermalScatteringLaw(input: Input | str = '', material: Material = None, *, jit_parse: bool = True)#

Bases: DataInputAbstract

Class to hold MT Inputs

This is designed to be called two ways. The first is with a read input file using input_card, comment The second is after a read with a material and a comment (using named inputs)

See also

Changed in version 1.5.0: Added jit_parse parameter

Parameters:

input (Input | str) – the Input object representing this data input
material (Material) – the parent Material object that owns this
jit_parse (bool) – Parse the object just-in-time, when the information is actually needed, if True.

Methods:

`_class_prefix`()	The text part of the input identifier.
`_delete_trailing_comment`()	Deletes trailing comments from an object when it has been moved to another object.
`_generate_default_node`(value_type, default)	Generates a "default" or blank ValueNode.
`_generate_default_tree`()	Generate default syntax trees that can be exported once the object is not in an illegal state.
`_grab_beginning_comment`(padding[, last_obj])
`_has_classifier`()	Whether or not this class supports particle classifiers.
`_has_number`()	Whether or not this class supports numbering.
`_init_blank`()	Initialize the object to a base state, before any parsing.
`_parse_tree`()	Takes the information from syntax tree and link it to the internal attributes.
`_update_values`()	Method to update values in syntax tree with new values.
`add_scattering_law`(law)	Adds the requested scattering law to this material
`clone`()	Create a new independent instance of this object.
`format_for_mcnp_input`(mcnp_version)	Creates a list of strings representing this MCNP_Object that can be written to file.
`full_parse`()	Fully parses this object, and disable just-in-time parsing for it.
`link_to_problem`([problem, deepcopy])	Links the input to the parent problem for this input.
`mcnp_str`([mcnp_version])	Returns a string of this input as it would appear in an MCNP input file.
`search`(search)	Searches this input for the given string, or compiled regular expression.
`validate`()	Validates that the object is in a usable state.
`wrap_string_for_mcnp`(string, mcnp_version, ...)	Wraps the list of the words to be a well formed MCNP input.

Attributes:

`_problem`
`classifier`	The syntax tree object holding the data classifier.
`comments`	The comments associated with this input if any.
`data`	The syntax tree actually holding the data.
`full_parsed`	Whether this has been fully parsed, or is just JIT parsed.
`leading_comments`	Any comments that come before the beginning of the input proper.
`old_number`	The material number from the file
`parameters`	A dictionary of the additional parameters for the object.
`parent_material`	The Material object this is tied to.
`particle_classifiers`	The particle class part of the input identifier as a parsed list.
`prefix`	The text part of the input identifier parsed from the input.
`prefix_modifier`	The modifier to a name prefix that was parsed from the input.
`thermal_scattering_laws`	The thermal scattering laws to use for this material as strings.
`trailing_comment`	The trailing comments and padding of an input.

static _class_prefix()#

The text part of the input identifier.

For example: for a material the prefix is m

this must be lower case

Returns:: the string of the prefix that identifies a input of this class.
Return type:: str

static _generate_default_node(value_type: Type, default: str, padding: str = ' ', never_pad: bool = False)#

Generates a “default” or blank ValueNode.

None is generally a safe default value to provide.

Changed in version 1.0.0: Added never_pad argument.

Parameters:

value_type (Type) – the data type for the ValueNode.
default (str) – the default value to provide (type needs to agree with value_type)
padding (str) – the string to provide to the PaddingNode. If None no PaddingNode will be added.
never_pad (bool) – Whether to never add trailing padding. True means extra padding is suppressed.

Returns:

a new ValueNode with the requested information.

Return type:

ValueNode

static _has_classifier()#

Whether or not this class supports particle classifiers.

For example: kcode doesn’t allow particle types but tallies do allow it e.g., f7:n

0 : not allowed
1 : is optional
2 : is mandatory

Returns:: True if this class particle classifiers
Return type:: int

static _has_number()#

Whether or not this class supports numbering.

For example: kcode doesn’t allow numbers but tallies do allow it e.g., f7

Returns:: True if this class allows numbers
Return type:: bool

static wrap_string_for_mcnp(string: str, mcnp_version: montepy.types.VersionType, is_first_line: bool, suppress_blank_end: bool = True) → list[str]#

Wraps the list of the words to be a well formed MCNP input.

multi-line inputs will be handled by using the indentation format, and not the “&” method.

Parameters:

string (str) – A long string with new lines in it, that needs to be chunked appropriately for MCNP inputs
mcnp_version (tuple[Integral, Integral, Integral]) – the tuple for the MCNP that must be formatted for.
is_first_line (bool) – If true this will be the beginning of an MCNP input. The first line will not be indented.
suppress_blank_end (bool) – Whether or not to suppress any blank lines that would be added to the end. Good for anywhere but cell modifiers in the cell block.

Returns:

A list of strings that can be written to an input file, one item to a line.

Return type:

list[str]

_delete_trailing_comment()#: Deletes trailing comments from an object when it has been moved to another object.

_generate_default_tree()#

Generate default syntax trees that can be exported once the object is not in an illegal state.

For leaves generally use self._generate_default_nod(<type, None). Save the tree to self._tree

Parameters:: **kwargs (dict) – Allows passing additional arguments through __init__ as **kwargs

_grab_beginning_comment(padding: list[PaddingNode], last_obj=None)#

Parameters:: padding (list[PaddingNode])

_init_blank()#

Initialize the object to a base state, before any parsing.

This should not setup the syntax tree though.

_parse_tree()#

Takes the information from syntax tree and link it to the internal attributes.

Use self._tree for this.

_update_values()#

Method to update values in syntax tree with new values.

Generally when make_prop_val_node() this is not necessary to do, but when make_prop_pointer() is used it is necessary. The most common need is to update a value based on the number for an object pointed at, e.g., the material number in a cell definition.

add_scattering_law(law)#

Adds the requested scattering law to this material

Parameters:: law (str) – the thermal scattering law to add.

clone() → MCNP_Object#

Create a new independent instance of this object.

Returns:: a new instance identical to this object.
Return type:: MCNP_Object

format_for_mcnp_input(mcnp_version: montepy.types.VersionType) → list[str]#

Creates a list of strings representing this MCNP_Object that can be written to file.

Parameters:: mcnp_version (tuple[Integral, Integral, Integral]) – The tuple for the MCNP version that must be exported to.
Returns:: a list of strings for the lines that this input will occupy.
Return type:: list[str]

full_parse()#

Fully parses this object, and disable just-in-time parsing for it.

Returns:: The object will be mutated and fully parsed.
Return type:: None

link_to_problem(problem: MCNP_Problem = None, *, deepcopy: bool = False)#

Links the input to the parent problem for this input.

This is done so that inputs can find links to other objects.

Parameters:

problem (MCNP_Problem) – The problem to link this input to.
deepcopy (bool) – If this is occuring during a problem level deepcopy

mcnp_str(mcnp_version: montepy.types.VersionType = None) → str#

Returns a string of this input as it would appear in an MCNP input file.

..versionadded:: 1.0.0

Parameters:: mcnp_version (tuple[Integral, Integral, Integral]) – The tuple for the MCNP version that must be exported to.
Returns:: The string that would have been printed in a file
Return type:: str

search(search: str | Pattern) → bool#

Searches this input for the given string, or compiled regular expression.

Parameters:: search (str | Pattern) – The pattern to search for.
Returns:: Whether this
Return type:: bool

validate()#: Validates that the object is in a usable state.

property _problem: MCNP_Problem#

property classifier#

The syntax tree object holding the data classifier.

For example this would container information like M4, or F104:n.

Returns:: the classifier for this data_input.
Return type:: montepy.input_parser.syntax_node.ClassifierNode

property comments: list[PaddingNode]#

The comments associated with this input if any.

This includes all C comments before this card that aren’t part of another card, and any comments that are inside this card.

Returns:: a list of the comments associated with this comment.
Return type:: list

property data: ListNode#

The syntax tree actually holding the data.

Returns:: The syntax tree with the information.
Return type:: montepy.input_parser.syntax_node.ListNode

property full_parsed#

Whether this has been fully parsed, or is just JIT parsed.

Returns:: True iff this is fully parsed, False means this is still just-in-time parsed.
Return type:: bool

property leading_comments: list[PaddingNode]#

Any comments that come before the beginning of the input proper.

Returns:: the leading comments.
Return type:: list

property old_number#

The material number from the file

Return type:: int

property parameters: dict[str, str]#

A dictionary of the additional parameters for the object.

e.g.: 1 0 -1 u=1 imp:n=0.5 has the parameters {"U": "1", "IMP:N": "0.5"}

Returns:: a dictionary of the key-value pairs of the parameters.
Return type:: dict[str, str]
Return type:: dict

property parent_material#

The Material object this is tied to.

Return type:: Material

property particle_classifiers: list[Particle]#

The particle class part of the input identifier as a parsed list.

This is parsed from the input that was read.

For example: the classifier for F7:n is :n, and imp:n,p is :n,p This will be parsed as a list: [<Particle.NEUTRON: 'N'>, <Particle.PHOTON: 'P'>].

Returns:: the particles listed in the input if any. Otherwise None
Return type:: list[montepy.Particle]

property prefix: str#

The text part of the input identifier parsed from the input.

For example: for a material like: m20 the prefix is m. this will always be lower case. Can also be called the mnemonic.

Returns:: The prefix read from the input
Return type:: str

property prefix_modifier: str#

The modifier to a name prefix that was parsed from the input.

For example: for a transform: *tr5 the modifier is *

Returns:: the prefix modifier that was parsed if any. None if otherwise.
Return type:: str

property thermal_scattering_laws: list[str]#

The thermal scattering laws to use for this material as strings.

Return type:: list[str]

property trailing_comment: list[PaddingNode]#

The trailing comments and padding of an input.

Generally this will be blank as these will be moved to be a leading comment for the next input.

Returns:: the trailing c style comments and intermixed padding (e.g., new lines)
Return type:: list