montepy.data_inputs.material module

class montepy.data_inputs.material.Material(input=None)

Bases: DataInputAbstract, Numbered_MCNP_Object

A class to represent an MCNP material.

Parameters:: input (Input) – the input card that contains the data

add_thermal_scattering(law)

Adds thermal scattering law to the material

Parameters:: law (str) – the law that is mcnp formatted

property allowed_keywords

The allowed keywords for this class of MCNP_Card.

The allowed keywords that would appear in the parameters block. For instance for cells the keywords IMP and VOL are allowed. The allowed keywords need to be in upper case.

Deprecated since version 0.2.0: This is no longer needed. Instead this is specified in montepy.input_parser.tokens.MCNP_Lexer._KEYWORDS().

Returns:: A set of the allowed keywords. If there are none this should return the empty set.
Return type:: set

property cells

A generator of the cells that use this material.

Returns:: an iterator of the Cell objects which use this.
Return type:: generator

property class_prefix

The text part of the card identifier.

For example: for a material the prefix is m

this must be lower case

Deprecated since version 0.2.0: This has been moved to _class_prefix()

Returns:: the string of the prefix that identifies a card of this class.
Return type:: str
Raises:: DeprecationWarning – always raised.

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

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

static compress_jump_values(values)

Takes a list of strings and jump values and combines repeated jump values.

e.g., 1 1 J J 3 J becomes 1 1 2J 3 J

Deprecated since version 0.2.0: This should be automatically handled by the syntax tree instead.

Parameters:: values (list) – a list of string and Jump values to try to compress
Returns:: a list of MCNP word strings that have jump compression
Return type:: list
Raises:: DeprecationWarning – raised always.

static compress_repeat_values(values, threshold=1e-06)

Takes a list of floats, and tries to compress it using repeats.

E.g., 1 1 1 1 would compress to 1 3R

Deprecated since version 0.2.0: This should be automatically handled by the syntax tree instead.

Parameters:

values (list) – a list of float values to try to compress
threshold (float) – the minimum threshold to consider two values different

Returns:

a list of MCNP word strings that have repeat compression

Return type:

list

Raises:

DeprecationWarning – always raised.

property data

The syntax tree actually holding the data.

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

format_for_mcnp_input(mcnp_version)

Creates a string representation of this MCNP_Object that can be written to file.

Parameters:: mcnp_version (tuple) – 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

property 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

Deprecated since version 0.2.0: This has been moved to _has_classifier()

Returns:: True if this class particle classifiers
Return type:: int
Raises:: DeprecationWarning – always raised.

property has_number

Whether or not this class supports numbering.

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

Deprecated since version 0.2.0: This has been moved to _has_number()

Returns:: True if this class allows numbers
Return type:: bool
Raises:: DeprecationWarning – always raised.

property is_atom_fraction

If true this constituent is in atom fraction, not weight fraction.

Return type:: bool

property leading_comments

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

Added in version 0.2.0.

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

link_to_problem(problem)

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.

property material_components

The internal dictionary containing all the components of this material.

Deprecated since version 0.4.1: MaterialComponent has been deprecated as part of a redesign for the material interface due to a critical bug in how MontePy handles duplicate nuclides. See Migration plan for MontePy 1.0.0.

The keys are Isotope instances, and the values are MaterialComponent instances.

rtype:: dict

property number

The number to use to identify the material by

Return type:: int

property old_number

The material number that was used in the read file

Return type:: int

property parameters

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.
Rytpe:: dict

property particle_classifiers

The particle class part of the card 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 card identifier parsed from the input.

For example: for a material like: m20 the prefix is ‘m’ this will always be lower case.

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

The thermal scattering law for this material

Return type:: ThermalScatteringLaw

property trailing_comment

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

update_pointers(data_inputs)

Updates pointer to the thermal scattering data

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

validate()

Validates that the object is in a usable state.

Raises:: IllegalState if any condition exists that make the object incomplete.

property words

The words from the input file for this card.

Warning

Deprecated since version 0.2.0: This has been replaced by the syntax tree data structure.

Raises:: DeprecationWarning – Access the syntax tree instead.

static wrap_string_for_mcnp(string, mcnp_version, is_first_line)

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.

Returns:

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

Return type:

list

static wrap_words_for_mcnp(words, mcnp_version, is_first_line)

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

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

Deprecated since version 0.2.0: The concept of words is deprecated, and should be handled by syntax trees now.

Parameters:

words (list) – A list of the “words” or data-grams that needed to added to this card. Each word will be separated by at least one space.
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 card. The first line will not be indented.

Returns:

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

Return type:

list

Raises:

DeprecationWarning – raised always.