montepy.data_inputs.thermal_scattering module#

Classes:

ThermalScatteringLaw([input, material])

Class to hold MT Inputs
class montepy.data_inputs.thermal_scattering.ThermalScatteringLaw(input: Input | str = '', material: Material = None)#

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

Parameters:

  • input (Union[Input, str]) – the Input object representing this data input

  • material (Material) – the parent Material object that owns this

Methods:

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.

link_to_problem(problem)

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.

update_pointers(data_inputs)

Updates pointer to the thermal scattering data

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:

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.

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 wrap_string_for_mcnp(string, mcnp_version, is_first_line, suppress_blank_end=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) – 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

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:

type(self)

format_for_mcnp_input(mcnp_version: tuple[int]) → list[str]#

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

Parameters:

mcnp_version (tuple[int]) – 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

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.

mcnp_str(mcnp_version: tuple[int] = None)#

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

..versionadded:: 1.0.0

Parameters:

mcnp_version (tuple[int]) – 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

update_pointers(data_inputs)#

Updates pointer to the thermal scattering data

Parameters:

data_inputs (list) – a list of the data inputs in the problem

Returns:

True iff this input should be removed from problem.data_inputs

Return type:

bool

validate()#

Validates that the object is in a usable state.

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:

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#

The syntax tree actually holding the data.

Returns:

The syntax tree with the information.

Return type:

ListNode

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:

unknown

Rytpe:

dict

property parent_material#

The Material object this is tied to.

Return type:

Material

property particle_classifiers#

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

property prefix#

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#

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#

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

Return type:

list

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