[ { "instruction": "What does the clean_indentation() function do in OpenMC's Python API?", "input": "OpenMC Python API clean_indentation() function", "output": "The clean_indentation() function set indentation of xml element and its sub-elements. copied and pasted from https://effbot.org/zone/element-lib.htm#prettyprint. it walks your tree and adds spaces and newlines so the tree is printed in a nice way. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the clean_indentation() function in OpenMC's Python API?", "input": "OpenMC Python API clean_indentation() function purpose", "output": "The clean_indentation() function set indentation of xml element and its sub-elements. copied and pasted from https://effbot.org/zone/element-lib.htm#prettyprint. it walks your tree and adds spaces and newlines so the tree is printed in a nice way. It's part of OpenMC's Python API." }, { "instruction": "How do you call the clean_indentation() function in OpenMC's Python API?", "input": "OpenMC Python API clean_indentation() function signature", "output": "To call the clean_indentation() function, use: def clean_indentation(element: Any, level: Any, spaces_per_level: Any, trailing_indent: Any). It takes 4 parameters." }, { "instruction": "What does the level parameter do in the clean_indentation() function?", "input": "OpenMC Python API clean_indentation() parameter level", "output": "The level parameter indentation level for the element passed in (default 0). It should be a int value." }, { "instruction": "What does the spaces_per_level parameter do in the clean_indentation() function?", "input": "OpenMC Python API clean_indentation() parameter spaces_per_level", "output": "The spaces_per_level parameter number of spaces per indentation level (default 2). It should be a int value." }, { "instruction": "What does the trailing_indent parameter do in the clean_indentation() function?", "input": "OpenMC Python API clean_indentation() parameter trailing_indent", "output": "The trailing_indent parameter whether or not to add indentation after closing the element. It should be a bool value." }, { "instruction": "What does the get_text() function do in OpenMC's Python API?", "input": "OpenMC Python API get_text() function", "output": "The get_text() function retrieve text of an attribute or subelement. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_text() function in OpenMC's Python API?", "input": "OpenMC Python API get_text() function purpose", "output": "The get_text() function retrieve text of an attribute or subelement. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_text() function in OpenMC's Python API?", "input": "OpenMC Python API get_text() function signature", "output": "To call the get_text() function, use: def get_text(elem: Any, name: Any, default: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the get_text() function?", "input": "OpenMC Python API get_text() parameter elem", "output": "The elem parameter element from which to search. It should be a lxml.etree._Element value." }, { "instruction": "What does the name parameter do in the get_text() function?", "input": "OpenMC Python API get_text() parameter name", "output": "The name parameter name of attribute/subelement. It should be a str value." }, { "instruction": "What does the default parameter do in the get_text() function?", "input": "OpenMC Python API get_text() parameter default", "output": "The default parameter a defult value to return if matching attribute/subelement exists. It should be a object value." }, { "instruction": "What does the reorder_attributes() function do in OpenMC's Python API?", "input": "OpenMC Python API reorder_attributes() function", "output": "The reorder_attributes() function sort attributes in xml to preserve pre-python 3.8 behavior. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the reorder_attributes() function in OpenMC's Python API?", "input": "OpenMC Python API reorder_attributes() function purpose", "output": "The reorder_attributes() function sort attributes in xml to preserve pre-python 3.8 behavior. It's part of OpenMC's Python API." }, { "instruction": "How do you call the reorder_attributes() function in OpenMC's Python API?", "input": "OpenMC Python API reorder_attributes() function signature", "output": "To call the reorder_attributes() function, use: def reorder_attributes(root: Any). It takes 1 parameters." }, { "instruction": "What does the root parameter do in the reorder_attributes() function?", "input": "OpenMC Python API reorder_attributes() parameter root", "output": "The root parameter root element. It should be a lxml.etree._Element value." }, { "instruction": "What does the get_elem_tuple() function do in OpenMC's Python API?", "input": "OpenMC Python API get_elem_tuple() function", "output": "The get_elem_tuple() function helper function to get a tuple of values from an elem. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_elem_tuple() function in OpenMC's Python API?", "input": "OpenMC Python API get_elem_tuple() function purpose", "output": "The get_elem_tuple() function helper function to get a tuple of values from an elem. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_elem_tuple() function in OpenMC's Python API?", "input": "OpenMC Python API get_elem_tuple() function signature", "output": "To call the get_elem_tuple() function, use: def get_elem_tuple(elem: Any, name: Any, dtype: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the get_elem_tuple() function?", "input": "OpenMC Python API get_elem_tuple() parameter elem", "output": "The elem parameter xml element that should contain a tuple. It should be a lxml.etree._Element value." }, { "instruction": "What does the name parameter do in the get_elem_tuple() function?", "input": "OpenMC Python API get_elem_tuple() parameter name", "output": "The name parameter name of the subelement to obtain tuple from. It should be a str value." }, { "instruction": "What does the dtype parameter do in the get_elem_tuple() function?", "input": "OpenMC Python API get_elem_tuple() parameter dtype", "output": "The dtype parameter the type of each element in the tuple. It should be a data-type value." }, { "instruction": "What is the CrossScore class in OpenMC's Python API?", "input": "OpenMC Python API CrossScore class", "output": "The CrossScore class represents a special-purpose tally score used to encapsulate all combinations of two tally's scores as an outer product for tally arithmetic. It provides 10 methods and 0 properties for working with crossscore data in OpenMC." }, { "instruction": "What does the CrossScore class do in OpenMC's Python API?", "input": "OpenMC Python API CrossScore class description", "output": "The CrossScore class a special-purpose tally score used to encapsulate all combinations of two tally's scores as an outer product for tally arithmetic. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the left_score parameter do when creating a CrossScore?", "input": "OpenMC Python API CrossScore constructor parameter left_score", "output": "When creating a CrossScore, the left_score parameter specifies the left score in the outer product. It should be a str or CrossScore value." }, { "instruction": "What does the right_score parameter do when creating a CrossScore?", "input": "OpenMC Python API CrossScore constructor parameter right_score", "output": "When creating a CrossScore, the right_score parameter specifies the right score in the outer product. It should be a str or CrossScore value." }, { "instruction": "What does the binary_op parameter do when creating a CrossScore?", "input": "OpenMC Python API CrossScore constructor parameter binary_op", "output": "When creating a CrossScore, the binary_op parameter specifies the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's scores with this crossnuclide. It should be a str value." }, { "instruction": "What is the left_score attribute of a CrossScore?", "input": "OpenMC Python API CrossScore attribute left_score", "output": "The left_score attribute of a CrossScore contains the left score in the outer product. It's a str or CrossScore value that you can access after creating a CrossScore instance." }, { "instruction": "What is the right_score attribute of a CrossScore?", "input": "OpenMC Python API CrossScore attribute right_score", "output": "The right_score attribute of a CrossScore contains the right score in the outer product. It's a str or CrossScore value that you can access after creating a CrossScore instance." }, { "instruction": "What is the binary_op attribute of a CrossScore?", "input": "OpenMC Python API CrossScore attribute binary_op", "output": "The binary_op attribute of a CrossScore contains the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's scores with this crossscore. It's a str value that you can access after creating a CrossScore instance." }, { "instruction": "How do you call the __init__() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, left_score: Any, right_score: Any, binary_op: Any). It takes 4 parameters." }, { "instruction": "How do you call the __hash__() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the left_score() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.left_score() method signature", "output": "To call the left_score() method, use: @property def left_score(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the left_score() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.left_score() method signature", "output": "To call the left_score() method, use: @left_score.setter def left_score(self: Any, left_score: Any). It takes 2 parameters." }, { "instruction": "How do you call the right_score() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.right_score() method signature", "output": "To call the right_score() method, use: @property def right_score(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the right_score() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.right_score() method signature", "output": "To call the right_score() method, use: @right_score.setter def right_score(self: Any, right_score: Any). It takes 2 parameters." }, { "instruction": "How do you call the binary_op() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.binary_op() method signature", "output": "To call the binary_op() method, use: @property def binary_op(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the binary_op() method in the CrossScore class?", "input": "OpenMC Python API CrossScore.binary_op() method signature", "output": "To call the binary_op() method, use: @binary_op.setter def binary_op(self: Any, binary_op: Any). It takes 2 parameters." }, { "instruction": "What is the CrossNuclide class in OpenMC's Python API?", "input": "OpenMC Python API CrossNuclide class", "output": "The CrossNuclide class represents a special-purpose nuclide used to encapsulate all combinations of two tally's nuclides as an outer product for tally arithmetic. It provides 11 methods and 0 properties for working with crossnuclide data in OpenMC." }, { "instruction": "What does the CrossNuclide class do in OpenMC's Python API?", "input": "OpenMC Python API CrossNuclide class description", "output": "The CrossNuclide class a special-purpose nuclide used to encapsulate all combinations of two tally's nuclides as an outer product for tally arithmetic. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the left_nuclide parameter do when creating a CrossNuclide?", "input": "OpenMC Python API CrossNuclide constructor parameter left_nuclide", "output": "When creating a CrossNuclide, the left_nuclide parameter specifies the left nuclide in the outer product. It should be a str or CrossNuclide value." }, { "instruction": "What does the right_nuclide parameter do when creating a CrossNuclide?", "input": "OpenMC Python API CrossNuclide constructor parameter right_nuclide", "output": "When creating a CrossNuclide, the right_nuclide parameter specifies the right nuclide in the outer product. It should be a str or CrossNuclide value." }, { "instruction": "What does the binary_op parameter do when creating a CrossNuclide?", "input": "OpenMC Python API CrossNuclide constructor parameter binary_op", "output": "When creating a CrossNuclide, the binary_op parameter specifies the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's nuclides with this crossnuclide. It should be a str value." }, { "instruction": "What is the left_nuclide attribute of a CrossNuclide?", "input": "OpenMC Python API CrossNuclide attribute left_nuclide", "output": "The left_nuclide attribute of a CrossNuclide contains the left nuclide in the outer product. It's a str or CrossNuclide value that you can access after creating a CrossNuclide instance." }, { "instruction": "What is the right_nuclide attribute of a CrossNuclide?", "input": "OpenMC Python API CrossNuclide attribute right_nuclide", "output": "The right_nuclide attribute of a CrossNuclide contains the right nuclide in the outer product. It's a str or CrossNuclide value that you can access after creating a CrossNuclide instance." }, { "instruction": "What is the binary_op attribute of a CrossNuclide?", "input": "OpenMC Python API CrossNuclide attribute binary_op", "output": "The binary_op attribute of a CrossNuclide contains the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's nuclides with this crossnuclide. It's a str value that you can access after creating a CrossNuclide instance." }, { "instruction": "How do you call the __init__() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, left_nuclide: Any, right_nuclide: Any, binary_op: Any). It takes 4 parameters." }, { "instruction": "How do you call the __hash__() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the left_nuclide() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.left_nuclide() method signature", "output": "To call the left_nuclide() method, use: @property def left_nuclide(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the left_nuclide() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.left_nuclide() method signature", "output": "To call the left_nuclide() method, use: @left_nuclide.setter def left_nuclide(self: Any, left_nuclide: Any). It takes 2 parameters." }, { "instruction": "How do you call the right_nuclide() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.right_nuclide() method signature", "output": "To call the right_nuclide() method, use: @property def right_nuclide(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the right_nuclide() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.right_nuclide() method signature", "output": "To call the right_nuclide() method, use: @right_nuclide.setter def right_nuclide(self: Any, right_nuclide: Any). It takes 2 parameters." }, { "instruction": "How do you call the binary_op() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.binary_op() method signature", "output": "To call the binary_op() method, use: @property def binary_op(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the binary_op() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.binary_op() method signature", "output": "To call the binary_op() method, use: @binary_op.setter def binary_op(self: Any, binary_op: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the CrossNuclide class?", "input": "OpenMC Python API CrossNuclide.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What is the CrossFilter class in OpenMC's Python API?", "input": "OpenMC Python API CrossFilter class", "output": "The CrossFilter class represents a special-purpose filter used to encapsulate all combinations of two tally's filter bins as an outer product for tally arithmetic. It provides 15 methods and 0 properties for working with crossfilter data in OpenMC." }, { "instruction": "What does the CrossFilter class do in OpenMC's Python API?", "input": "OpenMC Python API CrossFilter class description", "output": "The CrossFilter class a special-purpose filter used to encapsulate all combinations of two tally's filter bins as an outer product for tally arithmetic. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the left_filter parameter do when creating a CrossFilter?", "input": "OpenMC Python API CrossFilter constructor parameter left_filter", "output": "When creating a CrossFilter, the left_filter parameter specifies the left filter in the outer product. It should be a openmc.Filter or CrossFilter value." }, { "instruction": "What does the right_filter parameter do when creating a CrossFilter?", "input": "OpenMC Python API CrossFilter constructor parameter right_filter", "output": "When creating a CrossFilter, the right_filter parameter specifies the right filter in the outer product. It should be a openmc.Filter or CrossFilter value." }, { "instruction": "What does the binary_op parameter do when creating a CrossFilter?", "input": "OpenMC Python API CrossFilter constructor parameter binary_op", "output": "When creating a CrossFilter, the binary_op parameter specifies the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's filter bins with this crossfilter. It should be a str value." }, { "instruction": "What is the type attribute of a CrossFilter?", "input": "OpenMC Python API CrossFilter attribute type", "output": "The type attribute of a CrossFilter contains the type of the crossfilter (e.g., 'energy / energy'). It's a str value that you can access after creating a CrossFilter instance." }, { "instruction": "What is the left_filter attribute of a CrossFilter?", "input": "OpenMC Python API CrossFilter attribute left_filter", "output": "The left_filter attribute of a CrossFilter contains the left filter in the outer product. It's a openmc.Filter or CrossFilter value that you can access after creating a CrossFilter instance." }, { "instruction": "What is the right_filter attribute of a CrossFilter?", "input": "OpenMC Python API CrossFilter attribute right_filter", "output": "The right_filter attribute of a CrossFilter contains the right filter in the outer product. It's a openmc.Filter or CrossFilter value that you can access after creating a CrossFilter instance." }, { "instruction": "What is the binary_op attribute of a CrossFilter?", "input": "OpenMC Python API CrossFilter attribute binary_op", "output": "The binary_op attribute of a CrossFilter contains the tally arithmetic binary operator (e.g., '+', '-', etc.) used to combine two tally's filter bins with this crossfilter. It's a str value that you can access after creating a CrossFilter instance." }, { "instruction": "What is the bins attribute of a CrossFilter?", "input": "OpenMC Python API CrossFilter attribute bins", "output": "The bins attribute of a CrossFilter contains a dictionary of the bins from each filter keyed by the types of the left / right filters. It's a dict of Iterable value that you can access after creating a CrossFilter instance." }, { "instruction": "What is the num_bins attribute of a CrossFilter?", "input": "OpenMC Python API CrossFilter attribute num_bins", "output": "The num_bins attribute of a CrossFilter contains the number of filter bins (always 1 if aggregate_filter is defined). It's a Integral value that you can access after creating a CrossFilter instance." }, { "instruction": "How do you call the __init__() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, left_filter: Any, right_filter: Any, binary_op: Any). It takes 4 parameters." }, { "instruction": "How do you call the __hash__() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the left_filter() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.left_filter() method signature", "output": "To call the left_filter() method, use: @property def left_filter(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the left_filter() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.left_filter() method signature", "output": "To call the left_filter() method, use: @left_filter.setter def left_filter(self: Any, left_filter: Any). It takes 2 parameters." }, { "instruction": "How do you call the right_filter() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.right_filter() method signature", "output": "To call the right_filter() method, use: @property def right_filter(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the right_filter() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.right_filter() method signature", "output": "To call the right_filter() method, use: @right_filter.setter def right_filter(self: Any, right_filter: Any). It takes 2 parameters." }, { "instruction": "How do you call the binary_op() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.binary_op() method signature", "output": "To call the binary_op() method, use: @property def binary_op(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the binary_op() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.binary_op() method signature", "output": "To call the binary_op() method, use: @binary_op.setter def binary_op(self: Any, binary_op: Any). It takes 2 parameters." }, { "instruction": "How do you call the type() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bins() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_bins() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.num_bins() method signature", "output": "To call the num_bins() method, use: @property def num_bins(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_bin_index() method do in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.get_bin_index() method", "output": "The get_bin_index() method returns the index in the crossfilter for some bin. It's used for crossfilter operations." }, { "instruction": "How do you call the get_bin_index() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "What does the filter_bin parameter do in the get_bin_index() method?", "input": "OpenMC Python API CrossFilter.get_bin_index() parameter filter_bin", "output": "The filter_bin parameter a 2-tuple where each value corresponds to the bin of interest in the left and right filter, respectively. a bin is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. the bin is an integer for the cell instance id for 'distribcell' filters. the bin is a 2-tuple of floats for 'energy' and 'energyout' filters corresponding to the energy boundaries of the bin of interest. the bin is a (x,y,z) 3-tuple for 'mesh' filters corresponding to the mesh cell of interest.. It should be a 2-tuple value." }, { "instruction": "What does the get_bin_index() method return in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.get_bin_index() return value", "output": "The get_bin_index() method returns the index in the tally data array for this filter bin.. The return type is Integral." }, { "instruction": "What does the get_pandas_dataframe() method do in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the crossfilter's bins. this method constructs a pandas dataframe object for the crossfilter with columns annotated by filter bin information. this is a helper method for the tally.get_pandas_dataframe(...) method. this method recursively builds and concatenates pandas dataframes for the left and right filters and crossfilters. this capability has been tested for pandas >=0.13.1. however, it is recommended to use v0.16 or newer versions of pandas since this method uses pandas' multi-index functionality. It's used for crossfilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the CrossFilter class?", "input": "OpenMC Python API CrossFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, summary: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API CrossFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a Integral value." }, { "instruction": "What does the summary parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API CrossFilter.get_pandas_dataframe() parameter summary", "output": "The summary parameter an optional summary object to be used to construct columns for distribcell tally filters (default is none). the geometric information in the summary object is embedded into a multi-index column with a geometric \"path\" to each distribcell instance.. It should be a None or Summary value." }, { "instruction": "What is the AggregateScore class in OpenMC's Python API?", "input": "OpenMC Python API AggregateScore class", "output": "The AggregateScore class represents a special-purpose tally score used to encapsulate an aggregate of a subset or all of tally's scores for tally aggregation. It provides 9 methods and 0 properties for working with aggregatescore data in OpenMC." }, { "instruction": "What does the AggregateScore class do in OpenMC's Python API?", "input": "OpenMC Python API AggregateScore class description", "output": "The AggregateScore class a special-purpose tally score used to encapsulate an aggregate of a subset or all of tally's scores for tally aggregation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the scores parameter do when creating a AggregateScore?", "input": "OpenMC Python API AggregateScore constructor parameter scores", "output": "When creating a AggregateScore, the scores parameter specifies the scores included in the aggregation. It should be a Iterable of str or CrossScore value." }, { "instruction": "What does the aggregate_op parameter do when creating a AggregateScore?", "input": "OpenMC Python API AggregateScore constructor parameter aggregate_op", "output": "When creating a AggregateScore, the aggregate_op parameter specifies the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally's scores with this aggregatescore. It should be a str value." }, { "instruction": "What is the scores attribute of a AggregateScore?", "input": "OpenMC Python API AggregateScore attribute scores", "output": "The scores attribute of a AggregateScore contains the scores included in the aggregation. It's a Iterable of str or CrossScore value that you can access after creating a AggregateScore instance." }, { "instruction": "What is the aggregate_op attribute of a AggregateScore?", "input": "OpenMC Python API AggregateScore attribute aggregate_op", "output": "The aggregate_op attribute of a AggregateScore contains the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally's scores with this aggregatescore. It's a str value that you can access after creating a AggregateScore instance." }, { "instruction": "How do you call the __init__() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, scores: Any, aggregate_op: Any). It takes 3 parameters." }, { "instruction": "How do you call the __hash__() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.scores() method signature", "output": "To call the scores() method, use: @scores.setter def scores(self: Any, scores: Any). It takes 2 parameters." }, { "instruction": "How do you call the aggregate_op() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.aggregate_op() method signature", "output": "To call the aggregate_op() method, use: @property def aggregate_op(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the aggregate_op() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.aggregate_op() method signature", "output": "To call the aggregate_op() method, use: @aggregate_op.setter def aggregate_op(self: Any, aggregate_op: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the AggregateScore class?", "input": "OpenMC Python API AggregateScore.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What is the AggregateNuclide class in OpenMC's Python API?", "input": "OpenMC Python API AggregateNuclide class", "output": "The AggregateNuclide class represents a special-purpose tally nuclide used to encapsulate an aggregate of a subset or all of tally's nuclides for tally aggregation. It provides 9 methods and 0 properties for working with aggregatenuclide data in OpenMC." }, { "instruction": "What does the AggregateNuclide class do in OpenMC's Python API?", "input": "OpenMC Python API AggregateNuclide class description", "output": "The AggregateNuclide class a special-purpose tally nuclide used to encapsulate an aggregate of a subset or all of tally's nuclides for tally aggregation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the nuclides parameter do when creating a AggregateNuclide?", "input": "OpenMC Python API AggregateNuclide constructor parameter nuclides", "output": "When creating a AggregateNuclide, the nuclides parameter specifies the nuclides included in the aggregation. It should be a Iterable of str or CrossNuclide value." }, { "instruction": "What does the aggregate_op parameter do when creating a AggregateNuclide?", "input": "OpenMC Python API AggregateNuclide constructor parameter aggregate_op", "output": "When creating a AggregateNuclide, the aggregate_op parameter specifies the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally's nuclides with this aggregatenuclide. It should be a str value." }, { "instruction": "What is the nuclides attribute of a AggregateNuclide?", "input": "OpenMC Python API AggregateNuclide attribute nuclides", "output": "The nuclides attribute of a AggregateNuclide contains the nuclides included in the aggregation. It's a Iterable of str or CrossNuclide value that you can access after creating a AggregateNuclide instance." }, { "instruction": "What is the aggregate_op attribute of a AggregateNuclide?", "input": "OpenMC Python API AggregateNuclide attribute aggregate_op", "output": "The aggregate_op attribute of a AggregateNuclide contains the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally's nuclides with this aggregatenuclide. It's a str value that you can access after creating a AggregateNuclide instance." }, { "instruction": "How do you call the __init__() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, nuclides: Any, aggregate_op: Any). It takes 3 parameters." }, { "instruction": "How do you call the __hash__() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.nuclides() method signature", "output": "To call the nuclides() method, use: @nuclides.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "How do you call the aggregate_op() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.aggregate_op() method signature", "output": "To call the aggregate_op() method, use: @property def aggregate_op(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the aggregate_op() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.aggregate_op() method signature", "output": "To call the aggregate_op() method, use: @aggregate_op.setter def aggregate_op(self: Any, aggregate_op: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the AggregateNuclide class?", "input": "OpenMC Python API AggregateNuclide.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What is the AggregateFilter class in OpenMC's Python API?", "input": "OpenMC Python API AggregateFilter class", "output": "The AggregateFilter class represents a special-purpose tally filter used to encapsulate an aggregate of a subset or all of a tally filter's bins for tally aggregation. It provides 20 methods and 0 properties for working with aggregatefilter data in OpenMC." }, { "instruction": "What does the AggregateFilter class do in OpenMC's Python API?", "input": "OpenMC Python API AggregateFilter class description", "output": "The AggregateFilter class a special-purpose tally filter used to encapsulate an aggregate of a subset or all of a tally filter's bins for tally aggregation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the aggregate_filter parameter do when creating a AggregateFilter?", "input": "OpenMC Python API AggregateFilter constructor parameter aggregate_filter", "output": "When creating a AggregateFilter, the aggregate_filter parameter specifies the filter included in the aggregation. It should be a openmc.Filter or CrossFilter value." }, { "instruction": "What does the bins parameter do when creating a AggregateFilter?", "input": "OpenMC Python API AggregateFilter constructor parameter bins", "output": "When creating a AggregateFilter, the bins parameter specifies the filter bins included in the aggregation. It should be a Iterable of tuple value." }, { "instruction": "What does the aggregate_op parameter do when creating a AggregateFilter?", "input": "OpenMC Python API AggregateFilter constructor parameter aggregate_op", "output": "When creating a AggregateFilter, the aggregate_op parameter specifies the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally filter's bins with this aggregatefilter. It should be a str value." }, { "instruction": "What is the type attribute of a AggregateFilter?", "input": "OpenMC Python API AggregateFilter attribute type", "output": "The type attribute of a AggregateFilter contains the type of the aggregatefilter (e.g., 'sum(energy)', 'sum(cell)'). It's a str value that you can access after creating a AggregateFilter instance." }, { "instruction": "What is the aggregate_filter attribute of a AggregateFilter?", "input": "OpenMC Python API AggregateFilter attribute aggregate_filter", "output": "The aggregate_filter attribute of a AggregateFilter contains the filter included in the aggregation. It's a openmc.Filter value that you can access after creating a AggregateFilter instance." }, { "instruction": "What is the aggregate_op attribute of a AggregateFilter?", "input": "OpenMC Python API AggregateFilter attribute aggregate_op", "output": "The aggregate_op attribute of a AggregateFilter contains the tally aggregation operator (e.g., 'sum', 'avg', etc.) used to aggregate across a tally filter's bins with this aggregatefilter. It's a str value that you can access after creating a AggregateFilter instance." }, { "instruction": "What is the bins attribute of a AggregateFilter?", "input": "OpenMC Python API AggregateFilter attribute bins", "output": "The bins attribute of a AggregateFilter contains the filter bins included in the aggregation. It's a Iterable of tuple value that you can access after creating a AggregateFilter instance." }, { "instruction": "What is the num_bins attribute of a AggregateFilter?", "input": "OpenMC Python API AggregateFilter attribute num_bins", "output": "The num_bins attribute of a AggregateFilter contains the number of filter bins (always 1 if aggregate_filter is defined). It's a Integral value that you can access after creating a AggregateFilter instance." }, { "instruction": "How do you call the __init__() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, aggregate_filter: Any, bins: Any, aggregate_op: Any). It takes 4 parameters." }, { "instruction": "How do you call the __hash__() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __gt__() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.__gt__() method signature", "output": "To call the __gt__() method, use: def __gt__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __lt__() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.__lt__() method signature", "output": "To call the __lt__() method, use: def __lt__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the aggregate_filter() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.aggregate_filter() method signature", "output": "To call the aggregate_filter() method, use: @property def aggregate_filter(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the aggregate_filter() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.aggregate_filter() method signature", "output": "To call the aggregate_filter() method, use: @aggregate_filter.setter def aggregate_filter(self: Any, aggregate_filter: Any). It takes 2 parameters." }, { "instruction": "How do you call the aggregate_op() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.aggregate_op() method signature", "output": "To call the aggregate_op() method, use: @property def aggregate_op(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the aggregate_op() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.aggregate_op() method signature", "output": "To call the aggregate_op() method, use: @aggregate_op.setter def aggregate_op(self: Any, aggregate_op: Any). It takes 2 parameters." }, { "instruction": "How do you call the type() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the type() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.type() method signature", "output": "To call the type() method, use: @type.setter def type(self: Any, filter_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the bins() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bins() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.bins() method signature", "output": "To call the bins() method, use: @bins.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_bins() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.num_bins() method signature", "output": "To call the num_bins() method, use: @property def num_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the shape() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.shape() method signature", "output": "To call the shape() method, use: @property def shape(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_bin_index() method do in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.get_bin_index() method", "output": "The get_bin_index() method returns the index in the aggregatefilter for some bin. It's used for aggregatefilter operations." }, { "instruction": "How do you call the get_bin_index() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "What does the filter_bin parameter do in the get_bin_index() method?", "input": "OpenMC Python API AggregateFilter.get_bin_index() parameter filter_bin", "output": "The filter_bin parameter a tuple of value(s) corresponding to the bin of interest in the aggregated filter. the bin is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. the bin is the integer cell instance id for 'distribcell' filters. the bin is a 2-tuple of floats for 'energy' and 'energyout' filters corresponding to the energy boundaries of the bin of interest. the bin is a (x,y,z) 3-tuple for 'mesh' filters corresponding to the mesh cell of interest.. It should be a Integral or tuple of Real value." }, { "instruction": "What does the get_bin_index() method return in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.get_bin_index() return value", "output": "The get_bin_index() method returns the index in the tally data array for this filter bin. for an aggregatetally the filter bin index is always unity.. The return type is Integral." }, { "instruction": "What does the get_pandas_dataframe() method do in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the aggregatefilter's bins. this method constructs a pandas dataframe object for the aggregatefilter with columns annotated by filter bin information. this is a helper method for the tally.get_pandas_dataframe(...) method. It's used for aggregatefilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any, summary: Any). It takes 4 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API AggregateFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API AggregateFilter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter. It should be a int value." }, { "instruction": "What does the summary parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API AggregateFilter.get_pandas_dataframe() parameter summary", "output": "The summary parameter an optional summary object to be used to construct columns for distribcell tally filters (default is none). note: this parameter is not used by the aggregatefilter and simply mirrors the method signature for the crossfilter.. It should be a None or Summary value." }, { "instruction": "What does the can_merge() method do in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.can_merge() method", "output": "The can_merge() method determine if aggregatefilter can be merged with another. It's used for aggregatefilter operations." }, { "instruction": "How do you call the can_merge() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the can_merge() method?", "input": "OpenMC Python API AggregateFilter.can_merge() parameter other", "output": "The other parameter filter to compare with. It should be a AggregateFilter value." }, { "instruction": "What does the merge() method do in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.merge() method", "output": "The merge() method merge this aggregatefilter with another. It's used for aggregatefilter operations." }, { "instruction": "How do you call the merge() method in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API AggregateFilter.merge() parameter other", "output": "The other parameter filter to merge with. It should be a AggregateFilter value." }, { "instruction": "What does the merge() method return in the AggregateFilter class?", "input": "OpenMC Python API AggregateFilter.merge() return value", "output": "The merge() method returns filter resulting from the merge. The return type is AggregateFilter." }, { "instruction": "What is the BoundingBox class in OpenMC's Python API?", "input": "OpenMC Python API BoundingBox class", "output": "The BoundingBox class represents axis-aligned bounding box. .. versionadded:: 0.14.0. It provides 20 methods and 0 properties for working with boundingbox data in OpenMC." }, { "instruction": "What does the BoundingBox class do in OpenMC's Python API?", "input": "OpenMC Python API BoundingBox class description", "output": "The BoundingBox class axis-aligned bounding box. .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the lower_left parameter do when creating a BoundingBox?", "input": "OpenMC Python API BoundingBox constructor parameter lower_left", "output": "When creating a BoundingBox, the lower_left parameter specifies the x, y, z coordinates of the lower left corner of the bounding box in [cm]. It should be a iterable of float value." }, { "instruction": "What does the upper_right parameter do when creating a BoundingBox?", "input": "OpenMC Python API BoundingBox constructor parameter upper_right", "output": "When creating a BoundingBox, the upper_right parameter specifies the x, y, z coordinates of the upper right corner of the bounding box in [cm]. It should be a iterable of float value." }, { "instruction": "What is the center attribute of a BoundingBox?", "input": "OpenMC Python API BoundingBox attribute center", "output": "The center attribute of a BoundingBox contains x, y, z coordinates of the center of the bounding box in [cm]. It's a numpy.ndarray value that you can access after creating a BoundingBox instance." }, { "instruction": "What is the lower_left attribute of a BoundingBox?", "input": "OpenMC Python API BoundingBox attribute lower_left", "output": "The lower_left attribute of a BoundingBox contains the x, y, z coordinates of the lower left corner of the bounding box in [cm]. It's a numpy.ndarray value that you can access after creating a BoundingBox instance." }, { "instruction": "What is the upper_right attribute of a BoundingBox?", "input": "OpenMC Python API BoundingBox attribute upper_right", "output": "The upper_right attribute of a BoundingBox contains the x, y, z coordinates of the upper right corner of the bounding box in [cm]. It's a numpy.ndarray value that you can access after creating a BoundingBox instance." }, { "instruction": "What is the volume attribute of a BoundingBox?", "input": "OpenMC Python API BoundingBox attribute volume", "output": "The volume attribute of a BoundingBox contains the volume of the bounding box in [cm^3]. It's a float value that you can access after creating a BoundingBox instance." }, { "instruction": "What is the extent attribute of a BoundingBox?", "input": "OpenMC Python API BoundingBox attribute extent", "output": "The extent attribute of a BoundingBox contains a dictionary of basis as keys and the extent (left, right, bottom, top) as values. intended use in matplotlib plots when setting extent. It's a dict value that you can access after creating a BoundingBox instance." }, { "instruction": "What is the width attribute of a BoundingBox?", "input": "OpenMC Python API BoundingBox attribute width", "output": "The width attribute of a BoundingBox contains the width of the x, y and z axis in [cm]. It's a iterable of float value that you can access after creating a BoundingBox instance." }, { "instruction": "How do you call the __init__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, lower_left: Any, upper_right: Any). It takes 3 parameters." }, { "instruction": "How do you call the __repr__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getitem__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __setitem__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__setitem__() method signature", "output": "To call the __setitem__() method, use: def __setitem__(self: Any, key: Any, val: Any). It takes 3 parameters." }, { "instruction": "What does the __iand__() method do in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__iand__() method", "output": "The __iand__() method updates the box be the intersection of itself and another box. It's used for boundingbox operations." }, { "instruction": "How do you call the __iand__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__iand__() method signature", "output": "To call the __iand__() method, use: def __iand__(self: Any, other: BoundingBox). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __iand__() method?", "input": "OpenMC Python API BoundingBox.__iand__() parameter other", "output": "The other parameter the box used to resize this box. It should be a BoundingBox value." }, { "instruction": "How do you call the __and__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__and__() method signature", "output": "To call the __and__() method, use: def __and__(self: Any, other: BoundingBox). It takes 2 parameters." }, { "instruction": "What does the __ior__() method do in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__ior__() method", "output": "The __ior__() method updates the box be the union of itself and another box. It's used for boundingbox operations." }, { "instruction": "How do you call the __ior__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__ior__() method signature", "output": "To call the __ior__() method, use: def __ior__(self: Any, other: BoundingBox). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __ior__() method?", "input": "OpenMC Python API BoundingBox.__ior__() parameter other", "output": "The other parameter the box used to resize this box. It should be a BoundingBox value." }, { "instruction": "How do you call the __or__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__or__() method signature", "output": "To call the __or__() method, use: def __or__(self: Any, other: BoundingBox). It takes 2 parameters." }, { "instruction": "What does the __contains__() method do in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__contains__() method", "output": "The __contains__() method check whether or not a point or another bounding box is in the bounding box.\n\n for another bounding box to be in the parent it must lie fully inside of it.. It's used for boundingbox operations." }, { "instruction": "How do you call the __contains__() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the center() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.center() method signature", "output": "To call the center() method, use: @property def center(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.lower_left() method signature", "output": "To call the lower_left() method, use: @lower_left.setter def lower_left(self: Any, llc: Any). It takes 2 parameters." }, { "instruction": "How do you call the upper_right() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.upper_right() method signature", "output": "To call the upper_right() method, use: @upper_right.setter def upper_right(self: Any, urc: Any). It takes 2 parameters." }, { "instruction": "How do you call the volume() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the extent() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.extent() method signature", "output": "To call the extent() method, use: @property def extent(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "What does the expand() method do in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.expand() method", "output": "The expand() method returns an expanded bounding box. It's used for boundingbox operations." }, { "instruction": "How do you call the expand() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.expand() method signature", "output": "To call the expand() method, use: def expand(self: Any, padding_distance: float, inplace: bool). It takes 3 parameters." }, { "instruction": "What does the padding_distance parameter do in the expand() method?", "input": "OpenMC Python API BoundingBox.expand() parameter padding_distance", "output": "The padding_distance parameter the distance to enlarge the bounding box by. It should be a float value." }, { "instruction": "What does the inplace parameter do in the expand() method?", "input": "OpenMC Python API BoundingBox.expand() parameter inplace", "output": "The inplace parameter whether or not to return a new boundingbox instance or to modify the current boundingbox object.. It should be a bool value." }, { "instruction": "What does the infinite() method do in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.infinite() method", "output": "The infinite() method create an infinite box. useful as a starting point for determining geometry bounds. It's used for boundingbox operations." }, { "instruction": "How do you call the infinite() method in the BoundingBox class?", "input": "OpenMC Python API BoundingBox.infinite() method signature", "output": "To call the infinite() method, use: @classmethod def infinite(cls: Any). It takes 1 parameters." }, { "instruction": "What is the Cell class in OpenMC's Python API?", "input": "OpenMC Python API Cell class", "output": "The Cell class represents a region of space defined as the intersection of half-space created by quadric surfaces. It provides 33 methods and 0 properties for working with cell data in OpenMC." }, { "instruction": "What does the Cell class do in OpenMC's Python API?", "input": "OpenMC Python API Cell class description", "output": "The Cell class a region of space defined as the intersection of half-space created by quadric surfaces. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the cell_id parameter do when creating a Cell?", "input": "OpenMC Python API Cell constructor parameter cell_id", "output": "When creating a Cell, the cell_id parameter specifies unique identifier for the cell. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a Cell?", "input": "OpenMC Python API Cell constructor parameter name", "output": "When creating a Cell, the name parameter specifies name of the cell. if not specified, the name is the empty string.. It should be a str, optional value." }, { "instruction": "What does the fill parameter do when creating a Cell?", "input": "OpenMC Python API Cell constructor parameter fill", "output": "When creating a Cell, the fill parameter specifies indicates what the region of space is filled with. It should be a openmc.Material or openmc.UniverseBase or openmc.Lattice or None or iterable of openmc.Material, optional value." }, { "instruction": "What does the region parameter do when creating a Cell?", "input": "OpenMC Python API Cell constructor parameter region", "output": "When creating a Cell, the region parameter specifies region of space that is assigned to the cell.. It should be a openmc.Region, optional value." }, { "instruction": "What is the id attribute of a Cell?", "input": "OpenMC Python API Cell attribute id", "output": "The id attribute of a Cell contains unique identifier for the cell. It's a int value that you can access after creating a Cell instance." }, { "instruction": "What is the name attribute of a Cell?", "input": "OpenMC Python API Cell attribute name", "output": "The name attribute of a Cell contains name of the cell. It's a str value that you can access after creating a Cell instance." }, { "instruction": "What is the fill attribute of a Cell?", "input": "OpenMC Python API Cell attribute fill", "output": "The fill attribute of a Cell contains indicates what the region of space is filled with. if none, the cell is treated as a void. an iterable of materials is used to fill repeated instances of a cell with different materials.. It's a openmc.Material or openmc.UniverseBase or openmc.Lattice or None or iterable of openmc.Material value that you can access after creating a Cell instance." }, { "instruction": "What is the fill_type attribute of a Cell?", "input": "OpenMC Python API Cell attribute fill_type", "output": "The fill_type attribute of a Cell contains indicates what the cell is filled with.. It's a {'material', 'universe', 'lattice', 'distribmat', 'void'} value that you can access after creating a Cell instance." }, { "instruction": "What is the region attribute of a Cell?", "input": "OpenMC Python API Cell attribute region", "output": "The region attribute of a Cell contains region of space that is assigned to the cell.. It's a openmc.Region or None value that you can access after creating a Cell instance." }, { "instruction": "What is the rotation attribute of a Cell?", "input": "OpenMC Python API Cell attribute rotation", "output": "The rotation attribute of a Cell contains if the cell is filled with a universe, this array specifies the angles in degrees about the x, y, and z axes that the filled universe should be rotated. the rotation applied is an intrinsic rotation with specified tait-bryan angles. that is to say, if the angles are :math:`(\\phi, \\theta, \\psi)`, then the rotation matrix applied is :math:`r_z(\\psi) r_y(\\theta) r_x(\\phi)` or .. math:: \\left [ \\begin{array}{ccc} \\cos\\theta \\cos\\psi & -\\cos\\phi \\sin\\psi + \\sin\\phi \\sin\\theta \\cos\\psi & \\sin\\phi \\sin\\psi + \\cos\\phi \\sin\\theta \\cos\\psi \\\\ \\cos\\theta \\sin\\psi & \\cos\\phi \\cos\\psi + \\sin\\phi \\sin\\theta \\sin\\psi & -\\sin\\phi \\cos\\psi + \\cos\\phi \\sin\\theta \\sin\\psi \\\\ -\\sin\\theta & \\sin\\phi \\cos\\theta & \\cos\\phi \\cos\\theta \\end{array} \\right ] a rotation matrix can also be specified directly by setting this attribute to a nested list (or 2d numpy array) that specifies each element of the matrix.. It's a Iterable of float value that you can access after creating a Cell instance." }, { "instruction": "What is the rotation_matrix attribute of a Cell?", "input": "OpenMC Python API Cell attribute rotation_matrix", "output": "The rotation_matrix attribute of a Cell contains the rotation matrix defined by the angles specified in the :attr:`cell.rotation` property.. It's a numpy.ndarray value that you can access after creating a Cell instance." }, { "instruction": "What is the temperature attribute of a Cell?", "input": "OpenMC Python API Cell attribute temperature", "output": "The temperature attribute of a Cell contains temperature of the cell in kelvin. multiple temperatures can be given to give each distributed cell instance a unique temperature.. It's a float or iterable of float value that you can access after creating a Cell instance." }, { "instruction": "What is the translation attribute of a Cell?", "input": "OpenMC Python API Cell attribute translation", "output": "The translation attribute of a Cell contains if the cell is filled with a universe, this array specifies a vector that is used to translate (shift) the universe.. It's a Iterable of float value that you can access after creating a Cell instance." }, { "instruction": "What is the paths attribute of a Cell?", "input": "OpenMC Python API Cell attribute paths", "output": "The paths attribute of a Cell contains the paths traversed through the csg tree to reach each cell instance. this property is initialized by calling the :meth:`geometry.determine_paths` method.. It's a list of str value that you can access after creating a Cell instance." }, { "instruction": "What is the num_instances attribute of a Cell?", "input": "OpenMC Python API Cell attribute num_instances", "output": "The num_instances attribute of a Cell contains the number of instances of this cell throughout the geometry.. It's a int value that you can access after creating a Cell instance." }, { "instruction": "What is the volume attribute of a Cell?", "input": "OpenMC Python API Cell attribute volume", "output": "The volume attribute of a Cell contains volume of the cell in cm^3. this can either be set manually or calculated in a stochastic volume calculation and added via the :meth:`cell.add_volume_information` method. for 'distribmat' cells it is the total volume of all instances.. It's a float value that you can access after creating a Cell instance." }, { "instruction": "What is the atoms attribute of a Cell?", "input": "OpenMC Python API Cell attribute atoms", "output": "The atoms attribute of a Cell contains mapping of nuclides to the total number of atoms for each nuclide present in the cell, or in all of its instances for a 'distribmat' fill. for example, {'u235': 1.0e22, 'u238': 5.0e22, ...}. .. versionadded:: 0.12. It's a dict value that you can access after creating a Cell instance." }, { "instruction": "What is the bounding_box attribute of a Cell?", "input": "OpenMC Python API Cell attribute bounding_box", "output": "The bounding_box attribute of a Cell contains axis-aligned bounding box of the cell. It's a openmc.BoundingBox value that you can access after creating a Cell instance." }, { "instruction": "How do you call the __init__() method in the Cell class?", "input": "OpenMC Python API Cell.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, cell_id: Any, name: Any, fill: Any, region: Any). It takes 5 parameters." }, { "instruction": "How do you call the __contains__() method in the Cell class?", "input": "OpenMC Python API Cell.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Cell class?", "input": "OpenMC Python API Cell.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Cell class?", "input": "OpenMC Python API Cell.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Cell class?", "input": "OpenMC Python API Cell.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the fill() method in the Cell class?", "input": "OpenMC Python API Cell.fill() method signature", "output": "To call the fill() method, use: @property def fill(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fill() method in the Cell class?", "input": "OpenMC Python API Cell.fill() method signature", "output": "To call the fill() method, use: @fill.setter def fill(self: Any, fill: Any). It takes 2 parameters." }, { "instruction": "How do you call the fill_type() method in the Cell class?", "input": "OpenMC Python API Cell.fill_type() method signature", "output": "To call the fill_type() method, use: @property def fill_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the region() method in the Cell class?", "input": "OpenMC Python API Cell.region() method signature", "output": "To call the region() method, use: @property def region(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the region() method in the Cell class?", "input": "OpenMC Python API Cell.region() method signature", "output": "To call the region() method, use: @region.setter def region(self: Any, region: Any). It takes 2 parameters." }, { "instruction": "How do you call the rotation() method in the Cell class?", "input": "OpenMC Python API Cell.rotation() method signature", "output": "To call the rotation() method, use: @property def rotation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rotation() method in the Cell class?", "input": "OpenMC Python API Cell.rotation() method signature", "output": "To call the rotation() method, use: @rotation.setter def rotation(self: Any, rotation: Any). It takes 2 parameters." }, { "instruction": "How do you call the rotation_matrix() method in the Cell class?", "input": "OpenMC Python API Cell.rotation_matrix() method signature", "output": "To call the rotation_matrix() method, use: @property def rotation_matrix(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the temperature() method in the Cell class?", "input": "OpenMC Python API Cell.temperature() method signature", "output": "To call the temperature() method, use: @property def temperature(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the temperature() method in the Cell class?", "input": "OpenMC Python API Cell.temperature() method signature", "output": "To call the temperature() method, use: @temperature.setter def temperature(self: Any, temperature: Any). It takes 2 parameters." }, { "instruction": "How do you call the translation() method in the Cell class?", "input": "OpenMC Python API Cell.translation() method signature", "output": "To call the translation() method, use: @property def translation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the translation() method in the Cell class?", "input": "OpenMC Python API Cell.translation() method signature", "output": "To call the translation() method, use: @translation.setter def translation(self: Any, translation: Any). It takes 2 parameters." }, { "instruction": "How do you call the volume() method in the Cell class?", "input": "OpenMC Python API Cell.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the Cell class?", "input": "OpenMC Python API Cell.volume() method signature", "output": "To call the volume() method, use: @volume.setter def volume(self: Any, volume: Any). It takes 2 parameters." }, { "instruction": "How do you call the atoms() method in the Cell class?", "input": "OpenMC Python API Cell.atoms() method signature", "output": "To call the atoms() method, use: @property def atoms(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the paths() method in the Cell class?", "input": "OpenMC Python API Cell.paths() method signature", "output": "To call the paths() method, use: @property def paths(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the Cell class?", "input": "OpenMC Python API Cell.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_instances() method in the Cell class?", "input": "OpenMC Python API Cell.num_instances() method signature", "output": "To call the num_instances() method, use: @property def num_instances(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_volume_information() method do in the Cell class?", "input": "OpenMC Python API Cell.add_volume_information() method", "output": "The add_volume_information() method add volume information to a cell. It's used for cell operations." }, { "instruction": "How do you call the add_volume_information() method in the Cell class?", "input": "OpenMC Python API Cell.add_volume_information() method signature", "output": "To call the add_volume_information() method, use: def add_volume_information(self: Any, volume_calc: Any). It takes 2 parameters." }, { "instruction": "What does the volume_calc parameter do in the add_volume_information() method?", "input": "OpenMC Python API Cell.add_volume_information() parameter volume_calc", "output": "The volume_calc parameter results from a stochastic volume calculation. It should be a openmc.VolumeCalculation value." }, { "instruction": "What does the get_nuclides() method do in the Cell class?", "input": "OpenMC Python API Cell.get_nuclides() method", "output": "The get_nuclides() method returns all nuclides in the cell. It's used for cell operations." }, { "instruction": "How do you call the get_nuclides() method in the Cell class?", "input": "OpenMC Python API Cell.get_nuclides() method signature", "output": "To call the get_nuclides() method, use: def get_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclides() method return in the Cell class?", "input": "OpenMC Python API Cell.get_nuclides() return value", "output": "The get_nuclides() method returns list of nuclide names. The return type is list of str." }, { "instruction": "What does the get_nuclide_densities() method do in the Cell class?", "input": "OpenMC Python API Cell.get_nuclide_densities() method", "output": "The get_nuclide_densities() method return all nuclides contained in the cell and their densities. It's used for cell operations." }, { "instruction": "How do you call the get_nuclide_densities() method in the Cell class?", "input": "OpenMC Python API Cell.get_nuclide_densities() method signature", "output": "To call the get_nuclide_densities() method, use: def get_nuclide_densities(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclide_densities() method return in the Cell class?", "input": "OpenMC Python API Cell.get_nuclide_densities() return value", "output": "The get_nuclide_densities() method returns dictionary whose keys are nuclide names and values are 2-tuples of (nuclide, density). The return type is dict." }, { "instruction": "What does the get_all_cells() method do in the Cell class?", "input": "OpenMC Python API Cell.get_all_cells() method", "output": "The get_all_cells() method return all cells that are contained within this one if it is filled with a universe or lattice. It's used for cell operations." }, { "instruction": "How do you call the get_all_cells() method in the Cell class?", "input": "OpenMC Python API Cell.get_all_cells() method signature", "output": "To call the get_all_cells() method, use: def get_all_cells(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_cells() method return in the Cell class?", "input": "OpenMC Python API Cell.get_all_cells() return value", "output": "The get_all_cells() method returns dictionary whose keys are cell ids and values are :class:`cell` instances. The return type is dict." }, { "instruction": "What does the get_all_materials() method do in the Cell class?", "input": "OpenMC Python API Cell.get_all_materials() method", "output": "The get_all_materials() method return all materials that are contained within the cell. It's used for cell operations." }, { "instruction": "How do you call the get_all_materials() method in the Cell class?", "input": "OpenMC Python API Cell.get_all_materials() method signature", "output": "To call the get_all_materials() method, use: def get_all_materials(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_materials() method return in the Cell class?", "input": "OpenMC Python API Cell.get_all_materials() return value", "output": "The get_all_materials() method returns dictionary whose keys are material ids and values are :class:`material` instances. The return type is dict." }, { "instruction": "What does the get_all_universes() method do in the Cell class?", "input": "OpenMC Python API Cell.get_all_universes() method", "output": "The get_all_universes() method return all universes that are contained within this one if any of its cells are filled with a universe or lattice. It's used for cell operations." }, { "instruction": "How do you call the get_all_universes() method in the Cell class?", "input": "OpenMC Python API Cell.get_all_universes() method signature", "output": "To call the get_all_universes() method, use: def get_all_universes(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_universes() method return in the Cell class?", "input": "OpenMC Python API Cell.get_all_universes() return value", "output": "The get_all_universes() method returns dictionary whose keys are universe ids and values are :class:`universe` instances. The return type is dict." }, { "instruction": "What does the clone() method do in the Cell class?", "input": "OpenMC Python API Cell.clone() method", "output": "The clone() method create a copy of this cell with a new unique id, and clones the cell's region and fill. It's used for cell operations." }, { "instruction": "How do you call the clone() method in the Cell class?", "input": "OpenMC Python API Cell.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, clone_materials: Any, clone_regions: Any, memo: Any). It takes 4 parameters." }, { "instruction": "What does the clone_materials parameter do in the clone() method?", "input": "OpenMC Python API Cell.clone() parameter clone_materials", "output": "The clone_materials parameter whether to create separate copies of the materials filling cells contained in this cell, or the material filling this cell.. It should be a bool value." }, { "instruction": "What does the clone_regions parameter do in the clone() method?", "input": "OpenMC Python API Cell.clone() parameter clone_regions", "output": "The clone_regions parameter whether to create separate copies of the regions bounding cells contained in this cell, and the region bounding this cell.. It should be a bool value." }, { "instruction": "What does the memo parameter do in the clone() method?", "input": "OpenMC Python API Cell.clone() parameter memo", "output": "The memo parameter a nested dictionary of previously cloned objects. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the clone() method return in the Cell class?", "input": "OpenMC Python API Cell.clone() return value", "output": "The clone() method returns the clone of this cell. The return type is openmc.Cell." }, { "instruction": "What does the plot() method do in the Cell class?", "input": "OpenMC Python API Cell.plot() method", "output": "The plot() method display a slice plot of the cell.\n\n .. versionadded:: 0.14.0. It's used for cell operations." }, { "instruction": "How do you call the plot() method in the Cell class?", "input": "OpenMC Python API Cell.plot() method signature", "output": "To call the plot() method, use: @add_plot_params def plot(self: Any). It takes 1 parameters." }, { "instruction": "What does the create_xml_subelement() method do in the Cell class?", "input": "OpenMC Python API Cell.create_xml_subelement() method", "output": "The create_xml_subelement() method add the cell's xml representation to an incoming xml element. It's used for cell operations." }, { "instruction": "How do you call the create_xml_subelement() method in the Cell class?", "input": "OpenMC Python API Cell.create_xml_subelement() method signature", "output": "To call the create_xml_subelement() method, use: def create_xml_subelement(self: Any, xml_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "What does the xml_element parameter do in the create_xml_subelement() method?", "input": "OpenMC Python API Cell.create_xml_subelement() parameter xml_element", "output": "The xml_element parameter xml element to be added to. It should be a lxml.etree._Element value." }, { "instruction": "What does the memo parameter do in the create_xml_subelement() method?", "input": "OpenMC Python API Cell.create_xml_subelement() parameter memo", "output": "The memo parameter a set of object ids representing geometry entities already written to ``xml_element``. this parameter is used internally and should not be specified by users.. It should be a set or None value." }, { "instruction": "What does the from_xml_element() method do in the Cell class?", "input": "OpenMC Python API Cell.from_xml_element() method", "output": "The from_xml_element() method generate cell from xml element. It's used for cell operations." }, { "instruction": "How do you call the from_xml_element() method in the Cell class?", "input": "OpenMC Python API Cell.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, surfaces: Any, materials: Any, get_universe: Any). It takes 5 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Cell.from_xml_element() parameter elem", "output": "The elem parameter `` element. It should be a lxml.etree._Element value." }, { "instruction": "What does the surfaces parameter do in the from_xml_element() method?", "input": "OpenMC Python API Cell.from_xml_element() parameter surfaces", "output": "The surfaces parameter dictionary mapping surface ids to :class:`openmc.surface` instances. It should be a dict value." }, { "instruction": "What does the materials parameter do in the from_xml_element() method?", "input": "OpenMC Python API Cell.from_xml_element() parameter materials", "output": "The materials parameter dictionary mapping material id strings to :class:`openmc.material` instances (defined in :meth:`openmc.geometry.from_xml`). It should be a dict value." }, { "instruction": "What does the get_universe parameter do in the from_xml_element() method?", "input": "OpenMC Python API Cell.from_xml_element() parameter get_universe", "output": "The get_universe parameter function returning universe (defined in :meth:`openmc.geometry.from_xml`). It should be a function value." }, { "instruction": "How do you call the create_surface_elements() function in OpenMC's Python API?", "input": "OpenMC Python API create_surface_elements() function signature", "output": "To call the create_surface_elements() function, use: def create_surface_elements(node: Any, element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "What is the CheckedList class in OpenMC's Python API?", "input": "OpenMC Python API CheckedList class", "output": "The CheckedList class represents a list for which each element is type-checked as it's added. It provides 6 methods and 0 properties for working with checkedlist data in OpenMC." }, { "instruction": "What does the CheckedList class do in OpenMC's Python API?", "input": "OpenMC Python API CheckedList class description", "output": "The CheckedList class a list for which each element is type-checked as it's added. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the expected_type parameter do when creating a CheckedList?", "input": "OpenMC Python API CheckedList constructor parameter expected_type", "output": "When creating a CheckedList, the expected_type parameter specifies type(s) which each element should be. It should be a type or Iterable of type value." }, { "instruction": "What does the name parameter do when creating a CheckedList?", "input": "OpenMC Python API CheckedList constructor parameter name", "output": "When creating a CheckedList, the name parameter specifies name of data being checked. It should be a str value." }, { "instruction": "What does the items parameter do when creating a CheckedList?", "input": "OpenMC Python API CheckedList constructor parameter items", "output": "When creating a CheckedList, the items parameter specifies items to initialize the list with. It should be a Iterable, optional value." }, { "instruction": "How do you call the __init__() method in the CheckedList class?", "input": "OpenMC Python API CheckedList.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, expected_type: Any, name: Any, items: Any). It takes 4 parameters." }, { "instruction": "How do you call the __add__() method in the CheckedList class?", "input": "OpenMC Python API CheckedList.__add__() method signature", "output": "To call the __add__() method, use: def __add__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __radd__() method in the CheckedList class?", "input": "OpenMC Python API CheckedList.__radd__() method signature", "output": "To call the __radd__() method, use: def __radd__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iadd__() method in the CheckedList class?", "input": "OpenMC Python API CheckedList.__iadd__() method signature", "output": "To call the __iadd__() method, use: def __iadd__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the append() method do in the CheckedList class?", "input": "OpenMC Python API CheckedList.append() method", "output": "The append() method append item to list. It's used for checkedlist operations." }, { "instruction": "How do you call the append() method in the CheckedList class?", "input": "OpenMC Python API CheckedList.append() method signature", "output": "To call the append() method, use: def append(self: Any, item: Any). It takes 2 parameters." }, { "instruction": "What does the item parameter do in the append() method?", "input": "OpenMC Python API CheckedList.append() parameter item", "output": "The item parameter item to append. It should be a object value." }, { "instruction": "What does the insert() method do in the CheckedList class?", "input": "OpenMC Python API CheckedList.insert() method", "output": "The insert() method insert item before index. It's used for checkedlist operations." }, { "instruction": "How do you call the insert() method in the CheckedList class?", "input": "OpenMC Python API CheckedList.insert() method signature", "output": "To call the insert() method, use: def insert(self: Any, index: Any, item: Any). It takes 3 parameters." }, { "instruction": "What does the index parameter do in the insert() method?", "input": "OpenMC Python API CheckedList.insert() parameter index", "output": "The index parameter index in list. It should be a int value." }, { "instruction": "What does the item parameter do in the insert() method?", "input": "OpenMC Python API CheckedList.insert() parameter item", "output": "The item parameter item to insert. It should be a object value." }, { "instruction": "What does the check_type() function do in OpenMC's Python API?", "input": "OpenMC Python API check_type() function", "output": "The check_type() function ensure that an object is of an expected type. optionally, if the object is iterable, check that each element is of a particular type. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_type() function in OpenMC's Python API?", "input": "OpenMC Python API check_type() function purpose", "output": "The check_type() function ensure that an object is of an expected type. optionally, if the object is iterable, check that each element is of a particular type. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_type() function in OpenMC's Python API?", "input": "OpenMC Python API check_type() function signature", "output": "To call the check_type() function, use: def check_type(name: Any, value: Any, expected_type: Any, expected_iter_type: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the check_type() function?", "input": "OpenMC Python API check_type() parameter name", "output": "The name parameter description of value being checked. It should be a str value." }, { "instruction": "What does the value parameter do in the check_type() function?", "input": "OpenMC Python API check_type() parameter value", "output": "The value parameter object to check type of. It should be a object value." }, { "instruction": "What does the expected_type parameter do in the check_type() function?", "input": "OpenMC Python API check_type() parameter expected_type", "output": "The expected_type parameter type to check object against. It should be a type or Iterable of type value." }, { "instruction": "What does the expected_iter_type parameter do in the check_type() function?", "input": "OpenMC Python API check_type() parameter expected_iter_type", "output": "The expected_iter_type parameter expected type of each element in value, assuming it is iterable. if none, no check will be performed.. It should be a type or Iterable of type or None, optional value." }, { "instruction": "What does the none_ok parameter do in the check_type() function?", "input": "OpenMC Python API check_type() parameter none_ok", "output": "The none_ok parameter whether none is allowed as a value. It should be a bool, optional value." }, { "instruction": "What does the check_iterable_type() function do in OpenMC's Python API?", "input": "OpenMC Python API check_iterable_type() function", "output": "The check_iterable_type() function ensure that an object is an iterable containing an expected type. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_iterable_type() function in OpenMC's Python API?", "input": "OpenMC Python API check_iterable_type() function purpose", "output": "The check_iterable_type() function ensure that an object is an iterable containing an expected type. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_iterable_type() function in OpenMC's Python API?", "input": "OpenMC Python API check_iterable_type() function signature", "output": "To call the check_iterable_type() function, use: def check_iterable_type(name: Any, value: Any, expected_type: Any, min_depth: Any, max_depth: Any). It takes 5 parameters." }, { "instruction": "What does the name parameter do in the check_iterable_type() function?", "input": "OpenMC Python API check_iterable_type() parameter name", "output": "The name parameter description of value being checked. It should be a str value." }, { "instruction": "What does the value parameter do in the check_iterable_type() function?", "input": "OpenMC Python API check_iterable_type() parameter value", "output": "The value parameter iterable, possibly of other iterables, that should ultimately contain the expected type. It should be a Iterable value." }, { "instruction": "What does the expected_type parameter do in the check_iterable_type() function?", "input": "OpenMC Python API check_iterable_type() parameter expected_type", "output": "The expected_type parameter type that the iterable should contain. It should be a type value." }, { "instruction": "What does the min_depth parameter do in the check_iterable_type() function?", "input": "OpenMC Python API check_iterable_type() parameter min_depth", "output": "The min_depth parameter the minimum number of layers of nested iterables there should be before reaching the ultimately contained items. It should be a int value." }, { "instruction": "What does the max_depth parameter do in the check_iterable_type() function?", "input": "OpenMC Python API check_iterable_type() parameter max_depth", "output": "The max_depth parameter the maximum number of layers of nested iterables there should be before reaching the ultimately contained items. It should be a int value." }, { "instruction": "What does the check_length() function do in OpenMC's Python API?", "input": "OpenMC Python API check_length() function", "output": "The check_length() function ensure that a sized object has length within a given range. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_length() function in OpenMC's Python API?", "input": "OpenMC Python API check_length() function purpose", "output": "The check_length() function ensure that a sized object has length within a given range. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_length() function in OpenMC's Python API?", "input": "OpenMC Python API check_length() function signature", "output": "To call the check_length() function, use: def check_length(name: Any, value: Any, length_min: Any, length_max: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the check_length() function?", "input": "OpenMC Python API check_length() parameter name", "output": "The name parameter description of value being checked. It should be a str value." }, { "instruction": "What does the value parameter do in the check_length() function?", "input": "OpenMC Python API check_length() parameter value", "output": "The value parameter object to check length of. It should be a collections.Sized value." }, { "instruction": "What does the length_min parameter do in the check_length() function?", "input": "OpenMC Python API check_length() parameter length_min", "output": "The length_min parameter minimum length of object. It should be a int value." }, { "instruction": "What does the length_max parameter do in the check_length() function?", "input": "OpenMC Python API check_length() parameter length_max", "output": "The length_max parameter maximum length of object. if none, it is assumed object must be of length length_min.. It should be a int or None, optional value." }, { "instruction": "What does the check_increasing() function do in OpenMC's Python API?", "input": "OpenMC Python API check_increasing() function", "output": "The check_increasing() function ensure that a list's elements are strictly or loosely increasing. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_increasing() function in OpenMC's Python API?", "input": "OpenMC Python API check_increasing() function purpose", "output": "The check_increasing() function ensure that a list's elements are strictly or loosely increasing. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_increasing() function in OpenMC's Python API?", "input": "OpenMC Python API check_increasing() function signature", "output": "To call the check_increasing() function, use: def check_increasing(name: str, value: Any, equality: bool). It takes 3 parameters." }, { "instruction": "What does the name parameter do in the check_increasing() function?", "input": "OpenMC Python API check_increasing() parameter name", "output": "The name parameter description of value being checked. It should be a str value." }, { "instruction": "What does the value parameter do in the check_increasing() function?", "input": "OpenMC Python API check_increasing() parameter value", "output": "The value parameter object to check if increasing. It should be a iterable value." }, { "instruction": "What does the equality parameter do in the check_increasing() function?", "input": "OpenMC Python API check_increasing() parameter equality", "output": "The equality parameter whether equality is allowed. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the check_value() function do in OpenMC's Python API?", "input": "OpenMC Python API check_value() function", "output": "The check_value() function ensure that an object's value is contained in a set of acceptable values. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_value() function in OpenMC's Python API?", "input": "OpenMC Python API check_value() function purpose", "output": "The check_value() function ensure that an object's value is contained in a set of acceptable values. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_value() function in OpenMC's Python API?", "input": "OpenMC Python API check_value() function signature", "output": "To call the check_value() function, use: def check_value(name: Any, value: Any, accepted_values: Any). It takes 3 parameters." }, { "instruction": "What does the name parameter do in the check_value() function?", "input": "OpenMC Python API check_value() parameter name", "output": "The name parameter description of value being checked. It should be a str value." }, { "instruction": "What does the value parameter do in the check_value() function?", "input": "OpenMC Python API check_value() parameter value", "output": "The value parameter object to check. It should be a collections.Iterable value." }, { "instruction": "What does the accepted_values parameter do in the check_value() function?", "input": "OpenMC Python API check_value() parameter accepted_values", "output": "The accepted_values parameter container of acceptable values. It should be a collections.Container value." }, { "instruction": "What does the check_less_than() function do in OpenMC's Python API?", "input": "OpenMC Python API check_less_than() function", "output": "The check_less_than() function ensure that an object's value is less than a given value. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_less_than() function in OpenMC's Python API?", "input": "OpenMC Python API check_less_than() function purpose", "output": "The check_less_than() function ensure that an object's value is less than a given value. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_less_than() function in OpenMC's Python API?", "input": "OpenMC Python API check_less_than() function signature", "output": "To call the check_less_than() function, use: def check_less_than(name: Any, value: Any, maximum: Any, equality: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the check_less_than() function?", "input": "OpenMC Python API check_less_than() parameter name", "output": "The name parameter description of the value being checked. It should be a str value." }, { "instruction": "What does the value parameter do in the check_less_than() function?", "input": "OpenMC Python API check_less_than() parameter value", "output": "The value parameter object to check. It should be a object value." }, { "instruction": "What does the maximum parameter do in the check_less_than() function?", "input": "OpenMC Python API check_less_than() parameter maximum", "output": "The maximum parameter maximum value to check against. It should be a object value." }, { "instruction": "What does the equality parameter do in the check_less_than() function?", "input": "OpenMC Python API check_less_than() parameter equality", "output": "The equality parameter whether equality is allowed. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the check_greater_than() function do in OpenMC's Python API?", "input": "OpenMC Python API check_greater_than() function", "output": "The check_greater_than() function ensure that an object's value is greater than a given value. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_greater_than() function in OpenMC's Python API?", "input": "OpenMC Python API check_greater_than() function purpose", "output": "The check_greater_than() function ensure that an object's value is greater than a given value. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_greater_than() function in OpenMC's Python API?", "input": "OpenMC Python API check_greater_than() function signature", "output": "To call the check_greater_than() function, use: def check_greater_than(name: Any, value: Any, minimum: Any, equality: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the check_greater_than() function?", "input": "OpenMC Python API check_greater_than() parameter name", "output": "The name parameter description of the value being checked. It should be a str value." }, { "instruction": "What does the value parameter do in the check_greater_than() function?", "input": "OpenMC Python API check_greater_than() parameter value", "output": "The value parameter object to check. It should be a object value." }, { "instruction": "What does the minimum parameter do in the check_greater_than() function?", "input": "OpenMC Python API check_greater_than() parameter minimum", "output": "The minimum parameter minimum value to check against. It should be a object value." }, { "instruction": "What does the equality parameter do in the check_greater_than() function?", "input": "OpenMC Python API check_greater_than() parameter equality", "output": "The equality parameter whether equality is allowed. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the check_filetype_version() function do in OpenMC's Python API?", "input": "OpenMC Python API check_filetype_version() function", "output": "The check_filetype_version() function check filetype and version of an hdf5 file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the check_filetype_version() function in OpenMC's Python API?", "input": "OpenMC Python API check_filetype_version() function purpose", "output": "The check_filetype_version() function check filetype and version of an hdf5 file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the check_filetype_version() function in OpenMC's Python API?", "input": "OpenMC Python API check_filetype_version() function signature", "output": "To call the check_filetype_version() function, use: def check_filetype_version(obj: Any, expected_type: Any, expected_version: Any). It takes 3 parameters." }, { "instruction": "What does the obj parameter do in the check_filetype_version() function?", "input": "OpenMC Python API check_filetype_version() parameter obj", "output": "The obj parameter hdf5 file to check. It should be a h5py.File value." }, { "instruction": "What does the expected_type parameter do in the check_filetype_version() function?", "input": "OpenMC Python API check_filetype_version() parameter expected_type", "output": "The expected_type parameter expected file type, e.g. 'statepoint'. It should be a str value." }, { "instruction": "What does the expected_version parameter do in the check_filetype_version() function?", "input": "OpenMC Python API check_filetype_version() parameter expected_version", "output": "The expected_version parameter expected major version number.. It should be a int value." }, { "instruction": "What is the CMFDMesh class in OpenMC's Python API?", "input": "OpenMC Python API CMFDMesh class", "output": "The CMFDMesh class represents a structured cartesian mesh used for cmfd acceleration. It provides 22 methods and 0 properties for working with cmfdmesh data in OpenMC." }, { "instruction": "What does the CMFDMesh class do in OpenMC's Python API?", "input": "OpenMC Python API CMFDMesh class description", "output": "The CMFDMesh class a structured cartesian mesh used for cmfd acceleration. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the lower_left attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute lower_left", "output": "The lower_left attribute of a CMFDMesh contains the lower-left corner of a regular structured mesh. if only two coordinates are given, it is assumed that the mesh is an x-y mesh.. It's a Iterable of float value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the upper_right attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute upper_right", "output": "The upper_right attribute of a CMFDMesh contains the upper-right corner of a regular structured mesh. if only two coordinates are given, it is assumed that the mesh is an x-y mesh.. It's a Iterable of float value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the dimension attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute dimension", "output": "The dimension attribute of a CMFDMesh contains the number of mesh cells in each direction for a regular structured mesh.. It's a Iterable of int value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the width attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute width", "output": "The width attribute of a CMFDMesh contains the width of mesh cells in each direction for a regular structured mesh. It's a Iterable of float value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the energy attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute energy", "output": "The energy attribute of a CMFDMesh contains energy bins in ev, listed in ascending order (e.g. [0.0, 0.625e-1, 20.0e6]) for cmfd tallies and acceleration. if no energy bins are listed, openmc automatically assumes a one energy group calculation over the entire energy range.. It's a Iterable of float value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the albedo attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute albedo", "output": "The albedo attribute of a CMFDMesh contains surface ratio of incoming to outgoing partial currents on global boundary conditions. they are listed in the following order: -x +x -y +y -z +z.. It's a Iterable of float value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the map attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute map", "output": "The map attribute of a CMFDMesh contains an optional acceleration map can be specified to overlay on the coarse mesh spatial grid. if this option is used, a ``0`` is used for a non-accelerated region and a ``1`` is used for an accelerated region. for a simple 4x4 coarse mesh with a 2x2 fuel lattice surrounded by reflector, the map is: :: [0, 0, 0, 0, 0, 1, 1, 0, 0, 1, 1, 0, 0, 0, 0, 0] therefore a 2x2 system of equations is solved rather than a 4x4. this is extremely important to use in reflectors as neutrons will not contribute to any tallies far away from fission source neutron regions. a ``1`` must be used to identify any fission source region.. It's a Iterable of int value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the mesh_type attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute mesh_type", "output": "The mesh_type attribute of a CMFDMesh contains type of structured mesh to use. acceptable values are: * \"regular\" - use regularmesh to define cmfd mesh * \"rectilinear\" - use rectilinearmesh to define cmfd. It's a str value that you can access after creating a CMFDMesh instance." }, { "instruction": "What is the grid attribute of a CMFDMesh?", "input": "OpenMC Python API CMFDMesh attribute grid", "output": "The grid attribute of a CMFDMesh contains grid used to define rectilinearmesh. first dimension must have length 3 where grid[0], grid[1], and grid[2] correspond to the x-, y-, and z-grids respectively. It's a Iterable of Iterable of float value that you can access after creating a CMFDMesh instance." }, { "instruction": "How do you call the __init__() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_repr() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh._get_repr() method signature", "output": "To call the _get_repr() method, use: def _get_repr(self: Any, list_var: Any, label: Any). It takes 3 parameters." }, { "instruction": "How do you call the lower_left() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dimension() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the albedo() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.albedo() method signature", "output": "To call the albedo() method, use: @property def albedo(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the map() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.map() method signature", "output": "To call the map() method, use: @property def map(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh_type() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.mesh_type() method signature", "output": "To call the mesh_type() method, use: @property def mesh_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the grid() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.grid() method signature", "output": "To call the grid() method, use: @property def grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @lower_left.setter def lower_left(self: Any, lower_left: Any). It takes 2 parameters." }, { "instruction": "How do you call the upper_right() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @upper_right.setter def upper_right(self: Any, upper_right: Any). It takes 2 parameters." }, { "instruction": "How do you call the dimension() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.dimension() method signature", "output": "To call the dimension() method, use: @dimension.setter def dimension(self: Any, dimension: Any). It takes 2 parameters." }, { "instruction": "How do you call the width() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.width() method signature", "output": "To call the width() method, use: @width.setter def width(self: Any, width: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the albedo() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.albedo() method signature", "output": "To call the albedo() method, use: @albedo.setter def albedo(self: Any, albedo: Any). It takes 2 parameters." }, { "instruction": "How do you call the map() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.map() method signature", "output": "To call the map() method, use: @map.setter def map(self: Any, mesh_map: Any). It takes 2 parameters." }, { "instruction": "How do you call the mesh_type() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.mesh_type() method signature", "output": "To call the mesh_type() method, use: @mesh_type.setter def mesh_type(self: Any, mesh_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the grid() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh.grid() method signature", "output": "To call the grid() method, use: @grid.setter def grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the _display_mesh_warning() method in the CMFDMesh class?", "input": "OpenMC Python API CMFDMesh._display_mesh_warning() method signature", "output": "To call the _display_mesh_warning() method, use: def _display_mesh_warning(self: Any, mesh_type: Any, variable_label: Any). It takes 3 parameters." }, { "instruction": "What is the CMFDRun class in OpenMC's Python API?", "input": "OpenMC Python API CMFDRun class", "output": "The CMFDRun class represents class for running cmfd acceleration through the c api. It provides 86 methods and 0 properties for working with cmfdrun data in OpenMC." }, { "instruction": "What does the CMFDRun class do in OpenMC's Python API?", "input": "OpenMC Python API CMFDRun class description", "output": "The CMFDRun class class for running cmfd acceleration through the c api. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the tally_begin attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute tally_begin", "output": "The tally_begin attribute of a CMFDRun contains batch number at which cmfd tallies should begin accumulating. It's a int value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the solver_begin attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute solver_begin", "output": "The solver_begin attribute of a CMFDRun contains batch number at which cmfd solver should start executing. It's a int value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the ref_d attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute ref_d", "output": "The ref_d attribute of a CMFDRun contains list of reference diffusion coefficients to fix cmfd parameters to. It's a list of floats value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the display attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute display", "output": "The display attribute of a CMFDRun contains dictionary indicating which cmfd results to output. note that cmfd k-effective will always be outputted. acceptable keys are: * \"balance\" - whether to output rms [%] of the residual from the neutron balance equation on cmfd tallies (bool) * \"dominance\" - whether to output the estimated dominance ratio from the cmfd iterations (bool) * \"entropy\" - whether to output the *entropy* of the cmfd predicted fission source (bool) * \"source\" - whether to output the rms [%] between the openmc fission source and cmfd fission source (bool). It's a dict value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the downscatter attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute downscatter", "output": "The downscatter attribute of a CMFDRun contains indicate whether an effective downscatter cross section should be used when using 2-group cmfd.. It's a bool value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the feedback attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute feedback", "output": "The feedback attribute of a CMFDRun contains indicate whether or not the cmfd diffusion result is used to adjust the weight of fission source neutrons on the next openmc batch. defaults to false.. It's a bool value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the cmfd_ktol attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute cmfd_ktol", "output": "The cmfd_ktol attribute of a CMFDRun contains tolerance on the eigenvalue when performing cmfd power iteration. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the mesh attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute mesh", "output": "The mesh attribute of a CMFDRun contains structured mesh to be used for acceleration. It's a openmc.cmfd.CMFDMesh value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the norm attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute norm", "output": "The norm attribute of a CMFDRun contains normalization factor applied to the cmfd fission source distribution. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the power_monitor attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute power_monitor", "output": "The power_monitor attribute of a CMFDRun contains view convergence of power iteration during cmfd acceleration. It's a bool value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the run_adjoint attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute run_adjoint", "output": "The run_adjoint attribute of a CMFDRun contains perform adjoint calculation on the last batch. It's a bool value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the w_shift attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute w_shift", "output": "The w_shift attribute of a CMFDRun contains optional wielandt shift parameter for accelerating power iterations. by default, it is very large so there is effectively no impact.. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the stol attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute stol", "output": "The stol attribute of a CMFDRun contains tolerance on the fission source when performing cmfd power iteration. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the reset attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute reset", "output": "The reset attribute of a CMFDRun contains list of batch numbers at which cmfd tallies should be reset. It's a list of int value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the write_matrices attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute write_matrices", "output": "The write_matrices attribute of a CMFDRun contains write sparse matrices that are used during cmfd acceleration (loss, production) and resultant normalized flux vector phi to file. It's a bool value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the spectral attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute spectral", "output": "The spectral attribute of a CMFDRun contains optional spectral radius that can be used to accelerate the convergence of gauss-seidel iterations during cmfd power iteration.. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the gauss_seidel_tolerance attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute gauss_seidel_tolerance", "output": "The gauss_seidel_tolerance attribute of a CMFDRun contains two parameters specifying the absolute inner tolerance and the relative inner tolerance for gauss-seidel iterations when performing cmfd.. It's a Iterable of float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the adjoint_type attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute adjoint_type", "output": "The adjoint_type attribute of a CMFDRun contains stores type of adjoint calculation that should be performed. ``run_adjoint`` must be true for an adjoint calculation to be performed. options are: * \"physical\" - create adjoint matrices from physical parameters of cmfd problem * \"math\" - create adjoint matrices mathematically as the transpose of loss and production cmfd matrices. It's a {'physical', 'math'} value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the window_type attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute window_type", "output": "The window_type attribute of a CMFDRun contains specifies type of tally window scheme to use to accumulate cmfd tallies. options are: * \"expanding\" - have an expanding window that doubles in size to give more weight to more recent tallies as more generations are simulated * \"rolling\" - have a fixed window size that aggregates tallies from the same number of previous generations tallied * \"none\" - don't use a windowing scheme so that all tallies from last time they were reset are used for the cmfd algorithm.. It's a {'expanding', 'rolling', 'none'} value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the window_size attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute window_size", "output": "The window_size attribute of a CMFDRun contains size of window to use for tally window scheme. only relevant when window_type is set to \"rolling\". It's a int value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the indices attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute indices", "output": "The indices attribute of a CMFDRun contains stores spatial and group dimensions as [nx, ny, nz, ng]. It's a numpy.ndarray value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the cmfd_src attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute cmfd_src", "output": "The cmfd_src attribute of a CMFDRun contains cmfd source distribution calculated from solving cmfd equations. It's a numpy.ndarray value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the entropy attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute entropy", "output": "The entropy attribute of a CMFDRun contains \"shannon entropy\" from cmfd fission source, stored for each generation that cmfd is invoked. It's a list of floats value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the balance attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute balance", "output": "The balance attribute of a CMFDRun contains rms of neutron balance equations, stored for each generation that cmfd is invoked. It's a list of floats value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the src_cmp attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute src_cmp", "output": "The src_cmp attribute of a CMFDRun contains rms deviation of openmc and cmfd normalized source, stored for each generation that cmfd is invoked. It's a list of floats value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the dom attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute dom", "output": "The dom attribute of a CMFDRun contains dominance ratio from solving cmfd matrix equations, stored for each generation that cmfd is invoked. It's a list of floats value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the k_cmfd attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute k_cmfd", "output": "The k_cmfd attribute of a CMFDRun contains list of cmfd k-effectives, stored for each generation that cmfd is invoked. It's a list of floats value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the time_cmfd attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute time_cmfd", "output": "The time_cmfd attribute of a CMFDRun contains time for entire cmfd calculation, in seconds. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the time_cmfdbuild attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute time_cmfdbuild", "output": "The time_cmfdbuild attribute of a CMFDRun contains time for building cmfd matrices, in seconds. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the time_cmfdsolve attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute time_cmfdsolve", "output": "The time_cmfdsolve attribute of a CMFDRun contains time for solving cmfd matrix equations, in seconds. It's a float value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the use_all_threads attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute use_all_threads", "output": "The use_all_threads attribute of a CMFDRun contains whether to use all threads allocated to openmc for cmfd solver. It's a bool value that you can access after creating a CMFDRun instance." }, { "instruction": "What is the intracomm attribute of a CMFDRun?", "input": "OpenMC Python API CMFDRun attribute intracomm", "output": "The intracomm attribute of a CMFDRun contains mpi intercommunicator for running mpi commands. It's a mpi4py.MPI.Intracomm or None value that you can access after creating a CMFDRun instance." }, { "instruction": "What does the __init__() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.__init__() method", "output": "The __init__() method constructor for cmfdrun class. default values for instance variables\n set in this method.. It's used for cmfdrun operations." }, { "instruction": "How do you call the __init__() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_begin() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.tally_begin() method signature", "output": "To call the tally_begin() method, use: @property def tally_begin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the solver_begin() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.solver_begin() method signature", "output": "To call the solver_begin() method, use: @property def solver_begin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ref_d() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.ref_d() method signature", "output": "To call the ref_d() method, use: @property def ref_d(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the display() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.display() method signature", "output": "To call the display() method, use: @property def display(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the downscatter() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.downscatter() method signature", "output": "To call the downscatter() method, use: @property def downscatter(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the feedback() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.feedback() method signature", "output": "To call the feedback() method, use: @property def feedback(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_ktol() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.cmfd_ktol() method signature", "output": "To call the cmfd_ktol() method, use: @property def cmfd_ktol(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the norm() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.norm() method signature", "output": "To call the norm() method, use: @property def norm(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the adjoint_type() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.adjoint_type() method signature", "output": "To call the adjoint_type() method, use: @property def adjoint_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the window_type() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.window_type() method signature", "output": "To call the window_type() method, use: @property def window_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the window_size() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.window_size() method signature", "output": "To call the window_size() method, use: @property def window_size(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the power_monitor() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.power_monitor() method signature", "output": "To call the power_monitor() method, use: @property def power_monitor(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the run_adjoint() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.run_adjoint() method signature", "output": "To call the run_adjoint() method, use: @property def run_adjoint(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the w_shift() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.w_shift() method signature", "output": "To call the w_shift() method, use: @property def w_shift(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the stol() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.stol() method signature", "output": "To call the stol() method, use: @property def stol(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the spectral() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.spectral() method signature", "output": "To call the spectral() method, use: @property def spectral(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the reset() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.reset() method signature", "output": "To call the reset() method, use: @property def reset(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the write_matrices() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.write_matrices() method signature", "output": "To call the write_matrices() method, use: @property def write_matrices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the gauss_seidel_tolerance() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.gauss_seidel_tolerance() method signature", "output": "To call the gauss_seidel_tolerance() method, use: @property def gauss_seidel_tolerance(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.indices() method signature", "output": "To call the indices() method, use: @property def indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the use_all_threads() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.use_all_threads() method signature", "output": "To call the use_all_threads() method, use: @property def use_all_threads(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_src() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.cmfd_src() method signature", "output": "To call the cmfd_src() method, use: @property def cmfd_src(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dom() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.dom() method signature", "output": "To call the dom() method, use: @property def dom(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the src_cmp() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.src_cmp() method signature", "output": "To call the src_cmp() method, use: @property def src_cmp(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the balance() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.balance() method signature", "output": "To call the balance() method, use: @property def balance(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the entropy() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.entropy() method signature", "output": "To call the entropy() method, use: @property def entropy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the k_cmfd() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.k_cmfd() method signature", "output": "To call the k_cmfd() method, use: @property def k_cmfd(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_begin() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.tally_begin() method signature", "output": "To call the tally_begin() method, use: @tally_begin.setter def tally_begin(self: Any, begin: Any). It takes 2 parameters." }, { "instruction": "How do you call the solver_begin() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.solver_begin() method signature", "output": "To call the solver_begin() method, use: @solver_begin.setter def solver_begin(self: Any, begin: Any). It takes 2 parameters." }, { "instruction": "How do you call the ref_d() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.ref_d() method signature", "output": "To call the ref_d() method, use: @ref_d.setter def ref_d(self: Any, diff_params: Any). It takes 2 parameters." }, { "instruction": "How do you call the display() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.display() method signature", "output": "To call the display() method, use: @display.setter def display(self: Any, display: Any). It takes 2 parameters." }, { "instruction": "How do you call the downscatter() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.downscatter() method signature", "output": "To call the downscatter() method, use: @downscatter.setter def downscatter(self: Any, downscatter: Any). It takes 2 parameters." }, { "instruction": "How do you call the feedback() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.feedback() method signature", "output": "To call the feedback() method, use: @feedback.setter def feedback(self: Any, feedback: Any). It takes 2 parameters." }, { "instruction": "How do you call the cmfd_ktol() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.cmfd_ktol() method signature", "output": "To call the cmfd_ktol() method, use: @cmfd_ktol.setter def cmfd_ktol(self: Any, cmfd_ktol: Any). It takes 2 parameters." }, { "instruction": "How do you call the mesh() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, cmfd_mesh: Any). It takes 2 parameters." }, { "instruction": "How do you call the norm() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.norm() method signature", "output": "To call the norm() method, use: @norm.setter def norm(self: Any, norm: Any). It takes 2 parameters." }, { "instruction": "How do you call the adjoint_type() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.adjoint_type() method signature", "output": "To call the adjoint_type() method, use: @adjoint_type.setter def adjoint_type(self: Any, adjoint_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the window_type() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.window_type() method signature", "output": "To call the window_type() method, use: @window_type.setter def window_type(self: Any, window_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the window_size() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.window_size() method signature", "output": "To call the window_size() method, use: @window_size.setter def window_size(self: Any, window_size: Any). It takes 2 parameters." }, { "instruction": "How do you call the power_monitor() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.power_monitor() method signature", "output": "To call the power_monitor() method, use: @power_monitor.setter def power_monitor(self: Any, power_monitor: Any). It takes 2 parameters." }, { "instruction": "How do you call the run_adjoint() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.run_adjoint() method signature", "output": "To call the run_adjoint() method, use: @run_adjoint.setter def run_adjoint(self: Any, run_adjoint: Any). It takes 2 parameters." }, { "instruction": "How do you call the w_shift() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.w_shift() method signature", "output": "To call the w_shift() method, use: @w_shift.setter def w_shift(self: Any, w_shift: Any). It takes 2 parameters." }, { "instruction": "How do you call the stol() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.stol() method signature", "output": "To call the stol() method, use: @stol.setter def stol(self: Any, stol: Any). It takes 2 parameters." }, { "instruction": "How do you call the spectral() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.spectral() method signature", "output": "To call the spectral() method, use: @spectral.setter def spectral(self: Any, spectral: Any). It takes 2 parameters." }, { "instruction": "How do you call the reset() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.reset() method signature", "output": "To call the reset() method, use: @reset.setter def reset(self: Any, reset: Any). It takes 2 parameters." }, { "instruction": "How do you call the write_matrices() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.write_matrices() method signature", "output": "To call the write_matrices() method, use: @write_matrices.setter def write_matrices(self: Any, write_matrices: Any). It takes 2 parameters." }, { "instruction": "How do you call the gauss_seidel_tolerance() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.gauss_seidel_tolerance() method signature", "output": "To call the gauss_seidel_tolerance() method, use: @gauss_seidel_tolerance.setter def gauss_seidel_tolerance(self: Any, gauss_seidel_tolerance: Any). It takes 2 parameters." }, { "instruction": "How do you call the use_all_threads() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.use_all_threads() method signature", "output": "To call the use_all_threads() method, use: @use_all_threads.setter def use_all_threads(self: Any, use_all_threads: Any). It takes 2 parameters." }, { "instruction": "What does the run() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.run() method", "output": "The run() method run openmc with coarse mesh finite difference acceleration this method is called by the user to run cmfd once instance variables of cmfdrun class are set. It's used for cmfdrun operations." }, { "instruction": "How do you call the run() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.run() method signature", "output": "To call the run() method, use: def run(self: Any). It takes 1 parameters." }, { "instruction": "What does the run_in_memory() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.run_in_memory() method", "output": "The run_in_memory() method context manager for running cmfd functions with openmc shared library functions. this function can be used with a 'with' statement to ensure the cmfdrun class is properly initialized/finalized. for example:: from openmc import cmfd cmfd_run = cmfd.cmfdrun() with cmfd_run.run_in_memory(): do_stuff_before_simulation_start() for _ in cmfd_run.iter_batches(): do_stuff_between_batches(). It's used for cmfdrun operations." }, { "instruction": "How do you call the run_in_memory() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.run_in_memory() method signature", "output": "To call the run_in_memory() method, use: @contextmanager def run_in_memory(self: Any). It takes 1 parameters." }, { "instruction": "What does the iter_batches() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.iter_batches() method", "output": "The iter_batches() method iterator over batches.\n\n this function returns a generator-iterator that allows python code to\n be run between batches when running an openmc simulation with cmfd.\n it should be used in conjunction with\n :func`openmc.cmfd.cmfdrun.run_in_memory` to ensure proper\n initialization/finalization of cmfdrun instance.. It's used for cmfdrun operations." }, { "instruction": "How do you call the iter_batches() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.iter_batches() method signature", "output": "To call the iter_batches() method, use: def iter_batches(self: Any). It takes 1 parameters." }, { "instruction": "What does the init() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.init() method", "output": "The init() method initialize cmfdrun instance by setting up cmfd parameters and\n calling :func:`openmc.lib.simulation_init`. It's used for cmfdrun operations." }, { "instruction": "How do you call the init() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.init() method signature", "output": "To call the init() method, use: def init(self: Any). It takes 1 parameters." }, { "instruction": "What does the next_batch() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.next_batch() method", "output": "The next_batch() method run next batch for cmfdrun. It's used for cmfdrun operations." }, { "instruction": "How do you call the next_batch() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.next_batch() method signature", "output": "To call the next_batch() method, use: def next_batch(self: Any). It takes 1 parameters." }, { "instruction": "What does the finalize() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.finalize() method", "output": "The finalize() method finalize simulation by calling\n :func:`openmc.lib.simulation_finalize` and print out cmfd timing\n information.. It's used for cmfdrun operations." }, { "instruction": "How do you call the finalize() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.finalize() method signature", "output": "To call the finalize() method, use: def finalize(self: Any). It takes 1 parameters." }, { "instruction": "What does the statepoint_write() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.statepoint_write() method", "output": "The statepoint_write() method write all simulation parameters to statepoint. It's used for cmfdrun operations." }, { "instruction": "How do you call the statepoint_write() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun.statepoint_write() method signature", "output": "To call the statepoint_write() method, use: def statepoint_write(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the statepoint_write() method?", "input": "OpenMC Python API CMFDRun.statepoint_write() parameter filename", "output": "The filename parameter filename of statepoint. It should be a str value." }, { "instruction": "What does the _write_cmfd_statepoint() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_cmfd_statepoint() method", "output": "The _write_cmfd_statepoint() method append all cnfd simulation parameters to existing statepoint. It's used for cmfdrun operations." }, { "instruction": "How do you call the _write_cmfd_statepoint() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_cmfd_statepoint() method signature", "output": "To call the _write_cmfd_statepoint() method, use: def _write_cmfd_statepoint(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the _write_cmfd_statepoint() method?", "input": "OpenMC Python API CMFDRun._write_cmfd_statepoint() parameter filename", "output": "The filename parameter filename of statepoint. It should be a str value." }, { "instruction": "How do you call the _initialize_linsolver() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._initialize_linsolver() method signature", "output": "To call the _initialize_linsolver() method, use: def _initialize_linsolver(self: Any). It takes 1 parameters." }, { "instruction": "What does the _write_cmfd_output() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_cmfd_output() method", "output": "The _write_cmfd_output() method write cmfd output to buffer at the end of each batch. It's used for cmfdrun operations." }, { "instruction": "How do you call the _write_cmfd_output() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_cmfd_output() method signature", "output": "To call the _write_cmfd_output() method, use: def _write_cmfd_output(self: Any). It takes 1 parameters." }, { "instruction": "What does the _write_cmfd_timing_stats() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_cmfd_timing_stats() method", "output": "The _write_cmfd_timing_stats() method write cmfd timing stats to buffer after finalizing simulation. It's used for cmfdrun operations." }, { "instruction": "How do you call the _write_cmfd_timing_stats() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_cmfd_timing_stats() method signature", "output": "To call the _write_cmfd_timing_stats() method, use: def _write_cmfd_timing_stats(self: Any). It takes 1 parameters." }, { "instruction": "What does the _configure_cmfd() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._configure_cmfd() method", "output": "The _configure_cmfd() method initialize cmfd parameters and set cmfd input variables. It's used for cmfdrun operations." }, { "instruction": "How do you call the _configure_cmfd() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._configure_cmfd() method signature", "output": "To call the _configure_cmfd() method, use: def _configure_cmfd(self: Any). It takes 1 parameters." }, { "instruction": "What does the _initialize_cmfd() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._initialize_cmfd() method", "output": "The _initialize_cmfd() method sets values of cmfd instance variables based on user input,\n separating between variables that only exist on all processes\n and those that only exist on the master process. It's used for cmfdrun operations." }, { "instruction": "How do you call the _initialize_cmfd() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._initialize_cmfd() method signature", "output": "To call the _initialize_cmfd() method, use: def _initialize_cmfd(self: Any). It takes 1 parameters." }, { "instruction": "What does the _reset_cmfd() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._reset_cmfd() method", "output": "The _reset_cmfd() method reset all cmfd parameters from statepoint. It's used for cmfdrun operations." }, { "instruction": "How do you call the _reset_cmfd() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._reset_cmfd() method signature", "output": "To call the _reset_cmfd() method, use: def _reset_cmfd(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the _reset_cmfd() method?", "input": "OpenMC Python API CMFDRun._reset_cmfd() parameter filename", "output": "The filename parameter filename of statepoint to read from. It should be a str value." }, { "instruction": "What does the _set_tally_window() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._set_tally_window() method", "output": "The _set_tally_window() method sets parameters to handle different tally window options. It's used for cmfdrun operations." }, { "instruction": "How do you call the _set_tally_window() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._set_tally_window() method signature", "output": "To call the _set_tally_window() method, use: def _set_tally_window(self: Any). It takes 1 parameters." }, { "instruction": "What does the _cmfd_init_batch() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._cmfd_init_batch() method", "output": "The _cmfd_init_batch() method handles cmfd options at the beginning of each batch. It's used for cmfdrun operations." }, { "instruction": "How do you call the _cmfd_init_batch() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._cmfd_init_batch() method signature", "output": "To call the _cmfd_init_batch() method, use: def _cmfd_init_batch(self: Any). It takes 1 parameters." }, { "instruction": "What does the _execute_cmfd() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._execute_cmfd() method", "output": "The _execute_cmfd() method runs cmfd calculation on master node. It's used for cmfdrun operations." }, { "instruction": "How do you call the _execute_cmfd() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._execute_cmfd() method signature", "output": "To call the _execute_cmfd() method, use: def _execute_cmfd(self: Any). It takes 1 parameters." }, { "instruction": "What does the _cmfd_tally_reset() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._cmfd_tally_reset() method", "output": "The _cmfd_tally_reset() method resets all cmfd tallies in memory. It's used for cmfdrun operations." }, { "instruction": "How do you call the _cmfd_tally_reset() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._cmfd_tally_reset() method signature", "output": "To call the _cmfd_tally_reset() method, use: def _cmfd_tally_reset(self: Any). It takes 1 parameters." }, { "instruction": "What does the _set_up_cmfd() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._set_up_cmfd() method", "output": "The _set_up_cmfd() method configures cmfd object for a cmfd eigenvalue calculation. It's used for cmfdrun operations." }, { "instruction": "How do you call the _set_up_cmfd() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._set_up_cmfd() method signature", "output": "To call the _set_up_cmfd() method, use: def _set_up_cmfd(self: Any). It takes 1 parameters." }, { "instruction": "What does the _cmfd_solver_execute() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._cmfd_solver_execute() method", "output": "The _cmfd_solver_execute() method sets up and runs power iteration solver for cmfd. It's used for cmfdrun operations." }, { "instruction": "How do you call the _cmfd_solver_execute() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._cmfd_solver_execute() method signature", "output": "To call the _cmfd_solver_execute() method, use: def _cmfd_solver_execute(self: Any, adjoint: Any). It takes 2 parameters." }, { "instruction": "What does the adjoint parameter do in the _cmfd_solver_execute() method?", "input": "OpenMC Python API CMFDRun._cmfd_solver_execute() parameter adjoint", "output": "The adjoint parameter whether or not to run an adjoint calculation. It should be a bool value." }, { "instruction": "What does the _write_vector() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_vector() method", "output": "The _write_vector() method write a 1-d numpy array to file and also save it in .npy format. this particular format allows users to load the variable directly in a python session with np.load(). It's used for cmfdrun operations." }, { "instruction": "How do you call the _write_vector() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_vector() method signature", "output": "To call the _write_vector() method, use: def _write_vector(self: Any, vector: Any, base_filename: Any). It takes 3 parameters." }, { "instruction": "What does the vector parameter do in the _write_vector() method?", "input": "OpenMC Python API CMFDRun._write_vector() parameter vector", "output": "The vector parameter vector that will be saved. It should be a numpy.ndarray value." }, { "instruction": "What does the base_filename parameter do in the _write_vector() method?", "input": "OpenMC Python API CMFDRun._write_vector() parameter base_filename", "output": "The base_filename parameter filename to save vector as, without any file extension at the end. vector will be saved to file [base_filename].dat and in numpy format as [base_filename].npy. It should be a str value." }, { "instruction": "What does the _write_matrix() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_matrix() method", "output": "The _write_matrix() method write a numpy matrix to file and also save it in .npz format. this particular format allows users to load the variable directly in a python session with scipy.sparse.load_npz(). It's used for cmfdrun operations." }, { "instruction": "How do you call the _write_matrix() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._write_matrix() method signature", "output": "To call the _write_matrix() method, use: def _write_matrix(self: Any, matrix: Any, base_filename: Any). It takes 3 parameters." }, { "instruction": "What does the matrix parameter do in the _write_matrix() method?", "input": "OpenMC Python API CMFDRun._write_matrix() parameter matrix", "output": "The matrix parameter sparse matrix that will be saved. It should be a scipy.sparse.spmatrix value." }, { "instruction": "What does the base_filename parameter do in the _write_matrix() method?", "input": "OpenMC Python API CMFDRun._write_matrix() parameter base_filename", "output": "The base_filename parameter filename to save matrix entries, without any file extension at the end. matrix entries will be saved to file [base_filename].dat and in scipy format as [base_filename].npz. It should be a str value." }, { "instruction": "What does the _calc_fission_source() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._calc_fission_source() method", "output": "The _calc_fission_source() method calculates cmfd fission source from cmfd flux. if a coremap is\n defined, there will be a discrepancy between the spatial indices in the\n variables ``phi`` and ``nfissxs``, so ``phi`` needs to be mapped to the\n spatial indices of the cross sections. this can be done in a vectorized\n numpy manner or with for loops. It's used for cmfdrun operations." }, { "instruction": "How do you call the _calc_fission_source() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._calc_fission_source() method signature", "output": "To call the _calc_fission_source() method, use: def _calc_fission_source(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _build_loss_matrix() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._build_loss_matrix() method signature", "output": "To call the _build_loss_matrix() method, use: def _build_loss_matrix(self: Any, adjoint: Any). It takes 2 parameters." }, { "instruction": "How do you call the _build_prod_matrix() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._build_prod_matrix() method signature", "output": "To call the _build_prod_matrix() method, use: def _build_prod_matrix(self: Any, adjoint: Any). It takes 2 parameters." }, { "instruction": "What does the _execute_power_iter() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._execute_power_iter() method", "output": "The _execute_power_iter() method main power iteration routine for the cmfd calculation. It's used for cmfdrun operations." }, { "instruction": "How do you call the _execute_power_iter() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._execute_power_iter() method signature", "output": "To call the _execute_power_iter() method, use: def _execute_power_iter(self: Any, loss: Any, prod: Any). It takes 3 parameters." }, { "instruction": "What does the loss parameter do in the _execute_power_iter() method?", "input": "OpenMC Python API CMFDRun._execute_power_iter() parameter loss", "output": "The loss parameter sparse matrix storing elements of cmfd loss matrix. It should be a scipy.sparse.spmatrix value." }, { "instruction": "What does the prod parameter do in the _execute_power_iter() method?", "input": "OpenMC Python API CMFDRun._execute_power_iter() parameter prod", "output": "The prod parameter sparse matrix storing elements of cmfd production matrix. It should be a scipy.sparse.spmatrix value." }, { "instruction": "What does the _execute_power_iter() method return in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._execute_power_iter() return value", "output": "The _execute_power_iter() method returns flux vector of cmfd problem. The return type is numpy.ndarray." }, { "instruction": "What does the _execute_power_iter() method return in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._execute_power_iter() return value", "output": "The _execute_power_iter() method returns eigenvalue of cmfd problem. The return type is float." }, { "instruction": "What does the _execute_power_iter() method return in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._execute_power_iter() return value", "output": "The _execute_power_iter() method returns dominance ratio of cmfd problem. The return type is float." }, { "instruction": "What does the _check_convergence() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._check_convergence() method", "output": "The _check_convergence() method checks the convergence of the cmfd problem. It's used for cmfdrun operations." }, { "instruction": "How do you call the _check_convergence() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._check_convergence() method signature", "output": "To call the _check_convergence() method, use: def _check_convergence(self: Any, s_n: Any, s_o: Any, k_n: Any, k_o: Any, iteration: Any, innerits: Any). It takes 7 parameters." }, { "instruction": "What does the s_n parameter do in the _check_convergence() method?", "input": "OpenMC Python API CMFDRun._check_convergence() parameter s_n", "output": "The s_n parameter source vector from current iteration. It should be a numpy.ndarray value." }, { "instruction": "What does the s_o parameter do in the _check_convergence() method?", "input": "OpenMC Python API CMFDRun._check_convergence() parameter s_o", "output": "The s_o parameter source vector from previous iteration. It should be a numpy.ndarray value." }, { "instruction": "What does the k_n parameter do in the _check_convergence() method?", "input": "OpenMC Python API CMFDRun._check_convergence() parameter k_n", "output": "The k_n parameter k-effective from current iteration. It should be a float value." }, { "instruction": "What does the k_o parameter do in the _check_convergence() method?", "input": "OpenMC Python API CMFDRun._check_convergence() parameter k_o", "output": "The k_o parameter k-effective from previous iteration. It should be a float value." }, { "instruction": "What does the iteration parameter do in the _check_convergence() method?", "input": "OpenMC Python API CMFDRun._check_convergence() parameter iteration", "output": "The iteration parameter iteration number. It should be a int value." }, { "instruction": "What does the innerits parameter do in the _check_convergence() method?", "input": "OpenMC Python API CMFDRun._check_convergence() parameter innerits", "output": "The innerits parameter number of iterations required for convergence in inner gs loop. It should be a int value." }, { "instruction": "What does the _check_convergence() method return in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._check_convergence() return value", "output": "The _check_convergence() method returns whether the power iteration has reached convergence. The return type is bool." }, { "instruction": "What does the _check_convergence() method return in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._check_convergence() return value", "output": "The _check_convergence() method returns error in source from previous iteration to current iteration, used for dominance ratio calculations. The return type is float." }, { "instruction": "What does the _set_coremap() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._set_coremap() method", "output": "The _set_coremap() method sets the core mapping information. all regions marked with zero\n are set to cmfd_noaccel, while all regions marked with 1 are set to a\n unique index that maps each fuel region to a row number when building\n cmfd matrices. It's used for cmfdrun operations." }, { "instruction": "How do you call the _set_coremap() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._set_coremap() method signature", "output": "To call the _set_coremap() method, use: def _set_coremap(self: Any). It takes 1 parameters." }, { "instruction": "What does the _compute_xs() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_xs() method", "output": "The _compute_xs() method takes cmfd tallies from openmc and computes macroscopic cross\n sections, flux, and diffusion coefficients for each mesh cell using\n a tally window scheme. It's used for cmfdrun operations." }, { "instruction": "How do you call the _compute_xs() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_xs() method signature", "output": "To call the _compute_xs() method, use: def _compute_xs(self: Any). It takes 1 parameters." }, { "instruction": "What does the _compute_effective_downscatter() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_effective_downscatter() method", "output": "The _compute_effective_downscatter() method changes downscatter rate for zero upscatter. It's used for cmfdrun operations." }, { "instruction": "How do you call the _compute_effective_downscatter() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_effective_downscatter() method signature", "output": "To call the _compute_effective_downscatter() method, use: def _compute_effective_downscatter(self: Any). It takes 1 parameters." }, { "instruction": "What does the _neutron_balance() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._neutron_balance() method", "output": "The _neutron_balance() method computes the rms neutron balance over the cmfd mesh. It's used for cmfdrun operations." }, { "instruction": "How do you call the _neutron_balance() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._neutron_balance() method signature", "output": "To call the _neutron_balance() method, use: def _neutron_balance(self: Any). It takes 1 parameters." }, { "instruction": "What does the _precompute_array_indices() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._precompute_array_indices() method", "output": "The _precompute_array_indices() method initializes cross section arrays and computes the indices\n used to populate dtilde and dhat. It's used for cmfdrun operations." }, { "instruction": "How do you call the _precompute_array_indices() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._precompute_array_indices() method signature", "output": "To call the _precompute_array_indices() method, use: def _precompute_array_indices(self: Any). It takes 1 parameters." }, { "instruction": "What does the _precompute_matrix_indices() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._precompute_matrix_indices() method", "output": "The _precompute_matrix_indices() method computes the indices and row/column data used to populate cmfd csr\n matrices. these indices are used in _build_loss_matrix and\n _build_prod_matrix.. It's used for cmfdrun operations." }, { "instruction": "How do you call the _precompute_matrix_indices() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._precompute_matrix_indices() method signature", "output": "To call the _precompute_matrix_indices() method, use: def _precompute_matrix_indices(self: Any). It takes 1 parameters." }, { "instruction": "What does the _compute_dtilde() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_dtilde() method", "output": "The _compute_dtilde() method computes the diffusion coupling coefficient using a vectorized numpy\n approach. aggregate values for the dtilde multidimensional array are\n populated by first defining values on the problem boundary, and then\n for all other regions. for indices not lying on a boundary, dtilde\n values are distinguished between regions that neighbor a reflector\n region and regions that don't neighbor a reflector. It's used for cmfdrun operations." }, { "instruction": "How do you call the _compute_dtilde() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_dtilde() method signature", "output": "To call the _compute_dtilde() method, use: def _compute_dtilde(self: Any). It takes 1 parameters." }, { "instruction": "What does the _compute_dhat() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_dhat() method", "output": "The _compute_dhat() method computes the nonlinear coupling coefficient using a vectorized numpy\n approach. aggregate values for the dhat multidimensional array are\n populated by first defining values on the problem boundary, and then\n for all other regions. for indices not lying by a boundary, dhat values\n are distinguished between regions that neighbor a reflector region and\n regions that don't neighbor a reflector. It's used for cmfdrun operations." }, { "instruction": "How do you call the _compute_dhat() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._compute_dhat() method signature", "output": "To call the _compute_dhat() method, use: def _compute_dhat(self: Any). It takes 1 parameters." }, { "instruction": "What does the _create_cmfd_tally() method do in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._create_cmfd_tally() method", "output": "The _create_cmfd_tally() method creates all tallies in-memory that are used to solve cmfd problem. It's used for cmfdrun operations." }, { "instruction": "How do you call the _create_cmfd_tally() method in the CMFDRun class?", "input": "OpenMC Python API CMFDRun._create_cmfd_tally() method signature", "output": "To call the _create_cmfd_tally() method, use: def _create_cmfd_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __init__() method in the _Config class?", "input": "OpenMC Python API _Config.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, data: Any). It takes 2 parameters." }, { "instruction": "How do you call the __getitem__() method in the _Config class?", "input": "OpenMC Python API _Config.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __delitem__() method in the _Config class?", "input": "OpenMC Python API _Config.__delitem__() method signature", "output": "To call the __delitem__() method, use: def __delitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __setitem__() method in the _Config class?", "input": "OpenMC Python API _Config.__setitem__() method signature", "output": "To call the __setitem__() method, use: def __setitem__(self: Any, key: Any, value: Any). It takes 3 parameters." }, { "instruction": "How do you call the __iter__() method in the _Config class?", "input": "OpenMC Python API _Config.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _Config class?", "input": "OpenMC Python API _Config.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _Config class?", "input": "OpenMC Python API _Config.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _set_path() method in the _Config class?", "input": "OpenMC Python API _Config._set_path() method signature", "output": "To call the _set_path() method, use: def _set_path(self: Any, key: Any, value: Any). It takes 3 parameters." }, { "instruction": "What does the patch() method do in the _Config class?", "input": "OpenMC Python API _Config.patch() method", "output": "The patch() method temporarily change a value in the configuration. It's used for _config operations." }, { "instruction": "How do you call the patch() method in the _Config class?", "input": "OpenMC Python API _Config.patch() method signature", "output": "To call the patch() method, use: @contextmanager def patch(self: Any, key: Any, value: Any). It takes 3 parameters." }, { "instruction": "What does the key parameter do in the patch() method?", "input": "OpenMC Python API _Config.patch() parameter key", "output": "The key parameter key to change. It should be a str value." }, { "instruction": "What does the value parameter do in the patch() method?", "input": "OpenMC Python API _Config.patch() parameter value", "output": "The value parameter new value. It should be a object value." }, { "instruction": "What does the _default_config() function do in OpenMC's Python API?", "input": "OpenMC Python API _default_config() function", "output": "The _default_config() function return default configuration. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _default_config() function in OpenMC's Python API?", "input": "OpenMC Python API _default_config() function purpose", "output": "The _default_config() function return default configuration. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _default_config() function in OpenMC's Python API?", "input": "OpenMC Python API _default_config() function signature", "output": "To call the _default_config() function, use: def _default_config(). It takes 0 parameters." }, { "instruction": "What is the DAGMCUniverse class in OpenMC's Python API?", "input": "OpenMC Python API DAGMCUniverse class", "output": "The DAGMCUniverse class represents a reference to a dagmc file to be used in the model. .. versionadded:: 0.13.0. It provides 26 methods and 0 properties for working with dagmcuniverse data in OpenMC." }, { "instruction": "What does the DAGMCUniverse class do in OpenMC's Python API?", "input": "OpenMC Python API DAGMCUniverse class description", "output": "The DAGMCUniverse class a reference to a dagmc file to be used in the model. .. versionadded:: 0.13.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filename parameter do when creating a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse constructor parameter filename", "output": "When creating a DAGMCUniverse, the filename parameter specifies path to the dagmc file used to represent this universe.. It should be a str value." }, { "instruction": "What does the universe_id parameter do when creating a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse constructor parameter universe_id", "output": "When creating a DAGMCUniverse, the universe_id parameter specifies unique identifier of the universe. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse constructor parameter name", "output": "When creating a DAGMCUniverse, the name parameter specifies name of the universe. if not specified, the name is the empty string.. It should be a str, optional value." }, { "instruction": "What does the auto_geom_ids parameter do when creating a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse constructor parameter auto_geom_ids", "output": "When creating a DAGMCUniverse, the auto_geom_ids parameter specifies set ids automatically on initialization (true) or report overlaps in id space between csg and dagmc (false). It should be a bool value." }, { "instruction": "What does the auto_mat_ids parameter do when creating a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse constructor parameter auto_mat_ids", "output": "When creating a DAGMCUniverse, the auto_mat_ids parameter specifies set ids automatically on initialization (true) or report overlaps in id space between openmc and uwuw materials (false). It should be a bool value." }, { "instruction": "What does the material_overrides parameter do when creating a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse constructor parameter material_overrides", "output": "When creating a DAGMCUniverse, the material_overrides parameter specifies a dictionary of material overrides. the keys are material name strings and the values are iterables of openmc.material objects. if a material name is found in the dagmc file, the material will be replaced with the openmc.material object in the value.. It should be a dict, optional value." }, { "instruction": "What is the id attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute id", "output": "The id attribute of a DAGMCUniverse contains unique identifier of the universe. It's a int value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the name attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute name", "output": "The name attribute of a DAGMCUniverse contains name of the universe. It's a str value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the filename attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute filename", "output": "The filename attribute of a DAGMCUniverse contains path to the dagmc file used to represent this universe.. It's a str value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the auto_geom_ids attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute auto_geom_ids", "output": "The auto_geom_ids attribute of a DAGMCUniverse contains set ids automatically on initialization (true) or report overlaps in id space between csg and dagmc (false). It's a bool value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the auto_mat_ids attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute auto_mat_ids", "output": "The auto_mat_ids attribute of a DAGMCUniverse contains set ids automatically on initialization (true) or report overlaps in id space between openmc and uwuw materials (false). It's a bool value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the bounding_box attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute bounding_box", "output": "The bounding_box attribute of a DAGMCUniverse contains lower-left and upper-right coordinates of an axis-aligned bounding box of the universe. .. versionadded:: 0.13.1. It's a openmc.BoundingBox value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the material_names attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute material_names", "output": "The material_names attribute of a DAGMCUniverse contains return a sorted list of materials names that are contained within the dagmc h5m file. this is useful when naming openmc.material() objects as each material name present in the dagmc h5m file must have a matching openmc.material() with the same name. .. versionadded:: 0.13.2. It's a list of str value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the n_cells attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute n_cells", "output": "The n_cells attribute of a DAGMCUniverse contains the number of cells in the dagmc model. this is the number of cells at runtime and accounts for the implicit complement whether or not is it present in the dagmc file. .. versionadded:: 0.13.2. It's a int value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the n_surfaces attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute n_surfaces", "output": "The n_surfaces attribute of a DAGMCUniverse contains the number of surfaces in the model. .. versionadded:: 0.13.2. It's a int value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the material_overrides attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute material_overrides", "output": "The material_overrides attribute of a DAGMCUniverse contains a dictionary of material overrides. keys are cell ids; values are iterables of :class:`openmc.material` objects. the material assignment of each dagmc cell id key will be replaced with the :class:`~openmc.material` object in the value. if the value contains. It's a dict value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "What is the multiple attribute of a DAGMCUniverse?", "input": "OpenMC Python API DAGMCUniverse attribute multiple", "output": "The multiple attribute of a DAGMCUniverse contains will be assigned to the corresponding instance of the cell. .. versionadded:: 0.15.1. It's a class:`~openmc.Material` objects, each Material in the list value that you can access after creating a DAGMCUniverse instance." }, { "instruction": "How do you call the __init__() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filename: cv.PathLike, universe_id: Any, name: Any, auto_geom_ids: Any, auto_mat_ids: Any, material_overrides: Any). It takes 7 parameters." }, { "instruction": "How do you call the __repr__() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filename() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.filename() method signature", "output": "To call the filename() method, use: @property def filename(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filename() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.filename() method signature", "output": "To call the filename() method, use: @filename.setter def filename(self: Any, val: cv.PathLike). It takes 2 parameters." }, { "instruction": "How do you call the material_overrides() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.material_overrides() method signature", "output": "To call the material_overrides() method, use: @property def material_overrides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the material_overrides() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.material_overrides() method signature", "output": "To call the material_overrides() method, use: @material_overrides.setter def material_overrides(self: Any, val: Any). It takes 2 parameters." }, { "instruction": "What does the replace_material_assignment() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.replace_material_assignment() method", "output": "The replace_material_assignment() method replace a material assignment within the dagmc universe. replace the material assignment of all cells filled with a material in the dagmc universe. the universe must be synchronized in an initialized model (see :meth:`~openmc.dagmcuniverse.sync_dagmc_cells`) before calling this method. .. versionadded:: 0.15.1. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the replace_material_assignment() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.replace_material_assignment() method signature", "output": "To call the replace_material_assignment() method, use: def replace_material_assignment(self: Any, material_name: str, material: openmc.Material). It takes 3 parameters." }, { "instruction": "What does the material_name parameter do in the replace_material_assignment() method?", "input": "OpenMC Python API DAGMCUniverse.replace_material_assignment() parameter material_name", "output": "The material_name parameter material name to replace. It should be a str value." }, { "instruction": "What does the material parameter do in the replace_material_assignment() method?", "input": "OpenMC Python API DAGMCUniverse.replace_material_assignment() parameter material", "output": "The material parameter material to replace the material_name with. It should be a openmc.Material value." }, { "instruction": "What does the add_material_override() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.add_material_override() method", "output": "The add_material_override() method add a material override to the universe. .. versionadded:: 0.15. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the add_material_override() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.add_material_override() method signature", "output": "To call the add_material_override() method, use: def add_material_override(self: Any, key: Any, overrides: Any). It takes 3 parameters." }, { "instruction": "What does the key parameter do in the add_material_override() method?", "input": "OpenMC Python API DAGMCUniverse.add_material_override() parameter key", "output": "The key parameter cell object or id of the cell to override. It should be a openmc.DAGMCCell or int value." }, { "instruction": "What does the value parameter do in the add_material_override() method?", "input": "OpenMC Python API DAGMCUniverse.add_material_override() parameter value", "output": "The value parameter material(s) to be applied to the cell passed as the key. It should be a openmc.Material or Iterable of openmc.Material value." }, { "instruction": "How do you call the auto_geom_ids() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.auto_geom_ids() method signature", "output": "To call the auto_geom_ids() method, use: @property def auto_geom_ids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the auto_geom_ids() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.auto_geom_ids() method signature", "output": "To call the auto_geom_ids() method, use: @auto_geom_ids.setter def auto_geom_ids(self: Any, val: Any). It takes 2 parameters." }, { "instruction": "How do you call the auto_mat_ids() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.auto_mat_ids() method signature", "output": "To call the auto_mat_ids() method, use: @property def auto_mat_ids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the auto_mat_ids() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.auto_mat_ids() method signature", "output": "To call the auto_mat_ids() method, use: @auto_mat_ids.setter def auto_mat_ids(self: Any, val: Any). It takes 2 parameters." }, { "instruction": "How do you call the material_names() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.material_names() method signature", "output": "To call the material_names() method, use: @property def material_names(self: Any). It takes 1 parameters." }, { "instruction": "What does the _n_geom_elements() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse._n_geom_elements() method", "output": "The _n_geom_elements() method helper function for retrieving the number geometric entities in a dagmc file. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the _n_geom_elements() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse._n_geom_elements() method signature", "output": "To call the _n_geom_elements() method, use: def _n_geom_elements(self: Any, geom_type: Any). It takes 2 parameters." }, { "instruction": "What does the geom_type parameter do in the _n_geom_elements() method?", "input": "OpenMC Python API DAGMCUniverse._n_geom_elements() parameter geom_type", "output": "The geom_type parameter the type of geometric entity to count. one of {'volume', 'surface'}. returns the runtime number of voumes in the dagmc model (includes implicit complement).. It should be a str value." }, { "instruction": "How do you call the n_cells() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.n_cells() method signature", "output": "To call the n_cells() method, use: @property def n_cells(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_surfaces() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.n_surfaces() method signature", "output": "To call the n_surfaces() method, use: @property def n_surfaces(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the create_xml_subelement() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.create_xml_subelement() method signature", "output": "To call the create_xml_subelement() method, use: def create_xml_subelement(self: Any, xml_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "What does the bounding_region() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.bounding_region() method", "output": "The bounding_region() method creates a either a spherical or box shaped bounding region around the dagmc geometry. .. versionadded:: 0.13.1. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the bounding_region() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.bounding_region() method signature", "output": "To call the bounding_region() method, use: def bounding_region(self: Any, bounded_type: str, boundary_type: str, starting_id: int, padding_distance: float). It takes 5 parameters." }, { "instruction": "What does the bounded_type parameter do in the bounding_region() method?", "input": "OpenMC Python API DAGMCUniverse.bounding_region() parameter bounded_type", "output": "The bounded_type parameter the type of bounding surface(s) to use when constructing the region. options include a single spherical surface (sphere) or a rectangle made from six planes (box).. It should be a str value." }, { "instruction": "What does the boundary_type parameter do in the bounding_region() method?", "input": "OpenMC Python API DAGMCUniverse.bounding_region() parameter boundary_type", "output": "The boundary_type parameter boundary condition that defines the behavior for particles hitting the surface. defaults to vacuum boundary condition. passed into the surface construction.. It should be a str value." }, { "instruction": "What does the starting_id parameter do in the bounding_region() method?", "input": "OpenMC Python API DAGMCUniverse.bounding_region() parameter starting_id", "output": "The starting_id parameter starting id of the surface(s) used in the region. for bounded_type 'box', the next 5 ids will also be used. defaults to 10000 to reduce the chance of an overlap of surface ids with the dagmc geometry.. It should be a int value." }, { "instruction": "What does the padding_distance parameter do in the bounding_region() method?", "input": "OpenMC Python API DAGMCUniverse.bounding_region() parameter padding_distance", "output": "The padding_distance parameter distance between the bounding region surfaces and the minimal bounding box. allows for the region to be larger than the dagmc geometry.. It should be a float value." }, { "instruction": "What does the bounded_universe() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.bounded_universe() method", "output": "The bounded_universe() method returns an openmc.universe filled with this dagmcuniverse and bounded with a cell. defaults to a box cell with a vacuum surface however this can be changed using the kwargs which are passed directly to dagmcuniverse.bounding_region(). It's used for dagmcuniverse operations." }, { "instruction": "How do you call the bounded_universe() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.bounded_universe() method signature", "output": "To call the bounded_universe() method, use: def bounded_universe(self: Any, bounding_cell_id: Any). It takes 2 parameters." }, { "instruction": "What does the bounding_cell_id parameter do in the bounded_universe() method?", "input": "OpenMC Python API DAGMCUniverse.bounded_universe() parameter bounding_cell_id", "output": "The bounding_cell_id parameter the cell id number to use for the bounding cell, defaults to 10000 to reduce the chance of overlapping id numbers with the dagmc geometry.. It should be a int value." }, { "instruction": "What does the from_hdf5() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.from_hdf5() method", "output": "The from_hdf5() method create dagmc universe from hdf5 group. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the from_hdf5() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API DAGMCUniverse.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the from_xml_element() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.from_xml_element() method", "output": "The from_xml_element() method generate dagmc universe from xml element. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the from_xml_element() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, mats: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API DAGMCUniverse.from_xml_element() parameter elem", "output": "The elem parameter `` element. It should be a lxml.etree._Element value." }, { "instruction": "What does the mats parameter do in the from_xml_element() method?", "input": "OpenMC Python API DAGMCUniverse.from_xml_element() parameter mats", "output": "The mats parameter dictionary mapping material id strings to :class:`openmc.material` instances (defined in :meth:`openmc.geometry.from_xml`). It should be a dict value." }, { "instruction": "What does the _partial_deepcopy() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse._partial_deepcopy() method", "output": "The _partial_deepcopy() method clone all of the openmc.dagmcuniverse object's attributes except for\n its cells, as they are copied within the clone function. this should\n only to be used within the openmc.universebase.clone() context.. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the _partial_deepcopy() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse._partial_deepcopy() method signature", "output": "To call the _partial_deepcopy() method, use: def _partial_deepcopy(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_cell() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.add_cell() method", "output": "The add_cell() method add a cell to the universe. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the add_cell() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.add_cell() method signature", "output": "To call the add_cell() method, use: def add_cell(self: Any, cell: Any). It takes 2 parameters." }, { "instruction": "What does the cell parameter do in the add_cell() method?", "input": "OpenMC Python API DAGMCUniverse.add_cell() parameter cell", "output": "The cell parameter cell to add. It should be a openmc.DAGMCCell value." }, { "instruction": "What does the remove_cell() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.remove_cell() method", "output": "The remove_cell() method remove a cell from the universe. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the remove_cell() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.remove_cell() method signature", "output": "To call the remove_cell() method, use: def remove_cell(self: Any, cell: Any). It takes 2 parameters." }, { "instruction": "What does the cell parameter do in the remove_cell() method?", "input": "OpenMC Python API DAGMCUniverse.remove_cell() parameter cell", "output": "The cell parameter cell to remove. It should be a openmc.Cell value." }, { "instruction": "What does the sync_dagmc_cells() method do in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.sync_dagmc_cells() method", "output": "The sync_dagmc_cells() method synchronize dagmc cell information between python and c api .. versionadded:: 0.15.1. It's used for dagmcuniverse operations." }, { "instruction": "How do you call the sync_dagmc_cells() method in the DAGMCUniverse class?", "input": "OpenMC Python API DAGMCUniverse.sync_dagmc_cells() method signature", "output": "To call the sync_dagmc_cells() method, use: def sync_dagmc_cells(self: Any, mats: Any). It takes 2 parameters." }, { "instruction": "What does the mats parameter do in the sync_dagmc_cells() method?", "input": "OpenMC Python API DAGMCUniverse.sync_dagmc_cells() parameter mats", "output": "The mats parameter iterable of materials to assign to the dagmc cells. It should be a iterable of openmc.Material value." }, { "instruction": "What is the DAGMCCell class in OpenMC's Python API?", "input": "OpenMC Python API DAGMCCell class", "output": "The DAGMCCell class represents a cell class for dagmc-based geometries. .. versionadded:: 0.15.1. It provides 10 methods and 0 properties for working with dagmccell data in OpenMC." }, { "instruction": "What does the DAGMCCell class do in OpenMC's Python API?", "input": "OpenMC Python API DAGMCCell class description", "output": "The DAGMCCell class a cell class for dagmc-based geometries. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the cell_id parameter do when creating a DAGMCCell?", "input": "OpenMC Python API DAGMCCell constructor parameter cell_id", "output": "When creating a DAGMCCell, the cell_id parameter specifies unique identifier for the cell. if none, an identifier will be automatically assigned.. It should be a int or None, optional value." }, { "instruction": "What does the name parameter do when creating a DAGMCCell?", "input": "OpenMC Python API DAGMCCell constructor parameter name", "output": "When creating a DAGMCCell, the name parameter specifies name of the cell.. It should be a str, optional value." }, { "instruction": "What does the fill parameter do when creating a DAGMCCell?", "input": "OpenMC Python API DAGMCCell constructor parameter fill", "output": "When creating a DAGMCCell, the fill parameter specifies material filling the cell. if none, the cell is filled with vacuum.. It should be a openmc.Material or None, optional value." }, { "instruction": "What is the DAG_parent_universe attribute of a DAGMCCell?", "input": "OpenMC Python API DAGMCCell attribute DAG_parent_universe", "output": "The DAG_parent_universe attribute of a DAGMCCell contains the parent universe of the cell.. It's a int value that you can access after creating a DAGMCCell instance." }, { "instruction": "How do you call the __init__() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, cell_id: Any, name: Any, fill: Any). It takes 4 parameters." }, { "instruction": "What does the DAG_parent_universe() method do in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.DAG_parent_universe() method", "output": "The DAG_parent_universe() method get the parent universe of the cell.. It's used for dagmccell operations." }, { "instruction": "How do you call the DAG_parent_universe() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.DAG_parent_universe() method signature", "output": "To call the DAG_parent_universe() method, use: @property def DAG_parent_universe(self: Any). It takes 1 parameters." }, { "instruction": "What does the DAG_parent_universe() method do in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.DAG_parent_universe() method", "output": "The DAG_parent_universe() method set the parent universe of the cell.. It's used for dagmccell operations." }, { "instruction": "How do you call the DAG_parent_universe() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.DAG_parent_universe() method signature", "output": "To call the DAG_parent_universe() method, use: @DAG_parent_universe.setter def DAG_parent_universe(self: Any, universe: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the get_all_cells() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.get_all_cells() method signature", "output": "To call the get_all_cells() method, use: def get_all_cells(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the get_all_universes() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.get_all_universes() method signature", "output": "To call the get_all_universes() method, use: def get_all_universes(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the clone() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, clone_materials: Any, clone_regions: Any, memo: Any). It takes 4 parameters." }, { "instruction": "How do you call the plot() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.plot() method signature", "output": "To call the plot() method, use: def plot(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the create_xml_subelement() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.create_xml_subelement() method signature", "output": "To call the create_xml_subelement() method, use: def create_xml_subelement(self: Any, xml_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the from_xml_element() method in the DAGMCCell class?", "input": "OpenMC Python API DAGMCCell.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, surfaces: Any, materials: Any, get_universe: Any). It takes 5 parameters." }, { "instruction": "How do you call the decode_str_tag() function in OpenMC's Python API?", "input": "OpenMC Python API decode_str_tag() function signature", "output": "To call the decode_str_tag() function, use: def decode_str_tag(tag_val: Any). It takes 1 parameters." }, { "instruction": "What is the Library class in OpenMC's Python API?", "input": "OpenMC Python API Library class", "output": "The Library class represents a library objects represents an ace-formatted file which may contain multiple tables with data. It provides 3 methods and 0 properties for working with library data in OpenMC." }, { "instruction": "What does the Library class do in OpenMC's Python API?", "input": "OpenMC Python API Library class description", "output": "The Library class a library objects represents an ace-formatted file which may contain multiple tables with data. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filename parameter do when creating a Library?", "input": "OpenMC Python API Library constructor parameter filename", "output": "When creating a Library, the filename parameter specifies path of the ace library file to load.. It should be a str value." }, { "instruction": "What does the table_names parameter do when creating a Library?", "input": "OpenMC Python API Library constructor parameter table_names", "output": "When creating a Library, the table_names parameter specifies tables from the file to read in. if none, reads in all of the tables. if str, reads in only the single table of a matching name.. It should be a None, str, or iterable, optional value." }, { "instruction": "What does the verbose parameter do when creating a Library?", "input": "OpenMC Python API Library constructor parameter verbose", "output": "When creating a Library, the verbose parameter specifies determines whether output is printed to the stdout when reading a library. It should be a bool, optional value." }, { "instruction": "What is the tables attribute of a Library?", "input": "OpenMC Python API Library attribute tables", "output": "The tables attribute of a Library contains list of :class:`table` instances. It's a list value that you can access after creating a Library instance." }, { "instruction": "How do you call the __init__() method in the Library class?", "input": "OpenMC Python API Library.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filename: Any, table_names: Any, verbose: Any). It takes 4 parameters." }, { "instruction": "What does the _read_binary() method do in the Library class?", "input": "OpenMC Python API Library._read_binary() method", "output": "The _read_binary() method read a binary (type 2) ace table. It's used for library operations." }, { "instruction": "How do you call the _read_binary() method in the Library class?", "input": "OpenMC Python API Library._read_binary() method signature", "output": "To call the _read_binary() method, use: def _read_binary(self: Any, ace_file: Any, table_names: Any, verbose: Any, recl_length: Any, entries: Any). It takes 6 parameters." }, { "instruction": "What does the ace_file parameter do in the _read_binary() method?", "input": "OpenMC Python API Library._read_binary() parameter ace_file", "output": "The ace_file parameter open ace file. It should be a file value." }, { "instruction": "What does the table_names parameter do in the _read_binary() method?", "input": "OpenMC Python API Library._read_binary() parameter table_names", "output": "The table_names parameter tables from the file to read in. if none, reads in all of the tables. if str, reads in only the single table of a matching name.. It should be a None, str, or iterable value." }, { "instruction": "What does the verbose parameter do in the _read_binary() method?", "input": "OpenMC Python API Library._read_binary() parameter verbose", "output": "The verbose parameter whether to display what tables are being read. defaults to false.. It should be a str, optional value." }, { "instruction": "What does the recl_length parameter do in the _read_binary() method?", "input": "OpenMC Python API Library._read_binary() parameter recl_length", "output": "The recl_length parameter fortran record length in binary file. default value is 4096 bytes.. It should be a int, optional value." }, { "instruction": "What does the entries parameter do in the _read_binary() method?", "input": "OpenMC Python API Library._read_binary() parameter entries", "output": "The entries parameter number of entries per record. the default is 512 corresponding to a record length of 4096 bytes with double precision data.. It should be a int, optional value." }, { "instruction": "What does the _read_ascii() method do in the Library class?", "input": "OpenMC Python API Library._read_ascii() method", "output": "The _read_ascii() method read an ascii (type 1) ace table. It's used for library operations." }, { "instruction": "How do you call the _read_ascii() method in the Library class?", "input": "OpenMC Python API Library._read_ascii() method signature", "output": "To call the _read_ascii() method, use: def _read_ascii(self: Any, ace_file: Any, table_names: Any, verbose: Any). It takes 4 parameters." }, { "instruction": "What does the ace_file parameter do in the _read_ascii() method?", "input": "OpenMC Python API Library._read_ascii() parameter ace_file", "output": "The ace_file parameter open ace file. It should be a file value." }, { "instruction": "What does the table_names parameter do in the _read_ascii() method?", "input": "OpenMC Python API Library._read_ascii() parameter table_names", "output": "The table_names parameter tables from the file to read in. if none, reads in all of the tables. if str, reads in only the single table of a matching name.. It should be a None, str, or iterable value." }, { "instruction": "What does the verbose parameter do in the _read_ascii() method?", "input": "OpenMC Python API Library._read_ascii() parameter verbose", "output": "The verbose parameter whether to display what tables are being read. defaults to false.. It should be a str, optional value." }, { "instruction": "What is the TableType class in OpenMC's Python API?", "input": "OpenMC Python API TableType class", "output": "The TableType class represents type of ace data table.. It provides 1 methods and 0 properties for working with tabletype data in OpenMC." }, { "instruction": "What does the TableType class do in OpenMC's Python API?", "input": "OpenMC Python API TableType class description", "output": "The TableType class type of ace data table.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the from_suffix() method do in the TableType class?", "input": "OpenMC Python API TableType.from_suffix() method", "output": "The from_suffix() method determine ace table type from a suffix. It's used for tabletype operations." }, { "instruction": "How do you call the from_suffix() method in the TableType class?", "input": "OpenMC Python API TableType.from_suffix() method signature", "output": "To call the from_suffix() method, use: @classmethod def from_suffix(cls: Any, suffix: Any). It takes 2 parameters." }, { "instruction": "What does the suffix parameter do in the from_suffix() method?", "input": "OpenMC Python API TableType.from_suffix() parameter suffix", "output": "The suffix parameter single letter ace table designator, e.g., 'c'. It should be a str value." }, { "instruction": "What is the Table class in OpenMC's Python API?", "input": "OpenMC Python API Table class", "output": "The Table class represents ace cross section table. It provides 4 methods and 0 properties for working with table data in OpenMC." }, { "instruction": "What does the Table class do in OpenMC's Python API?", "input": "OpenMC Python API Table class description", "output": "The Table class ace cross section table. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a Table?", "input": "OpenMC Python API Table constructor parameter name", "output": "When creating a Table, the name parameter specifies zaid identifier of the table, e.g. '92235.70c'.. It should be a str value." }, { "instruction": "What does the atomic_weight_ratio parameter do when creating a Table?", "input": "OpenMC Python API Table constructor parameter atomic_weight_ratio", "output": "When creating a Table, the atomic_weight_ratio parameter specifies atomic mass ratio of the target nuclide.. It should be a float value." }, { "instruction": "What does the temperature parameter do when creating a Table?", "input": "OpenMC Python API Table constructor parameter temperature", "output": "When creating a Table, the temperature parameter specifies temperature of the target nuclide in mev.. It should be a float value." }, { "instruction": "What does the pairs parameter do when creating a Table?", "input": "OpenMC Python API Table constructor parameter pairs", "output": "When creating a Table, the pairs parameter specifies 16 pairs of zaids and atomic weight ratios. used for thermal scattering tables to indicate what isotopes scattering is applied to.. It should be a list of tuple value." }, { "instruction": "What does the nxs parameter do when creating a Table?", "input": "OpenMC Python API Table constructor parameter nxs", "output": "When creating a Table, the nxs parameter specifies array that defines various lengths with in the table. It should be a numpy.ndarray value." }, { "instruction": "What does the jxs parameter do when creating a Table?", "input": "OpenMC Python API Table constructor parameter jxs", "output": "When creating a Table, the jxs parameter specifies array that gives locations in the ``xss`` array for various blocks of data. It should be a numpy.ndarray value." }, { "instruction": "What does the xss parameter do when creating a Table?", "input": "OpenMC Python API Table constructor parameter xss", "output": "When creating a Table, the xss parameter specifies raw data for the ace table. It should be a numpy.ndarray value." }, { "instruction": "What is the data_type attribute of a Table?", "input": "OpenMC Python API Table attribute data_type", "output": "The data_type attribute of a Table contains type of the ace data. It's a TableType value that you can access after creating a Table instance." }, { "instruction": "How do you call the __init__() method in the Table class?", "input": "OpenMC Python API Table.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, name: Any, atomic_weight_ratio: Any, temperature: Any, pairs: Any, nxs: Any, jxs: Any, xss: Any). It takes 8 parameters." }, { "instruction": "How do you call the zaid() method in the Table class?", "input": "OpenMC Python API Table.zaid() method signature", "output": "To call the zaid() method, use: @property def zaid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the data_type() method in the Table class?", "input": "OpenMC Python API Table.data_type() method signature", "output": "To call the data_type() method, use: @property def data_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the Table class?", "input": "OpenMC Python API Table.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_metadata() function do in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() function", "output": "The get_metadata() function return basic identifying data for a nuclide with a given zaid. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_metadata() function in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() function purpose", "output": "The get_metadata() function return basic identifying data for a nuclide with a given zaid. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_metadata() function in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() function signature", "output": "To call the get_metadata() function, use: def get_metadata(zaid: Any, metastable_scheme: Any). It takes 2 parameters." }, { "instruction": "What does the zaid parameter do in the get_metadata() function?", "input": "OpenMC Python API get_metadata() parameter zaid", "output": "The zaid parameter zaid (1000*z + a) obtained from a library. It should be a int value." }, { "instruction": "What does the metastable_scheme parameter do in the get_metadata() function?", "input": "OpenMC Python API get_metadata() parameter metastable_scheme", "output": "The metastable_scheme parameter determine how zaid identifiers are to be interpreted in the case of a metastable nuclide. because the normal zaid (=1000*z + a) does not encode metastable information, different conventions are used among different libraries. in mcnp libraries, the convention is to add 400 for a metastable nuclide except for am242m, for which 95242 is metastable and 95642 (or 1095242 in newer libraries) is the ground state. for nndc libraries, zaid is given as 1000*z + a + 100*m.. It should be a {'nndc', 'mcnp'} value." }, { "instruction": "What does the get_metadata() function return in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() return value", "output": "The get_metadata() function returns name of the table. The return type is str." }, { "instruction": "What does the get_metadata() function return in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() return value", "output": "The get_metadata() function returns the atomic symbol of the isotope in the table; e.g., zr.. The return type is str." }, { "instruction": "What does the get_metadata() function return in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() return value", "output": "The get_metadata() function returns number of protons in the nucleus. The return type is int." }, { "instruction": "What does the get_metadata() function return in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() return value", "output": "The get_metadata() function returns number of nucleons in the nucleus. The return type is int." }, { "instruction": "What does the get_metadata() function return in OpenMC's Python API?", "input": "OpenMC Python API get_metadata() return value", "output": "The get_metadata() function returns metastable state of the nucleus. a value of zero indicates ground state.. The return type is int." }, { "instruction": "What does the ascii_to_binary() function do in OpenMC's Python API?", "input": "OpenMC Python API ascii_to_binary() function", "output": "The ascii_to_binary() function convert an ace file in ascii format (type 1) to binary format (type 2). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the ascii_to_binary() function in OpenMC's Python API?", "input": "OpenMC Python API ascii_to_binary() function purpose", "output": "The ascii_to_binary() function convert an ace file in ascii format (type 1) to binary format (type 2). It's part of OpenMC's Python API." }, { "instruction": "How do you call the ascii_to_binary() function in OpenMC's Python API?", "input": "OpenMC Python API ascii_to_binary() function signature", "output": "To call the ascii_to_binary() function, use: def ascii_to_binary(ascii_file: Any, binary_file: Any). It takes 2 parameters." }, { "instruction": "What does the ascii_file parameter do in the ascii_to_binary() function?", "input": "OpenMC Python API ascii_to_binary() parameter ascii_file", "output": "The ascii_file parameter filename of ascii ace file. It should be a str value." }, { "instruction": "What does the binary_file parameter do in the ascii_to_binary() function?", "input": "OpenMC Python API ascii_to_binary() parameter binary_file", "output": "The binary_file parameter filename of binary ace file to be written. It should be a str value." }, { "instruction": "What does the get_table() function do in OpenMC's Python API?", "input": "OpenMC Python API get_table() function", "output": "The get_table() function read a single table from an ace file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_table() function in OpenMC's Python API?", "input": "OpenMC Python API get_table() function purpose", "output": "The get_table() function read a single table from an ace file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_table() function in OpenMC's Python API?", "input": "OpenMC Python API get_table() function signature", "output": "To call the get_table() function, use: def get_table(filename: Any, name: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the get_table() function?", "input": "OpenMC Python API get_table() parameter filename", "output": "The filename parameter path of the ace library to load table from. It should be a str value." }, { "instruction": "What does the name parameter do in the get_table() function?", "input": "OpenMC Python API get_table() parameter name", "output": "The name parameter name of table to load, e.g. '92235.71c'. It should be a str, optional value." }, { "instruction": "What does the get_libraries_from_xsdir() function do in OpenMC's Python API?", "input": "OpenMC Python API get_libraries_from_xsdir() function", "output": "The get_libraries_from_xsdir() function determine paths to ace files from an mcnp xsdir file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_libraries_from_xsdir() function in OpenMC's Python API?", "input": "OpenMC Python API get_libraries_from_xsdir() function purpose", "output": "The get_libraries_from_xsdir() function determine paths to ace files from an mcnp xsdir file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_libraries_from_xsdir() function in OpenMC's Python API?", "input": "OpenMC Python API get_libraries_from_xsdir() function signature", "output": "To call the get_libraries_from_xsdir() function, use: def get_libraries_from_xsdir(path: Any). It takes 1 parameters." }, { "instruction": "What does the path parameter do in the get_libraries_from_xsdir() function?", "input": "OpenMC Python API get_libraries_from_xsdir() parameter path", "output": "The path parameter path to xsdir file. It should be a str or path-like value." }, { "instruction": "What does the get_libraries_from_xsdata() function do in OpenMC's Python API?", "input": "OpenMC Python API get_libraries_from_xsdata() function", "output": "The get_libraries_from_xsdata() function determine paths to ace files from a serpent xsdata file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_libraries_from_xsdata() function in OpenMC's Python API?", "input": "OpenMC Python API get_libraries_from_xsdata() function purpose", "output": "The get_libraries_from_xsdata() function determine paths to ace files from a serpent xsdata file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_libraries_from_xsdata() function in OpenMC's Python API?", "input": "OpenMC Python API get_libraries_from_xsdata() function signature", "output": "To call the get_libraries_from_xsdata() function, use: def get_libraries_from_xsdata(path: Any). It takes 1 parameters." }, { "instruction": "What does the path parameter do in the get_libraries_from_xsdata() function?", "input": "OpenMC Python API get_libraries_from_xsdata() parameter path", "output": "The path parameter path to xsdata file. It should be a str or path-like value." }, { "instruction": "What is the AngleDistribution class in OpenMC's Python API?", "input": "OpenMC Python API AngleDistribution class", "output": "The AngleDistribution class represents angle distribution as a function of incoming energy. It provides 9 methods and 0 properties for working with angledistribution data in OpenMC." }, { "instruction": "What does the AngleDistribution class do in OpenMC's Python API?", "input": "OpenMC Python API AngleDistribution class description", "output": "The AngleDistribution class angle distribution as a function of incoming energy. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy parameter do when creating a AngleDistribution?", "input": "OpenMC Python API AngleDistribution constructor parameter energy", "output": "When creating a AngleDistribution, the energy parameter specifies incoming energies in ev at which distributions exist. It should be a Iterable of float value." }, { "instruction": "What does the mu parameter do when creating a AngleDistribution?", "input": "OpenMC Python API AngleDistribution constructor parameter mu", "output": "When creating a AngleDistribution, the mu parameter specifies distribution of scattering cosines corresponding to each incoming energy. It should be a Iterable of openmc.stats.Univariate value." }, { "instruction": "What is the energy attribute of a AngleDistribution?", "input": "OpenMC Python API AngleDistribution attribute energy", "output": "The energy attribute of a AngleDistribution contains incoming energies in ev at which distributions exist. It's a Iterable of float value that you can access after creating a AngleDistribution instance." }, { "instruction": "What is the mu attribute of a AngleDistribution?", "input": "OpenMC Python API AngleDistribution attribute mu", "output": "The mu attribute of a AngleDistribution contains distribution of scattering cosines corresponding to each incoming energy. It's a Iterable of openmc.stats.Univariate value that you can access after creating a AngleDistribution instance." }, { "instruction": "How do you call the __init__() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy: Any, mu: Any). It takes 3 parameters." }, { "instruction": "How do you call the energy() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the mu() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.mu() method signature", "output": "To call the mu() method, use: @property def mu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mu() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.mu() method signature", "output": "To call the mu() method, use: @mu.setter def mu(self: Any, mu: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.to_hdf5() method", "output": "The to_hdf5() method write angle distribution to an hdf5 group. It's used for angledistribution operations." }, { "instruction": "How do you call the to_hdf5() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API AngleDistribution.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.from_hdf5() method", "output": "The from_hdf5() method generate angular distribution from hdf5 data. It's used for angledistribution operations." }, { "instruction": "How do you call the from_hdf5() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API AngleDistribution.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.from_ace() method", "output": "The from_ace() method generate an angular distribution from ace data. It's used for angledistribution operations." }, { "instruction": "How do you call the from_ace() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, location_dist: Any, location_start: Any). It takes 4 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API AngleDistribution.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the location_dist parameter do in the from_ace() method?", "input": "OpenMC Python API AngleDistribution.from_ace() parameter location_dist", "output": "The location_dist parameter index in the xss array corresponding to the start of a block, e.g. jxs(9).. It should be a int value." }, { "instruction": "What does the location_start parameter do in the from_ace() method?", "input": "OpenMC Python API AngleDistribution.from_ace() parameter location_start", "output": "The location_start parameter index in the xss array corresponding to the start of an angle distribution array. It should be a int value." }, { "instruction": "What does the from_endf() method do in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.from_endf() method", "output": "The from_endf() method generate an angular distribution from an endf evaluation. It's used for angledistribution operations." }, { "instruction": "How do you call the from_endf() method in the AngleDistribution class?", "input": "OpenMC Python API AngleDistribution.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, mt: Any). It takes 3 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API AngleDistribution.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the mt parameter do in the from_endf() method?", "input": "OpenMC Python API AngleDistribution.from_endf() parameter mt", "output": "The mt parameter the mt value of the reaction to get angular distributions for. It should be a int value." }, { "instruction": "What is the AngleEnergy class in OpenMC's Python API?", "input": "OpenMC Python API AngleEnergy class", "output": "The AngleEnergy class represents distribution in angle and energy of a secondary particle.. It provides 3 methods and 0 properties for working with angleenergy data in OpenMC." }, { "instruction": "What does the AngleEnergy class do in OpenMC's Python API?", "input": "OpenMC Python API AngleEnergy class description", "output": "The AngleEnergy class distribution in angle and energy of a secondary particle.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the to_hdf5() method in the AngleEnergy class?", "input": "OpenMC Python API AngleEnergy.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: @abstractmethod def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the from_hdf5() method do in the AngleEnergy class?", "input": "OpenMC Python API AngleEnergy.from_hdf5() method", "output": "The from_hdf5() method generate angle-energy distribution from hdf5 data. It's used for angleenergy operations." }, { "instruction": "How do you call the from_hdf5() method in the AngleEnergy class?", "input": "OpenMC Python API AngleEnergy.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @staticmethod def from_hdf5(group: Any). It takes 1 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API AngleEnergy.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the AngleEnergy class?", "input": "OpenMC Python API AngleEnergy.from_ace() method", "output": "The from_ace() method generate an angle-energy distribution from ace data. It's used for angleenergy operations." }, { "instruction": "How do you call the from_ace() method in the AngleEnergy class?", "input": "OpenMC Python API AngleEnergy.from_ace() method signature", "output": "To call the from_ace() method, use: @staticmethod def from_ace(ace: Any, location_dist: Any, location_start: Any, rx: Any). It takes 4 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API AngleEnergy.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the location_dist parameter do in the from_ace() method?", "input": "OpenMC Python API AngleEnergy.from_ace() parameter location_dist", "output": "The location_dist parameter index in the xss array corresponding to the start of a block, e.g. jxs(11) for the the dlw block.. It should be a int value." }, { "instruction": "What does the location_start parameter do in the from_ace() method?", "input": "OpenMC Python API AngleEnergy.from_ace() parameter location_start", "output": "The location_start parameter index in the xss array corresponding to the start of an energy distribution array. It should be a int value." }, { "instruction": "What does the rx parameter do in the from_ace() method?", "input": "OpenMC Python API AngleEnergy.from_ace() parameter rx", "output": "The rx parameter reaction this energy distribution will be associated with. It should be a Reaction value." }, { "instruction": "What does the from_ace() method return in the AngleEnergy class?", "input": "OpenMC Python API AngleEnergy.from_ace() return value", "output": "The from_ace() method returns secondary angle-energy distribution. The return type is openmc.data.AngleEnergy." }, { "instruction": "What is the CorrelatedAngleEnergy class in OpenMC's Python API?", "input": "OpenMC Python API CorrelatedAngleEnergy class", "output": "The CorrelatedAngleEnergy class represents correlated angle-energy distribution. It provides 15 methods and 0 properties for working with correlatedangleenergy data in OpenMC." }, { "instruction": "What does the CorrelatedAngleEnergy class do in OpenMC's Python API?", "input": "OpenMC Python API CorrelatedAngleEnergy class description", "output": "The CorrelatedAngleEnergy class correlated angle-energy distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the breakpoints parameter do when creating a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy constructor parameter breakpoints", "output": "When creating a CorrelatedAngleEnergy, the breakpoints parameter specifies breakpoints defining interpolation regions. It should be a Iterable of int value." }, { "instruction": "What does the interpolation parameter do when creating a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy constructor parameter interpolation", "output": "When creating a CorrelatedAngleEnergy, the interpolation parameter specifies interpolation codes. It should be a Iterable of int value." }, { "instruction": "What does the energy parameter do when creating a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy constructor parameter energy", "output": "When creating a CorrelatedAngleEnergy, the energy parameter specifies incoming energies at which distributions exist. It should be a Iterable of float value." }, { "instruction": "What does the energy_out parameter do when creating a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy constructor parameter energy_out", "output": "When creating a CorrelatedAngleEnergy, the energy_out parameter specifies distribution of outgoing energies corresponding to each incoming energy. It should be a Iterable of openmc.stats.Univariate value." }, { "instruction": "What does the mu parameter do when creating a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy constructor parameter mu", "output": "When creating a CorrelatedAngleEnergy, the mu parameter specifies distribution of scattering cosine for each incoming/outgoing energy. It should be a Iterable of Iterable of openmc.stats.Univariate value." }, { "instruction": "What is the breakpoints attribute of a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy attribute breakpoints", "output": "The breakpoints attribute of a CorrelatedAngleEnergy contains breakpoints defining interpolation regions. It's a Iterable of int value that you can access after creating a CorrelatedAngleEnergy instance." }, { "instruction": "What is the interpolation attribute of a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy attribute interpolation", "output": "The interpolation attribute of a CorrelatedAngleEnergy contains interpolation codes. It's a Iterable of int value that you can access after creating a CorrelatedAngleEnergy instance." }, { "instruction": "What is the energy attribute of a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy attribute energy", "output": "The energy attribute of a CorrelatedAngleEnergy contains incoming energies at which distributions exist. It's a Iterable of float value that you can access after creating a CorrelatedAngleEnergy instance." }, { "instruction": "What is the energy_out attribute of a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy attribute energy_out", "output": "The energy_out attribute of a CorrelatedAngleEnergy contains distribution of outgoing energies corresponding to each incoming energy. It's a Iterable of openmc.stats.Univariate value that you can access after creating a CorrelatedAngleEnergy instance." }, { "instruction": "What is the mu attribute of a CorrelatedAngleEnergy?", "input": "OpenMC Python API CorrelatedAngleEnergy attribute mu", "output": "The mu attribute of a CorrelatedAngleEnergy contains distribution of scattering cosine for each incoming/outgoing energy. It's a Iterable of Iterable of openmc.stats.Univariate value that you can access after creating a CorrelatedAngleEnergy instance." }, { "instruction": "How do you call the __init__() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, breakpoints: Any, interpolation: Any, energy: Any, energy_out: Any, mu: Any). It takes 6 parameters." }, { "instruction": "How do you call the breakpoints() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.breakpoints() method signature", "output": "To call the breakpoints() method, use: @property def breakpoints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the breakpoints() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.breakpoints() method signature", "output": "To call the breakpoints() method, use: @breakpoints.setter def breakpoints(self: Any, breakpoints: Any). It takes 2 parameters." }, { "instruction": "How do you call the interpolation() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interpolation: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_out() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.energy_out() method signature", "output": "To call the energy_out() method, use: @property def energy_out(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_out() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.energy_out() method signature", "output": "To call the energy_out() method, use: @energy_out.setter def energy_out(self: Any, energy_out: Any). It takes 2 parameters." }, { "instruction": "How do you call the mu() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.mu() method signature", "output": "To call the mu() method, use: @property def mu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mu() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.mu() method signature", "output": "To call the mu() method, use: @mu.setter def mu(self: Any, mu: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for correlatedangleenergy operations." }, { "instruction": "How do you call the to_hdf5() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API CorrelatedAngleEnergy.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_hdf5() method", "output": "The from_hdf5() method generate correlated angle-energy distribution from hdf5 data. It's used for correlatedangleenergy operations." }, { "instruction": "How do you call the from_hdf5() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_ace() method", "output": "The from_ace() method generate correlated angle-energy distribution from ace data. It's used for correlatedangleenergy operations." }, { "instruction": "How do you call the from_ace() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any, ldis: Any). It takes 4 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_ace() parameter idx", "output": "The idx parameter index in xss array of the start of the energy distribution data (ldis + locc - 1). It should be a int value." }, { "instruction": "What does the ldis parameter do in the from_ace() method?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_ace() parameter ldis", "output": "The ldis parameter index in xss array of the start of the energy distribution block (e.g. jxs[11]). It should be a int value." }, { "instruction": "What does the from_endf() method do in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_endf() method", "output": "The from_endf() method generate correlated angle-energy distribution from an endf evaluation. It's used for correlatedangleenergy operations." }, { "instruction": "How do you call the from_endf() method in the CorrelatedAngleEnergy class?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any). It takes 2 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API CorrelatedAngleEnergy.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for a correlated angle-energy distribution. It should be a file-like object value." }, { "instruction": "What does the atomic_mass() function do in OpenMC's Python API?", "input": "OpenMC Python API atomic_mass() function", "output": "The atomic_mass() function return atomic mass of isotope in atomic mass units. atomic mass data comes from the `atomic mass evaluation 2020 `_. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the atomic_mass() function in OpenMC's Python API?", "input": "OpenMC Python API atomic_mass() function purpose", "output": "The atomic_mass() function return atomic mass of isotope in atomic mass units. atomic mass data comes from the `atomic mass evaluation 2020 `_. It's part of OpenMC's Python API." }, { "instruction": "How do you call the atomic_mass() function in OpenMC's Python API?", "input": "OpenMC Python API atomic_mass() function signature", "output": "To call the atomic_mass() function, use: def atomic_mass(isotope: Any). It takes 1 parameters." }, { "instruction": "What does the isotope parameter do in the atomic_mass() function?", "input": "OpenMC Python API atomic_mass() parameter isotope", "output": "The isotope parameter name of isotope, e.g., 'pu239'. It should be a str value." }, { "instruction": "What does the atomic_weight() function do in OpenMC's Python API?", "input": "OpenMC Python API atomic_weight() function", "output": "The atomic_weight() function return atomic weight of an element in atomic mass units. computes an average of the atomic mass of each of element's naturally occurring isotopes weighted by their relative abundance. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the atomic_weight() function in OpenMC's Python API?", "input": "OpenMC Python API atomic_weight() function purpose", "output": "The atomic_weight() function return atomic weight of an element in atomic mass units. computes an average of the atomic mass of each of element's naturally occurring isotopes weighted by their relative abundance. It's part of OpenMC's Python API." }, { "instruction": "How do you call the atomic_weight() function in OpenMC's Python API?", "input": "OpenMC Python API atomic_weight() function signature", "output": "To call the atomic_weight() function, use: def atomic_weight(element: Any). It takes 1 parameters." }, { "instruction": "What does the element parameter do in the atomic_weight() function?", "input": "OpenMC Python API atomic_weight() parameter element", "output": "The element parameter element symbol (e.g., 'h') or name (e.g., 'helium'). It should be a str value." }, { "instruction": "What does the half_life() function do in OpenMC's Python API?", "input": "OpenMC Python API half_life() function", "output": "The half_life() function return half-life of isotope in seconds or none if isotope is stable half-life values are from the `endf/b-viii.0 decay sublibrary `_. .. versionadded:: 0.13.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the half_life() function in OpenMC's Python API?", "input": "OpenMC Python API half_life() function purpose", "output": "The half_life() function return half-life of isotope in seconds or none if isotope is stable half-life values are from the `endf/b-viii.0 decay sublibrary `_. .. versionadded:: 0.13.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the half_life() function in OpenMC's Python API?", "input": "OpenMC Python API half_life() function signature", "output": "To call the half_life() function, use: def half_life(isotope: Any). It takes 1 parameters." }, { "instruction": "What does the isotope parameter do in the half_life() function?", "input": "OpenMC Python API half_life() parameter isotope", "output": "The isotope parameter name of isotope, e.g., 'pu239'. It should be a str value." }, { "instruction": "What does the decay_constant() function do in OpenMC's Python API?", "input": "OpenMC Python API decay_constant() function", "output": "The decay_constant() function return decay constant of isotope in [s^-1] decay constants are based on half-life values from the :func:`~openmc.data.half_life` function. when the isotope is stable, a decay constant of zero is returned. .. versionadded:: 0.13.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the decay_constant() function in OpenMC's Python API?", "input": "OpenMC Python API decay_constant() function purpose", "output": "The decay_constant() function return decay constant of isotope in [s^-1] decay constants are based on half-life values from the :func:`~openmc.data.half_life` function. when the isotope is stable, a decay constant of zero is returned. .. versionadded:: 0.13.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the decay_constant() function in OpenMC's Python API?", "input": "OpenMC Python API decay_constant() function signature", "output": "To call the decay_constant() function, use: def decay_constant(isotope: Any). It takes 1 parameters." }, { "instruction": "What does the isotope parameter do in the decay_constant() function?", "input": "OpenMC Python API decay_constant() parameter isotope", "output": "The isotope parameter name of isotope, e.g., 'pu239'. It should be a str value." }, { "instruction": "What does the water_density() function do in OpenMC's Python API?", "input": "OpenMC Python API water_density() function", "output": "The water_density() function return the density of liquid water at a given temperature and pressure. the density is calculated from a polynomial fit using equations and values from the 2012 version of the iapws-if97 formulation. only the equations for region 1 are implemented here. region 1 is limited to liquid water below 100 [mpa] with a temperature above 273.15 [k], below 623.15 [k], and below saturation. reference: international association for the properties of water and steam, \"revised release on the iapws industrial formulation 1997 for the thermodynamic properties of water and steam\", iapws r7-97(2012). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the water_density() function in OpenMC's Python API?", "input": "OpenMC Python API water_density() function purpose", "output": "The water_density() function return the density of liquid water at a given temperature and pressure. the density is calculated from a polynomial fit using equations and values from the 2012 version of the iapws-if97 formulation. only the equations for region 1 are implemented here. region 1 is limited to liquid water below 100 [mpa] with a temperature above 273.15 [k], below 623.15 [k], and below saturation. reference: international association for the properties of water and steam, \"revised release on the iapws industrial formulation 1997 for the thermodynamic properties of water and steam\", iapws r7-97(2012). It's part of OpenMC's Python API." }, { "instruction": "How do you call the water_density() function in OpenMC's Python API?", "input": "OpenMC Python API water_density() function signature", "output": "To call the water_density() function, use: def water_density(temperature: Any, pressure: Any). It takes 2 parameters." }, { "instruction": "What does the temperature parameter do in the water_density() function?", "input": "OpenMC Python API water_density() parameter temperature", "output": "The temperature parameter water temperature in units of [k]. It should be a float value." }, { "instruction": "What does the pressure parameter do in the water_density() function?", "input": "OpenMC Python API water_density() parameter pressure", "output": "The pressure parameter water pressure in units of [mpa]. It should be a float value." }, { "instruction": "What does the gnds_name() function do in OpenMC's Python API?", "input": "OpenMC Python API gnds_name() function", "output": "The gnds_name() function return nuclide name using gnds convention .. versionchanged:: 0.14.0 function name changed from ``gnd_name`` to ``gnds_name``. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the gnds_name() function in OpenMC's Python API?", "input": "OpenMC Python API gnds_name() function purpose", "output": "The gnds_name() function return nuclide name using gnds convention .. versionchanged:: 0.14.0 function name changed from ``gnd_name`` to ``gnds_name``. It's part of OpenMC's Python API." }, { "instruction": "How do you call the gnds_name() function in OpenMC's Python API?", "input": "OpenMC Python API gnds_name() function signature", "output": "To call the gnds_name() function, use: def gnds_name(Z: Any, A: Any, m: Any). It takes 3 parameters." }, { "instruction": "What does the Z parameter do in the gnds_name() function?", "input": "OpenMC Python API gnds_name() parameter Z", "output": "The Z parameter atomic number. It should be a int value." }, { "instruction": "What does the A parameter do in the gnds_name() function?", "input": "OpenMC Python API gnds_name() parameter A", "output": "The A parameter mass number. It should be a int value." }, { "instruction": "What does the m parameter do in the gnds_name() function?", "input": "OpenMC Python API gnds_name() parameter m", "output": "The m parameter metastable state. It should be a int, optional value." }, { "instruction": "How do you call the _get_element_symbol() function in OpenMC's Python API?", "input": "OpenMC Python API _get_element_symbol() function signature", "output": "To call the _get_element_symbol() function, use: def _get_element_symbol(element: str). It takes 1 parameters." }, { "instruction": "What does the isotopes() function do in OpenMC's Python API?", "input": "OpenMC Python API isotopes() function", "output": "The isotopes() function return naturally occurring isotopes and their abundances .. versionadded:: 0.12.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the isotopes() function in OpenMC's Python API?", "input": "OpenMC Python API isotopes() function purpose", "output": "The isotopes() function return naturally occurring isotopes and their abundances .. versionadded:: 0.12.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the isotopes() function in OpenMC's Python API?", "input": "OpenMC Python API isotopes() function signature", "output": "To call the isotopes() function, use: def isotopes(element: str). It takes 1 parameters." }, { "instruction": "What does the element parameter do in the isotopes() function?", "input": "OpenMC Python API isotopes() parameter element", "output": "The element parameter element symbol (e.g., 'h') or name (e.g., 'helium'). It should be a str value." }, { "instruction": "What does the zam() function do in OpenMC's Python API?", "input": "OpenMC Python API zam() function", "output": "The zam() function return tuple of (atomic number, mass number, metastable state). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the zam() function in OpenMC's Python API?", "input": "OpenMC Python API zam() function purpose", "output": "The zam() function return tuple of (atomic number, mass number, metastable state). It's part of OpenMC's Python API." }, { "instruction": "How do you call the zam() function in OpenMC's Python API?", "input": "OpenMC Python API zam() function signature", "output": "To call the zam() function, use: def zam(name: Any). It takes 1 parameters." }, { "instruction": "What does the name parameter do in the zam() function?", "input": "OpenMC Python API zam() parameter name", "output": "The name parameter name of nuclide using gnds convention, e.g., 'am242_m1'. It should be a str value." }, { "instruction": "What is the FissionProductYields class in OpenMC's Python API?", "input": "OpenMC Python API FissionProductYields class", "output": "The FissionProductYields class represents independent and cumulative fission product yields. It provides 2 methods and 0 properties for working with fissionproductyields data in OpenMC." }, { "instruction": "What does the FissionProductYields class do in OpenMC's Python API?", "input": "OpenMC Python API FissionProductYields class description", "output": "The FissionProductYields class independent and cumulative fission product yields. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the ev_or_filename parameter do when creating a FissionProductYields?", "input": "OpenMC Python API FissionProductYields constructor parameter ev_or_filename", "output": "When creating a FissionProductYields, the ev_or_filename parameter specifies endf fission product yield evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a str of openmc.data.endf.Evaluation value." }, { "instruction": "What is the cumulative attribute of a FissionProductYields?", "input": "OpenMC Python API FissionProductYields attribute cumulative", "output": "The cumulative attribute of a FissionProductYields contains cumulative yields for each tabulated energy. each item in the list is a dictionary whose keys are nuclide names and values are cumulative yields. the i-th dictionary corresponds to the i-th incident neutron energy.. It's a list of dict value that you can access after creating a FissionProductYields instance." }, { "instruction": "What is the energies attribute of a FissionProductYields?", "input": "OpenMC Python API FissionProductYields attribute energies", "output": "The energies attribute of a FissionProductYields contains energies at which fission product yields are tabulated.. It's a Iterable of float or None value that you can access after creating a FissionProductYields instance." }, { "instruction": "What is the independent attribute of a FissionProductYields?", "input": "OpenMC Python API FissionProductYields attribute independent", "output": "The independent attribute of a FissionProductYields contains independent yields for each tabulated energy. each item in the list is a dictionary whose keys are nuclide names and values are independent yields. the i-th dictionary corresponds to the i-th incident neutron energy.. It's a list of dict value that you can access after creating a FissionProductYields instance." }, { "instruction": "What is the nuclide attribute of a FissionProductYields?", "input": "OpenMC Python API FissionProductYields attribute nuclide", "output": "The nuclide attribute of a FissionProductYields contains properties of the fissioning nuclide.. It's a dict value that you can access after creating a FissionProductYields instance." }, { "instruction": "How do you call the __init__() method in the FissionProductYields class?", "input": "OpenMC Python API FissionProductYields.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, ev_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the from_endf() method do in the FissionProductYields class?", "input": "OpenMC Python API FissionProductYields.from_endf() method", "output": "The from_endf() method generate fission product yield data from an endf evaluation. It's used for fissionproductyields operations." }, { "instruction": "How do you call the from_endf() method in the FissionProductYields class?", "input": "OpenMC Python API FissionProductYields.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the ev_or_filename parameter do in the from_endf() method?", "input": "OpenMC Python API FissionProductYields.from_endf() parameter ev_or_filename", "output": "The ev_or_filename parameter endf fission product yield evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a str or openmc.data.endf.Evaluation value." }, { "instruction": "What is the DecayMode class in OpenMC's Python API?", "input": "OpenMC Python API DecayMode class", "output": "The DecayMode class represents radioactive decay mode. It provides 11 methods and 0 properties for working with decaymode data in OpenMC." }, { "instruction": "What does the DecayMode class do in OpenMC's Python API?", "input": "OpenMC Python API DecayMode class description", "output": "The DecayMode class radioactive decay mode. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the parent parameter do when creating a DecayMode?", "input": "OpenMC Python API DecayMode constructor parameter parent", "output": "When creating a DecayMode, the parent parameter specifies parent decaying nuclide. It should be a str value." }, { "instruction": "What does the modes parameter do when creating a DecayMode?", "input": "OpenMC Python API DecayMode constructor parameter modes", "output": "When creating a DecayMode, the modes parameter specifies successive decay modes. It should be a list of str value." }, { "instruction": "What does the daughter_state parameter do when creating a DecayMode?", "input": "OpenMC Python API DecayMode constructor parameter daughter_state", "output": "When creating a DecayMode, the daughter_state parameter specifies metastable state of the daughter nuclide. It should be a int value." }, { "instruction": "What does the energy parameter do when creating a DecayMode?", "input": "OpenMC Python API DecayMode constructor parameter energy", "output": "When creating a DecayMode, the energy parameter specifies total decay energy in ev available in the decay process.. It should be a uncertainties.UFloat value." }, { "instruction": "What does the branching_ratio parameter do when creating a DecayMode?", "input": "OpenMC Python API DecayMode constructor parameter branching_ratio", "output": "When creating a DecayMode, the branching_ratio parameter specifies fraction of the decay of the parent nuclide which proceeds by this mode.. It should be a uncertainties.UFloat value." }, { "instruction": "What is the branching_ratio attribute of a DecayMode?", "input": "OpenMC Python API DecayMode attribute branching_ratio", "output": "The branching_ratio attribute of a DecayMode contains fraction of the decay of the parent nuclide which proceeds by this mode.. It's a uncertainties.UFloat value that you can access after creating a DecayMode instance." }, { "instruction": "What is the daughter attribute of a DecayMode?", "input": "OpenMC Python API DecayMode attribute daughter", "output": "The daughter attribute of a DecayMode contains name of daughter nuclide produced from decay. It's a str value that you can access after creating a DecayMode instance." }, { "instruction": "What is the energy attribute of a DecayMode?", "input": "OpenMC Python API DecayMode attribute energy", "output": "The energy attribute of a DecayMode contains total decay energy in ev available in the decay process.. It's a uncertainties.UFloat value that you can access after creating a DecayMode instance." }, { "instruction": "What is the modes attribute of a DecayMode?", "input": "OpenMC Python API DecayMode attribute modes", "output": "The modes attribute of a DecayMode contains successive decay modes. It's a list of str value that you can access after creating a DecayMode instance." }, { "instruction": "What is the parent attribute of a DecayMode?", "input": "OpenMC Python API DecayMode attribute parent", "output": "The parent attribute of a DecayMode contains parent decaying nuclide. It's a str value that you can access after creating a DecayMode instance." }, { "instruction": "How do you call the __init__() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, parent: Any, modes: Any, daughter_state: Any, energy: Any, branching_ratio: Any). It takes 6 parameters." }, { "instruction": "How do you call the __repr__() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the branching_ratio() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.branching_ratio() method signature", "output": "To call the branching_ratio() method, use: @property def branching_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the branching_ratio() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.branching_ratio() method signature", "output": "To call the branching_ratio() method, use: @branching_ratio.setter def branching_ratio(self: Any, branching_ratio: Any). It takes 2 parameters." }, { "instruction": "How do you call the daughter() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.daughter() method signature", "output": "To call the daughter() method, use: @property def daughter(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the parent() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.parent() method signature", "output": "To call the parent() method, use: @property def parent(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the parent() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.parent() method signature", "output": "To call the parent() method, use: @parent.setter def parent(self: Any, parent: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the modes() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.modes() method signature", "output": "To call the modes() method, use: @property def modes(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the modes() method in the DecayMode class?", "input": "OpenMC Python API DecayMode.modes() method signature", "output": "To call the modes() method, use: @modes.setter def modes(self: Any, modes: Any). It takes 2 parameters." }, { "instruction": "What is the Decay class in OpenMC's Python API?", "input": "OpenMC Python API Decay class", "output": "The Decay class represents radioactive decay data. It provides 5 methods and 0 properties for working with decay data in OpenMC." }, { "instruction": "What does the Decay class do in OpenMC's Python API?", "input": "OpenMC Python API Decay class description", "output": "The Decay class radioactive decay data. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the ev_or_filename parameter do when creating a Decay?", "input": "OpenMC Python API Decay constructor parameter ev_or_filename", "output": "When creating a Decay, the ev_or_filename parameter specifies endf radioactive decay data evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a str of openmc.data.endf.Evaluation value." }, { "instruction": "What is the average_energies attribute of a Decay?", "input": "OpenMC Python API Decay attribute average_energies", "output": "The average_energies attribute of a Decay contains average decay energies in ev of each type of radiation for decay heat applications.. It's a dict value that you can access after creating a Decay instance." }, { "instruction": "What is the decay_constant attribute of a Decay?", "input": "OpenMC Python API Decay attribute decay_constant", "output": "The decay_constant attribute of a Decay contains decay constant in inverse seconds.. It's a uncertainties.UFloat value that you can access after creating a Decay instance." }, { "instruction": "What is the decay_energy attribute of a Decay?", "input": "OpenMC Python API Decay attribute decay_energy", "output": "The decay_energy attribute of a Decay contains average energy in [ev] per decay for decay heat applications. It's a uncertainties.UFloat value that you can access after creating a Decay instance." }, { "instruction": "What is the half_life attribute of a Decay?", "input": "OpenMC Python API Decay attribute half_life", "output": "The half_life attribute of a Decay contains half-life of the decay in seconds.. It's a uncertainties.UFloat value that you can access after creating a Decay instance." }, { "instruction": "What is the modes attribute of a Decay?", "input": "OpenMC Python API Decay attribute modes", "output": "The modes attribute of a Decay contains decay mode information for each mode of decay.. It's a list value that you can access after creating a Decay instance." }, { "instruction": "What is the nuclide attribute of a Decay?", "input": "OpenMC Python API Decay attribute nuclide", "output": "The nuclide attribute of a Decay contains dictionary describing decaying nuclide with keys 'name', 'excited_state', 'mass', 'stable', 'spin', and 'parity'.. It's a dict value that you can access after creating a Decay instance." }, { "instruction": "What is the spectra attribute of a Decay?", "input": "OpenMC Python API Decay attribute spectra", "output": "The spectra attribute of a Decay contains resulting radiation spectra for each radiation type.. It's a dict value that you can access after creating a Decay instance." }, { "instruction": "What is the sources attribute of a Decay?", "input": "OpenMC Python API Decay attribute sources", "output": "The sources attribute of a Decay contains radioactive decay source distributions represented as a dictionary mapping particle types (e.g., 'photon') to instances of :class:`openmc.stats.univariate`. .. versionadded:: 0.13.1. It's a dict value that you can access after creating a Decay instance." }, { "instruction": "How do you call the __init__() method in the Decay class?", "input": "OpenMC Python API Decay.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, ev_or_filename: Any). It takes 2 parameters." }, { "instruction": "How do you call the decay_constant() method in the Decay class?", "input": "OpenMC Python API Decay.decay_constant() method signature", "output": "To call the decay_constant() method, use: @property def decay_constant(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the decay_energy() method in the Decay class?", "input": "OpenMC Python API Decay.decay_energy() method signature", "output": "To call the decay_energy() method, use: @property def decay_energy(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_endf() method do in the Decay class?", "input": "OpenMC Python API Decay.from_endf() method", "output": "The from_endf() method generate radioactive decay data from an endf evaluation. It's used for decay operations." }, { "instruction": "How do you call the from_endf() method in the Decay class?", "input": "OpenMC Python API Decay.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the ev_or_filename parameter do in the from_endf() method?", "input": "OpenMC Python API Decay.from_endf() parameter ev_or_filename", "output": "The ev_or_filename parameter endf radioactive decay data evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a str or openmc.data.endf.Evaluation value." }, { "instruction": "What does the sources() method do in the Decay class?", "input": "OpenMC Python API Decay.sources() method", "output": "The sources() method radioactive decay source distributions. It's used for decay operations." }, { "instruction": "How do you call the sources() method in the Decay class?", "input": "OpenMC Python API Decay.sources() method signature", "output": "To call the sources() method, use: @property def sources(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_decay_modes() function do in OpenMC's Python API?", "input": "OpenMC Python API get_decay_modes() function", "output": "The get_decay_modes() function return sequence of decay modes given an endf rtyp value. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_decay_modes() function in OpenMC's Python API?", "input": "OpenMC Python API get_decay_modes() function purpose", "output": "The get_decay_modes() function return sequence of decay modes given an endf rtyp value. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_decay_modes() function in OpenMC's Python API?", "input": "OpenMC Python API get_decay_modes() function signature", "output": "To call the get_decay_modes() function, use: def get_decay_modes(value: Any). It takes 1 parameters." }, { "instruction": "What does the value parameter do in the get_decay_modes() function?", "input": "OpenMC Python API get_decay_modes() parameter value", "output": "The value parameter endf definition of sequence of decay modes. It should be a float value." }, { "instruction": "What does the decay_photon_energy() function do in OpenMC's Python API?", "input": "OpenMC Python API decay_photon_energy() function", "output": "The decay_photon_energy() function get photon energy distribution resulting from the decay of a nuclide this function relies on data stored in a depletion chain. before calling it for the first time, you need to ensure that a depletion chain has been specified in openmc.config['chain_file']. .. versionadded:: 0.13.2. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the decay_photon_energy() function in OpenMC's Python API?", "input": "OpenMC Python API decay_photon_energy() function purpose", "output": "The decay_photon_energy() function get photon energy distribution resulting from the decay of a nuclide this function relies on data stored in a depletion chain. before calling it for the first time, you need to ensure that a depletion chain has been specified in openmc.config['chain_file']. .. versionadded:: 0.13.2. It's part of OpenMC's Python API." }, { "instruction": "How do you call the decay_photon_energy() function in OpenMC's Python API?", "input": "OpenMC Python API decay_photon_energy() function signature", "output": "To call the decay_photon_energy() function, use: def decay_photon_energy(nuclide: str). It takes 1 parameters." }, { "instruction": "What does the nuclide parameter do in the decay_photon_energy() function?", "input": "OpenMC Python API decay_photon_energy() parameter nuclide", "output": "The nuclide parameter name of nuclide, e.g., 'co58'. It should be a str value." }, { "instruction": "How do you call the get_yields() function in OpenMC's Python API?", "input": "OpenMC Python API get_yields() function signature", "output": "To call the get_yields() function, use: def get_yields(file_obj: Any). It takes 1 parameters." }, { "instruction": "What does the _load_dose_icrp() function do in OpenMC's Python API?", "input": "OpenMC Python API _load_dose_icrp() function", "output": "The _load_dose_icrp() function load effective dose tables from text files. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _load_dose_icrp() function in OpenMC's Python API?", "input": "OpenMC Python API _load_dose_icrp() function purpose", "output": "The _load_dose_icrp() function load effective dose tables from text files. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _load_dose_icrp() function in OpenMC's Python API?", "input": "OpenMC Python API _load_dose_icrp() function signature", "output": "To call the _load_dose_icrp() function, use: def _load_dose_icrp(data_source: str, particle: str). It takes 2 parameters." }, { "instruction": "What does the data_source parameter do in the _load_dose_icrp() function?", "input": "OpenMC Python API _load_dose_icrp() parameter data_source", "output": "The data_source parameter the dose conversion data source to use. It should be a {'icrp74', 'icrp116'} value." }, { "instruction": "What does the particle parameter do in the _load_dose_icrp() function?", "input": "OpenMC Python API _load_dose_icrp() parameter particle", "output": "The particle parameter incident particle. It should be a {'neutron', 'photon', 'photon kerma', 'electron', 'positron'} value." }, { "instruction": "What does the dose_coefficients() function do in OpenMC's Python API?", "input": "OpenMC Python API dose_coefficients() function", "output": "The dose_coefficients() function return effective dose conversion coefficients. this function provides fluence (and air kerma) to effective or ambient dose (h*(10)) conversion coefficients for various types of external exposures based on values in icrp publications. corrected values found in a corrigendum are used rather than the values in the original report. available libraries include `icrp publication 74 ` and `icrp publication 116 `. for icrp 74 data, the photon effective dose per fluence is determined by multiplying the air kerma per fluence values (table a.1) by the effective dose per air kerma (table a.17). the neutron effective dose per fluence is found in table a.41. for icrp 116 data, the photon effective dose per fluence is found in table a.1 and the neutron effective dose per fluence is found in table a.5. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the dose_coefficients() function in OpenMC's Python API?", "input": "OpenMC Python API dose_coefficients() function purpose", "output": "The dose_coefficients() function return effective dose conversion coefficients. this function provides fluence (and air kerma) to effective or ambient dose (h*(10)) conversion coefficients for various types of external exposures based on values in icrp publications. corrected values found in a corrigendum are used rather than the values in the original report. available libraries include `icrp publication 74 ` and `icrp publication 116 `. for icrp 74 data, the photon effective dose per fluence is determined by multiplying the air kerma per fluence values (table a.1) by the effective dose per air kerma (table a.17). the neutron effective dose per fluence is found in table a.41. for icrp 116 data, the photon effective dose per fluence is found in table a.1 and the neutron effective dose per fluence is found in table a.5. It's part of OpenMC's Python API." }, { "instruction": "How do you call the dose_coefficients() function in OpenMC's Python API?", "input": "OpenMC Python API dose_coefficients() function signature", "output": "To call the dose_coefficients() function, use: def dose_coefficients(particle: Any, geometry: Any, data_source: Any). It takes 3 parameters." }, { "instruction": "What does the particle parameter do in the dose_coefficients() function?", "input": "OpenMC Python API dose_coefficients() parameter particle", "output": "The particle parameter incident particle. It should be a {'neutron', 'photon', 'photon kerma', 'electron', 'positron'} value." }, { "instruction": "What does the geometry parameter do in the dose_coefficients() function?", "input": "OpenMC Python API dose_coefficients() parameter geometry", "output": "The geometry parameter irradiation geometry assumed. refer to icrp-116 (section 3.2) for the meaning of the options here.. It should be a {'AP', 'PA', 'LLAT', 'RLAT', 'ROT', 'ISO'} value." }, { "instruction": "What does the data_source parameter do in the dose_coefficients() function?", "input": "OpenMC Python API dose_coefficients() parameter data_source", "output": "The data_source parameter the data source for the effective dose conversion coefficients.. It should be a {'icrp74', 'icrp116'} value." }, { "instruction": "What does the dose_coefficients() function return in OpenMC's Python API?", "input": "OpenMC Python API dose_coefficients() return value", "output": "The dose_coefficients() function returns energies at which dose conversion coefficients are given. The return type is numpy.ndarray." }, { "instruction": "What does the dose_coefficients() function return in OpenMC's Python API?", "input": "OpenMC Python API dose_coefficients() return value", "output": "The dose_coefficients() function returns effective dose coefficients in [psv cm^2] at provided energies. for 'photon kerma', the coefficients are given in [sv/gy].. The return type is numpy.ndarray." }, { "instruction": "What is the Evaluation class in OpenMC's Python API?", "input": "OpenMC Python API Evaluation class", "output": "The Evaluation class represents endf material evaluation with multiple files/sections. It provides 4 methods and 0 properties for working with evaluation data in OpenMC." }, { "instruction": "What does the Evaluation class do in OpenMC's Python API?", "input": "OpenMC Python API Evaluation class description", "output": "The Evaluation class endf material evaluation with multiple files/sections. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filename_or_obj parameter do when creating a Evaluation?", "input": "OpenMC Python API Evaluation constructor parameter filename_or_obj", "output": "When creating a Evaluation, the filename_or_obj parameter specifies path to endf file to read or an open file positioned at the start of an endf material. It should be a str or file-like value." }, { "instruction": "What is the info attribute of a Evaluation?", "input": "OpenMC Python API Evaluation attribute info", "output": "The info attribute of a Evaluation contains miscellaneous information about the evaluation.. It's a dict value that you can access after creating a Evaluation instance." }, { "instruction": "What is the target attribute of a Evaluation?", "input": "OpenMC Python API Evaluation attribute target", "output": "The target attribute of a Evaluation contains information about the target material, such as its mass, isomeric state, whether it's stable, and whether it's fissionable.. It's a dict value that you can access after creating a Evaluation instance." }, { "instruction": "What is the projectile attribute of a Evaluation?", "input": "OpenMC Python API Evaluation attribute projectile", "output": "The projectile attribute of a Evaluation contains information about the projectile such as its mass.. It's a dict value that you can access after creating a Evaluation instance." }, { "instruction": "What is the reaction_list attribute of a Evaluation?", "input": "OpenMC Python API Evaluation attribute reaction_list", "output": "The reaction_list attribute of a Evaluation contains list of sections in the evaluation. the entries of the tuples are the file (mf), section (mt), number of records (nc), and modification indicator (mod).. It's a list of 4-tuples value that you can access after creating a Evaluation instance." }, { "instruction": "How do you call the __init__() method in the Evaluation class?", "input": "OpenMC Python API Evaluation.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filename_or_obj: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Evaluation class?", "input": "OpenMC Python API Evaluation.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_header() method in the Evaluation class?", "input": "OpenMC Python API Evaluation._read_header() method signature", "output": "To call the _read_header() method, use: def _read_header(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the gnds_name() method in the Evaluation class?", "input": "OpenMC Python API Evaluation.gnds_name() method signature", "output": "To call the gnds_name() method, use: @property def gnds_name(self: Any). It takes 1 parameters." }, { "instruction": "What is the Tabulated2D class in OpenMC's Python API?", "input": "OpenMC Python API Tabulated2D class", "output": "The Tabulated2D class represents metadata for a two-dimensional function. this is a dummy class that is not really used other than to store the interpolation information for a two-dimensional function. once we refactor to adopt gnds-like data containers, this will probably be removed or extended. It provides 1 methods and 0 properties for working with tabulated2d data in OpenMC." }, { "instruction": "What does the Tabulated2D class do in OpenMC's Python API?", "input": "OpenMC Python API Tabulated2D class description", "output": "The Tabulated2D class metadata for a two-dimensional function. this is a dummy class that is not really used other than to store the interpolation information for a two-dimensional function. once we refactor to adopt gnds-like data containers, this will probably be removed or extended. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the breakpoints parameter do when creating a Tabulated2D?", "input": "OpenMC Python API Tabulated2D constructor parameter breakpoints", "output": "When creating a Tabulated2D, the breakpoints parameter specifies breakpoints for interpolation regions. It should be a Iterable of int value." }, { "instruction": "What does the interpolation parameter do when creating a Tabulated2D?", "input": "OpenMC Python API Tabulated2D constructor parameter interpolation", "output": "When creating a Tabulated2D, the interpolation parameter specifies interpolation scheme identification number, e.g., 3 means y is linear in ln(x).. It should be a Iterable of int value." }, { "instruction": "How do you call the __init__() method in the Tabulated2D class?", "input": "OpenMC Python API Tabulated2D.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, breakpoints: Any, interpolation: Any). It takes 3 parameters." }, { "instruction": "What does the py_float_endf() function do in OpenMC's Python API?", "input": "OpenMC Python API py_float_endf() function", "output": "The py_float_endf() function convert string of floating point number in endf to float. the endf-6 format uses an 'e-less' floating point number format, e.g. -1.23481+10. trying to convert using the float built-in won't work because of the lack of an 'e'. this function allows such strings to be converted while still allowing numbers that are not in exponential notation to be converted as well. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the py_float_endf() function in OpenMC's Python API?", "input": "OpenMC Python API py_float_endf() function purpose", "output": "The py_float_endf() function convert string of floating point number in endf to float. the endf-6 format uses an 'e-less' floating point number format, e.g. -1.23481+10. trying to convert using the float built-in won't work because of the lack of an 'e'. this function allows such strings to be converted while still allowing numbers that are not in exponential notation to be converted as well. It's part of OpenMC's Python API." }, { "instruction": "How do you call the py_float_endf() function in OpenMC's Python API?", "input": "OpenMC Python API py_float_endf() function signature", "output": "To call the py_float_endf() function, use: def py_float_endf(s: Any). It takes 1 parameters." }, { "instruction": "What does the s parameter do in the py_float_endf() function?", "input": "OpenMC Python API py_float_endf() parameter s", "output": "The s parameter floating-point number from an endf file. It should be a str value." }, { "instruction": "What does the int_endf() function do in OpenMC's Python API?", "input": "OpenMC Python API int_endf() function", "output": "The int_endf() function convert string of integer number in endf to int. the endf-6 format technically allows integers to be represented by a field of all blanks. this function acts like int(s) except when s is a string of all whitespace, in which case zero is returned. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the int_endf() function in OpenMC's Python API?", "input": "OpenMC Python API int_endf() function purpose", "output": "The int_endf() function convert string of integer number in endf to int. the endf-6 format technically allows integers to be represented by a field of all blanks. this function acts like int(s) except when s is a string of all whitespace, in which case zero is returned. It's part of OpenMC's Python API." }, { "instruction": "How do you call the int_endf() function in OpenMC's Python API?", "input": "OpenMC Python API int_endf() function signature", "output": "To call the int_endf() function, use: def int_endf(s: Any). It takes 1 parameters." }, { "instruction": "What does the s parameter do in the int_endf() function?", "input": "OpenMC Python API int_endf() parameter s", "output": "The s parameter integer or spaces. It should be a str value." }, { "instruction": "What does the get_text_record() function do in OpenMC's Python API?", "input": "OpenMC Python API get_text_record() function", "output": "The get_text_record() function return data from a text record in an endf-6 file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_text_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_text_record() function purpose", "output": "The get_text_record() function return data from a text record in an endf-6 file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_text_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_text_record() function signature", "output": "To call the get_text_record() function, use: def get_text_record(file_obj: Any). It takes 1 parameters." }, { "instruction": "What does the file_obj parameter do in the get_text_record() function?", "input": "OpenMC Python API get_text_record() parameter file_obj", "output": "The file_obj parameter endf-6 file to read from. It should be a file-like object value." }, { "instruction": "What does the get_cont_record() function do in OpenMC's Python API?", "input": "OpenMC Python API get_cont_record() function", "output": "The get_cont_record() function return data from a cont record in an endf-6 file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_cont_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_cont_record() function purpose", "output": "The get_cont_record() function return data from a cont record in an endf-6 file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_cont_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_cont_record() function signature", "output": "To call the get_cont_record() function, use: def get_cont_record(file_obj: Any, skip_c: Any). It takes 2 parameters." }, { "instruction": "What does the file_obj parameter do in the get_cont_record() function?", "input": "OpenMC Python API get_cont_record() parameter file_obj", "output": "The file_obj parameter endf-6 file to read from. It should be a file-like object value." }, { "instruction": "What does the skip_c parameter do in the get_cont_record() function?", "input": "OpenMC Python API get_cont_record() parameter skip_c", "output": "The skip_c parameter determine whether to skip the first two quantities (c1, c2) of the cont record.. It should be a bool value." }, { "instruction": "What does the get_head_record() function do in OpenMC's Python API?", "input": "OpenMC Python API get_head_record() function", "output": "The get_head_record() function return data from a head record in an endf-6 file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_head_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_head_record() function purpose", "output": "The get_head_record() function return data from a head record in an endf-6 file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_head_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_head_record() function signature", "output": "To call the get_head_record() function, use: def get_head_record(file_obj: Any). It takes 1 parameters." }, { "instruction": "What does the file_obj parameter do in the get_head_record() function?", "input": "OpenMC Python API get_head_record() parameter file_obj", "output": "The file_obj parameter endf-6 file to read from. It should be a file-like object value." }, { "instruction": "What does the get_list_record() function do in OpenMC's Python API?", "input": "OpenMC Python API get_list_record() function", "output": "The get_list_record() function return data from a list record in an endf-6 file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_list_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_list_record() function purpose", "output": "The get_list_record() function return data from a list record in an endf-6 file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_list_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_list_record() function signature", "output": "To call the get_list_record() function, use: def get_list_record(file_obj: Any). It takes 1 parameters." }, { "instruction": "What does the file_obj parameter do in the get_list_record() function?", "input": "OpenMC Python API get_list_record() parameter file_obj", "output": "The file_obj parameter endf-6 file to read from. It should be a file-like object value." }, { "instruction": "What does the get_tab1_record() function do in OpenMC's Python API?", "input": "OpenMC Python API get_tab1_record() function", "output": "The get_tab1_record() function return data from a tab1 record in an endf-6 file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_tab1_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_tab1_record() function purpose", "output": "The get_tab1_record() function return data from a tab1 record in an endf-6 file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_tab1_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_tab1_record() function signature", "output": "To call the get_tab1_record() function, use: def get_tab1_record(file_obj: Any). It takes 1 parameters." }, { "instruction": "What does the file_obj parameter do in the get_tab1_record() function?", "input": "OpenMC Python API get_tab1_record() parameter file_obj", "output": "The file_obj parameter endf-6 file to read from. It should be a file-like object value." }, { "instruction": "How do you call the get_tab2_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_tab2_record() function signature", "output": "To call the get_tab2_record() function, use: def get_tab2_record(file_obj: Any). It takes 1 parameters." }, { "instruction": "What does the get_intg_record() function do in OpenMC's Python API?", "input": "OpenMC Python API get_intg_record() function", "output": "The get_intg_record() function return data from an intg record in an endf-6 file. used to store the covariance matrix in a compact format. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_intg_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_intg_record() function purpose", "output": "The get_intg_record() function return data from an intg record in an endf-6 file. used to store the covariance matrix in a compact format. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_intg_record() function in OpenMC's Python API?", "input": "OpenMC Python API get_intg_record() function signature", "output": "To call the get_intg_record() function, use: def get_intg_record(file_obj: Any). It takes 1 parameters." }, { "instruction": "What does the file_obj parameter do in the get_intg_record() function?", "input": "OpenMC Python API get_intg_record() parameter file_obj", "output": "The file_obj parameter endf-6 file to read from. It should be a file-like object value." }, { "instruction": "What does the get_evaluations() function do in OpenMC's Python API?", "input": "OpenMC Python API get_evaluations() function", "output": "The get_evaluations() function return a list of all evaluations within an endf file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_evaluations() function in OpenMC's Python API?", "input": "OpenMC Python API get_evaluations() function purpose", "output": "The get_evaluations() function return a list of all evaluations within an endf file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_evaluations() function in OpenMC's Python API?", "input": "OpenMC Python API get_evaluations() function signature", "output": "To call the get_evaluations() function, use: def get_evaluations(filename: Any). It takes 1 parameters." }, { "instruction": "What does the filename parameter do in the get_evaluations() function?", "input": "OpenMC Python API get_evaluations() parameter filename", "output": "The filename parameter path to endf-6 formatted file. It should be a str value." }, { "instruction": "What is the EnergyDistribution class in OpenMC's Python API?", "input": "OpenMC Python API EnergyDistribution class", "output": "The EnergyDistribution class represents abstract superclass for all energy distributions.. It provides 4 methods and 0 properties for working with energydistribution data in OpenMC." }, { "instruction": "What does the EnergyDistribution class do in OpenMC's Python API?", "input": "OpenMC Python API EnergyDistribution class description", "output": "The EnergyDistribution class abstract superclass for all energy distributions.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the EnergyDistribution class?", "input": "OpenMC Python API EnergyDistribution.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the to_hdf5() method in the EnergyDistribution class?", "input": "OpenMC Python API EnergyDistribution.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: @abstractmethod def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the from_hdf5() method do in the EnergyDistribution class?", "input": "OpenMC Python API EnergyDistribution.from_hdf5() method", "output": "The from_hdf5() method generate energy distribution from hdf5 data. It's used for energydistribution operations." }, { "instruction": "How do you call the from_hdf5() method in the EnergyDistribution class?", "input": "OpenMC Python API EnergyDistribution.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @staticmethod def from_hdf5(group: Any). It takes 1 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API EnergyDistribution.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_endf() method do in the EnergyDistribution class?", "input": "OpenMC Python API EnergyDistribution.from_endf() method", "output": "The from_endf() method generate energy distribution from an endf evaluation. It's used for energydistribution operations." }, { "instruction": "How do you call the from_endf() method in the EnergyDistribution class?", "input": "OpenMC Python API EnergyDistribution.from_endf() method signature", "output": "To call the from_endf() method, use: @staticmethod def from_endf(file_obj: Any, params: Any). It takes 2 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API EnergyDistribution.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for an energy distribution.. It should be a file-like object value." }, { "instruction": "What does the params parameter do in the from_endf() method?", "input": "OpenMC Python API EnergyDistribution.from_endf() parameter params", "output": "The params parameter list of parameters at the start of the energy distribution that includes the lf value indicating what type of energy distribution is present.. It should be a list value." }, { "instruction": "What is the ArbitraryTabulated class in OpenMC's Python API?", "input": "OpenMC Python API ArbitraryTabulated class", "output": "The ArbitraryTabulated class represents arbitrary tabulated function given in endf mf=5, lf=1 represented as .. math:: f(e \\rightarrow e') = g(e \\rightarrow e'). It provides 3 methods and 0 properties for working with arbitrarytabulated data in OpenMC." }, { "instruction": "What does the ArbitraryTabulated class do in OpenMC's Python API?", "input": "OpenMC Python API ArbitraryTabulated class description", "output": "The ArbitraryTabulated class arbitrary tabulated function given in endf mf=5, lf=1 represented as .. math:: f(e \\rightarrow e') = g(e \\rightarrow e'). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy parameter do when creating a ArbitraryTabulated?", "input": "OpenMC Python API ArbitraryTabulated constructor parameter energy", "output": "When creating a ArbitraryTabulated, the energy parameter specifies array of incident neutron energies. It should be a numpy.ndarray value." }, { "instruction": "What does the pdf parameter do when creating a ArbitraryTabulated?", "input": "OpenMC Python API ArbitraryTabulated constructor parameter pdf", "output": "When creating a ArbitraryTabulated, the pdf parameter specifies tabulated outgoing energy distribution probability density functions. It should be a list of openmc.data.Tabulated1D value." }, { "instruction": "What is the energy attribute of a ArbitraryTabulated?", "input": "OpenMC Python API ArbitraryTabulated attribute energy", "output": "The energy attribute of a ArbitraryTabulated contains array of incident neutron energies. It's a numpy.ndarray value that you can access after creating a ArbitraryTabulated instance." }, { "instruction": "What is the pdf attribute of a ArbitraryTabulated?", "input": "OpenMC Python API ArbitraryTabulated attribute pdf", "output": "The pdf attribute of a ArbitraryTabulated contains tabulated outgoing energy distribution probability density functions. It's a list of openmc.data.Tabulated1D value that you can access after creating a ArbitraryTabulated instance." }, { "instruction": "How do you call the __init__() method in the ArbitraryTabulated class?", "input": "OpenMC Python API ArbitraryTabulated.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy: Any, pdf: Any). It takes 3 parameters." }, { "instruction": "How do you call the to_hdf5() method in the ArbitraryTabulated class?", "input": "OpenMC Python API ArbitraryTabulated.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the from_endf() method do in the ArbitraryTabulated class?", "input": "OpenMC Python API ArbitraryTabulated.from_endf() method", "output": "The from_endf() method generate arbitrary tabulated distribution from an endf evaluation. It's used for arbitrarytabulated operations." }, { "instruction": "How do you call the from_endf() method in the ArbitraryTabulated class?", "input": "OpenMC Python API ArbitraryTabulated.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, params: Any). It takes 3 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API ArbitraryTabulated.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for an energy distribution.. It should be a file-like object value." }, { "instruction": "What does the params parameter do in the from_endf() method?", "input": "OpenMC Python API ArbitraryTabulated.from_endf() parameter params", "output": "The params parameter list of parameters at the start of the energy distribution that includes the lf value indicating what type of energy distribution is present.. It should be a list value." }, { "instruction": "What is the GeneralEvaporation class in OpenMC's Python API?", "input": "OpenMC Python API GeneralEvaporation class", "output": "The GeneralEvaporation class represents general evaporation spectrum given in endf mf=5, lf=5 represented as .. math:: f(e \\rightarrow e') = g(e'/\\theta(e)). It provides 4 methods and 0 properties for working with generalevaporation data in OpenMC." }, { "instruction": "What does the GeneralEvaporation class do in OpenMC's Python API?", "input": "OpenMC Python API GeneralEvaporation class description", "output": "The GeneralEvaporation class general evaporation spectrum given in endf mf=5, lf=5 represented as .. math:: f(e \\rightarrow e') = g(e'/\\theta(e)). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the theta parameter do when creating a GeneralEvaporation?", "input": "OpenMC Python API GeneralEvaporation constructor parameter theta", "output": "When creating a GeneralEvaporation, the theta parameter specifies tabulated function of incident neutron energy :math:`e`. It should be a openmc.data.Tabulated1D value." }, { "instruction": "What does the g parameter do when creating a GeneralEvaporation?", "input": "OpenMC Python API GeneralEvaporation constructor parameter g", "output": "When creating a GeneralEvaporation, the g parameter specifies tabulated function of :math:`x = e'/\\theta(e)`. It should be a openmc.data.Tabulated1D value." }, { "instruction": "What does the u parameter do when creating a GeneralEvaporation?", "input": "OpenMC Python API GeneralEvaporation constructor parameter u", "output": "When creating a GeneralEvaporation, the u parameter specifies constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It should be a float value." }, { "instruction": "What is the theta attribute of a GeneralEvaporation?", "input": "OpenMC Python API GeneralEvaporation attribute theta", "output": "The theta attribute of a GeneralEvaporation contains tabulated function of incident neutron energy :math:`e`. It's a openmc.data.Tabulated1D value that you can access after creating a GeneralEvaporation instance." }, { "instruction": "What is the g attribute of a GeneralEvaporation?", "input": "OpenMC Python API GeneralEvaporation attribute g", "output": "The g attribute of a GeneralEvaporation contains tabulated function of :math:`x = e'/\\theta(e)`. It's a openmc.data.Tabulated1D value that you can access after creating a GeneralEvaporation instance." }, { "instruction": "What is the u attribute of a GeneralEvaporation?", "input": "OpenMC Python API GeneralEvaporation attribute u", "output": "The u attribute of a GeneralEvaporation contains constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It's a float value that you can access after creating a GeneralEvaporation instance." }, { "instruction": "How do you call the __init__() method in the GeneralEvaporation class?", "input": "OpenMC Python API GeneralEvaporation.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, theta: Any, g: Any, u: Any). It takes 4 parameters." }, { "instruction": "How do you call the to_hdf5() method in the GeneralEvaporation class?", "input": "OpenMC Python API GeneralEvaporation.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_ace() method in the GeneralEvaporation class?", "input": "OpenMC Python API GeneralEvaporation.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the from_endf() method do in the GeneralEvaporation class?", "input": "OpenMC Python API GeneralEvaporation.from_endf() method", "output": "The from_endf() method generate general evaporation spectrum from an endf evaluation. It's used for generalevaporation operations." }, { "instruction": "How do you call the from_endf() method in the GeneralEvaporation class?", "input": "OpenMC Python API GeneralEvaporation.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, params: Any). It takes 3 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API GeneralEvaporation.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for an energy distribution.. It should be a file-like object value." }, { "instruction": "What does the params parameter do in the from_endf() method?", "input": "OpenMC Python API GeneralEvaporation.from_endf() parameter params", "output": "The params parameter list of parameters at the start of the energy distribution that includes the lf value indicating what type of energy distribution is present.. It should be a list value." }, { "instruction": "What is the MaxwellEnergy class in OpenMC's Python API?", "input": "OpenMC Python API MaxwellEnergy class", "output": "The MaxwellEnergy class represents simple maxwellian fission spectrum represented as .. math:: f(e \\rightarrow e') = \\frac{\\sqrt{e'}}{i} e^{-e'/\\theta(e)}. It provides 9 methods and 0 properties for working with maxwellenergy data in OpenMC." }, { "instruction": "What does the MaxwellEnergy class do in OpenMC's Python API?", "input": "OpenMC Python API MaxwellEnergy class description", "output": "The MaxwellEnergy class simple maxwellian fission spectrum represented as .. math:: f(e \\rightarrow e') = \\frac{\\sqrt{e'}}{i} e^{-e'/\\theta(e)}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the theta parameter do when creating a MaxwellEnergy?", "input": "OpenMC Python API MaxwellEnergy constructor parameter theta", "output": "When creating a MaxwellEnergy, the theta parameter specifies tabulated function of incident neutron energy. It should be a openmc.data.Tabulated1D value." }, { "instruction": "What does the u parameter do when creating a MaxwellEnergy?", "input": "OpenMC Python API MaxwellEnergy constructor parameter u", "output": "When creating a MaxwellEnergy, the u parameter specifies constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It should be a float value." }, { "instruction": "What is the theta attribute of a MaxwellEnergy?", "input": "OpenMC Python API MaxwellEnergy attribute theta", "output": "The theta attribute of a MaxwellEnergy contains tabulated function of incident neutron energy. It's a openmc.data.Tabulated1D value that you can access after creating a MaxwellEnergy instance." }, { "instruction": "What is the u attribute of a MaxwellEnergy?", "input": "OpenMC Python API MaxwellEnergy attribute u", "output": "The u attribute of a MaxwellEnergy contains constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It's a float value that you can access after creating a MaxwellEnergy instance." }, { "instruction": "How do you call the __init__() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, theta: Any, u: Any). It takes 3 parameters." }, { "instruction": "How do you call the theta() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.theta() method signature", "output": "To call the theta() method, use: @property def theta(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the theta() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.theta() method signature", "output": "To call the theta() method, use: @theta.setter def theta(self: Any, theta: Any). It takes 2 parameters." }, { "instruction": "How do you call the u() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.u() method signature", "output": "To call the u() method, use: @property def u(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the u() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.u() method signature", "output": "To call the u() method, use: @u.setter def u(self: Any, u: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for maxwellenergy operations." }, { "instruction": "How do you call the to_hdf5() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API MaxwellEnergy.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.from_hdf5() method", "output": "The from_hdf5() method generate maxwell distribution from hdf5 data. It's used for maxwellenergy operations." }, { "instruction": "How do you call the from_hdf5() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API MaxwellEnergy.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.from_ace() method", "output": "The from_ace() method create a maxwell distribution from an ace table. It's used for maxwellenergy operations." }, { "instruction": "How do you call the from_ace() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API MaxwellEnergy.from_ace() parameter ace", "output": "The ace parameter an ace table. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API MaxwellEnergy.from_ace() parameter idx", "output": "The idx parameter offset to read from in xss array (default of zero). It should be a int value." }, { "instruction": "What does the from_endf() method do in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.from_endf() method", "output": "The from_endf() method generate maxwell distribution from an endf evaluation. It's used for maxwellenergy operations." }, { "instruction": "How do you call the from_endf() method in the MaxwellEnergy class?", "input": "OpenMC Python API MaxwellEnergy.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, params: Any). It takes 3 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API MaxwellEnergy.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for an energy distribution.. It should be a file-like object value." }, { "instruction": "What does the params parameter do in the from_endf() method?", "input": "OpenMC Python API MaxwellEnergy.from_endf() parameter params", "output": "The params parameter list of parameters at the start of the energy distribution that includes the lf value indicating what type of energy distribution is present.. It should be a list value." }, { "instruction": "What is the Evaporation class in OpenMC's Python API?", "input": "OpenMC Python API Evaporation class", "output": "The Evaporation class represents evaporation spectrum represented as .. math:: f(e \\rightarrow e') = \\frac{e'}{i} e^{-e'/\\theta(e)}. It provides 9 methods and 0 properties for working with evaporation data in OpenMC." }, { "instruction": "What does the Evaporation class do in OpenMC's Python API?", "input": "OpenMC Python API Evaporation class description", "output": "The Evaporation class evaporation spectrum represented as .. math:: f(e \\rightarrow e') = \\frac{e'}{i} e^{-e'/\\theta(e)}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the theta parameter do when creating a Evaporation?", "input": "OpenMC Python API Evaporation constructor parameter theta", "output": "When creating a Evaporation, the theta parameter specifies tabulated function of incident neutron energy. It should be a openmc.data.Tabulated1D value." }, { "instruction": "What does the u parameter do when creating a Evaporation?", "input": "OpenMC Python API Evaporation constructor parameter u", "output": "When creating a Evaporation, the u parameter specifies constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It should be a float value." }, { "instruction": "What is the theta attribute of a Evaporation?", "input": "OpenMC Python API Evaporation attribute theta", "output": "The theta attribute of a Evaporation contains tabulated function of incident neutron energy. It's a openmc.data.Tabulated1D value that you can access after creating a Evaporation instance." }, { "instruction": "What is the u attribute of a Evaporation?", "input": "OpenMC Python API Evaporation attribute u", "output": "The u attribute of a Evaporation contains constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It's a float value that you can access after creating a Evaporation instance." }, { "instruction": "How do you call the __init__() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, theta: Any, u: Any). It takes 3 parameters." }, { "instruction": "How do you call the theta() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.theta() method signature", "output": "To call the theta() method, use: @property def theta(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the theta() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.theta() method signature", "output": "To call the theta() method, use: @theta.setter def theta(self: Any, theta: Any). It takes 2 parameters." }, { "instruction": "How do you call the u() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.u() method signature", "output": "To call the u() method, use: @property def u(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the u() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.u() method signature", "output": "To call the u() method, use: @u.setter def u(self: Any, u: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the Evaporation class?", "input": "OpenMC Python API Evaporation.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for evaporation operations." }, { "instruction": "How do you call the to_hdf5() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API Evaporation.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the Evaporation class?", "input": "OpenMC Python API Evaporation.from_hdf5() method", "output": "The from_hdf5() method generate evaporation spectrum from hdf5 data. It's used for evaporation operations." }, { "instruction": "How do you call the from_hdf5() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Evaporation.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the Evaporation class?", "input": "OpenMC Python API Evaporation.from_ace() method", "output": "The from_ace() method create an evaporation spectrum from an ace table. It's used for evaporation operations." }, { "instruction": "How do you call the from_ace() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API Evaporation.from_ace() parameter ace", "output": "The ace parameter an ace table. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API Evaporation.from_ace() parameter idx", "output": "The idx parameter offset to read from in xss array (default of zero). It should be a int value." }, { "instruction": "What does the from_endf() method do in the Evaporation class?", "input": "OpenMC Python API Evaporation.from_endf() method", "output": "The from_endf() method generate evaporation spectrum from an endf evaluation. It's used for evaporation operations." }, { "instruction": "How do you call the from_endf() method in the Evaporation class?", "input": "OpenMC Python API Evaporation.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, params: Any). It takes 3 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API Evaporation.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for an energy distribution.. It should be a file-like object value." }, { "instruction": "What does the params parameter do in the from_endf() method?", "input": "OpenMC Python API Evaporation.from_endf() parameter params", "output": "The params parameter list of parameters at the start of the energy distribution that includes the lf value indicating what type of energy distribution is present.. It should be a list value." }, { "instruction": "What is the WattEnergy class in OpenMC's Python API?", "input": "OpenMC Python API WattEnergy class", "output": "The WattEnergy class represents energy-dependent watt spectrum represented as .. math:: f(e \\rightarrow e') = \\frac{e^{-e'/a}}{i} \\sinh \\left ( \\sqrt{be'} \\right ). It provides 11 methods and 0 properties for working with wattenergy data in OpenMC." }, { "instruction": "What does the WattEnergy class do in OpenMC's Python API?", "input": "OpenMC Python API WattEnergy class description", "output": "The WattEnergy class energy-dependent watt spectrum represented as .. math:: f(e \\rightarrow e') = \\frac{e^{-e'/a}}{i} \\sinh \\left ( \\sqrt{be'} \\right ). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the u parameter do when creating a WattEnergy?", "input": "OpenMC Python API WattEnergy constructor parameter u", "output": "When creating a WattEnergy, the u parameter specifies constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It should be a float value." }, { "instruction": "What is the u attribute of a WattEnergy?", "input": "OpenMC Python API WattEnergy attribute u", "output": "The u attribute of a WattEnergy contains constant introduced to define the proper upper limit for the final particle energy such that :math:`0 \\le e' \\le e - u`. It's a float value that you can access after creating a WattEnergy instance." }, { "instruction": "How do you call the __init__() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, a: Any, b: Any, u: Any). It takes 4 parameters." }, { "instruction": "How do you call the a() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.a() method signature", "output": "To call the a() method, use: @property def a(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the a() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.a() method signature", "output": "To call the a() method, use: @a.setter def a(self: Any, a: Any). It takes 2 parameters." }, { "instruction": "How do you call the b() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.b() method signature", "output": "To call the b() method, use: @property def b(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the b() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.b() method signature", "output": "To call the b() method, use: @b.setter def b(self: Any, b: Any). It takes 2 parameters." }, { "instruction": "How do you call the u() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.u() method signature", "output": "To call the u() method, use: @property def u(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the u() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.u() method signature", "output": "To call the u() method, use: @u.setter def u(self: Any, u: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for wattenergy operations." }, { "instruction": "How do you call the to_hdf5() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API WattEnergy.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.from_hdf5() method", "output": "The from_hdf5() method generate watt fission spectrum from hdf5 data. It's used for wattenergy operations." }, { "instruction": "How do you call the from_hdf5() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API WattEnergy.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.from_ace() method", "output": "The from_ace() method create a watt fission spectrum from an ace table. It's used for wattenergy operations." }, { "instruction": "How do you call the from_ace() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API WattEnergy.from_ace() parameter ace", "output": "The ace parameter an ace table. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API WattEnergy.from_ace() parameter idx", "output": "The idx parameter offset to read from in xss array (default of zero). It should be a int value." }, { "instruction": "What does the from_endf() method do in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.from_endf() method", "output": "The from_endf() method generate watt fission spectrum from an endf evaluation. It's used for wattenergy operations." }, { "instruction": "How do you call the from_endf() method in the WattEnergy class?", "input": "OpenMC Python API WattEnergy.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, params: Any). It takes 3 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API WattEnergy.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for an energy distribution.. It should be a file-like object value." }, { "instruction": "What does the params parameter do in the from_endf() method?", "input": "OpenMC Python API WattEnergy.from_endf() parameter params", "output": "The params parameter list of parameters at the start of the energy distribution that includes the lf value indicating what type of energy distribution is present.. It should be a list value." }, { "instruction": "What is the MadlandNix class in OpenMC's Python API?", "input": "OpenMC Python API MadlandNix class", "output": "The MadlandNix class represents energy-dependent fission neutron spectrum (madland and nix) given in endf mf=5, lf=12 represented as .. math:: f(e \\rightarrow e') = \\frac{1}{2} [ g(e', e_f(l)) + g(e', e_f(h))] where .. math:: g(e',e_f) = \\frac{1}{3\\sqrt{e_f t_m}} \\left [ u_2^{3/2} e_1 (u_2) - u_1^{3/2} e_1 (u_1) + \\gamma \\left ( \\frac{3}{2}, u_2 \\right ) - \\gamma \\left ( \\frac{3}{2}, u_1 \\right ) \\right ] \\\\ u_1 = \\left ( \\sqrt{e'} - \\sqrt{e_f} \\right )^2 / t_m \\\\ u_2 = \\left ( \\sqrt{e'} + \\sqrt{e_f} \\right )^2 / t_m. It provides 10 methods and 0 properties for working with madlandnix data in OpenMC." }, { "instruction": "What does the MadlandNix class do in OpenMC's Python API?", "input": "OpenMC Python API MadlandNix class description", "output": "The MadlandNix class energy-dependent fission neutron spectrum (madland and nix) given in endf mf=5, lf=12 represented as .. math:: f(e \\rightarrow e') = \\frac{1}{2} [ g(e', e_f(l)) + g(e', e_f(h))] where .. math:: g(e',e_f) = \\frac{1}{3\\sqrt{e_f t_m}} \\left [ u_2^{3/2} e_1 (u_2) - u_1^{3/2} e_1 (u_1) + \\gamma \\left ( \\frac{3}{2}, u_2 \\right ) - \\gamma \\left ( \\frac{3}{2}, u_1 \\right ) \\right ] \\\\ u_1 = \\left ( \\sqrt{e'} - \\sqrt{e_f} \\right )^2 / t_m \\\\ u_2 = \\left ( \\sqrt{e'} + \\sqrt{e_f} \\right )^2 / t_m. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the tm parameter do when creating a MadlandNix?", "input": "OpenMC Python API MadlandNix constructor parameter tm", "output": "When creating a MadlandNix, the tm parameter specifies parameter tabulated as a function of incident neutron energy. It should be a openmc.data.Tabulated1D value." }, { "instruction": "What is the tm attribute of a MadlandNix?", "input": "OpenMC Python API MadlandNix attribute tm", "output": "The tm attribute of a MadlandNix contains parameter tabulated as a function of incident neutron energy. It's a openmc.data.Tabulated1D value that you can access after creating a MadlandNix instance." }, { "instruction": "How do you call the __init__() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, efl: Any, efh: Any, tm: Any). It takes 4 parameters." }, { "instruction": "How do you call the efl() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.efl() method signature", "output": "To call the efl() method, use: @property def efl(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the efl() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.efl() method signature", "output": "To call the efl() method, use: @efl.setter def efl(self: Any, efl: Any). It takes 2 parameters." }, { "instruction": "How do you call the efh() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.efh() method signature", "output": "To call the efh() method, use: @property def efh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the efh() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.efh() method signature", "output": "To call the efh() method, use: @efh.setter def efh(self: Any, efh: Any). It takes 2 parameters." }, { "instruction": "How do you call the tm() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.tm() method signature", "output": "To call the tm() method, use: @property def tm(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tm() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.tm() method signature", "output": "To call the tm() method, use: @tm.setter def tm(self: Any, tm: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for madlandnix operations." }, { "instruction": "How do you call the to_hdf5() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API MadlandNix.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.from_hdf5() method", "output": "The from_hdf5() method generate madland-nix fission spectrum from hdf5 data. It's used for madlandnix operations." }, { "instruction": "How do you call the from_hdf5() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API MadlandNix.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_endf() method do in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.from_endf() method", "output": "The from_endf() method generate madland-nix fission spectrum from an endf evaluation. It's used for madlandnix operations." }, { "instruction": "How do you call the from_endf() method in the MadlandNix class?", "input": "OpenMC Python API MadlandNix.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, params: Any). It takes 3 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API MadlandNix.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for an energy distribution.. It should be a file-like object value." }, { "instruction": "What does the params parameter do in the from_endf() method?", "input": "OpenMC Python API MadlandNix.from_endf() parameter params", "output": "The params parameter list of parameters at the start of the energy distribution that includes the lf value indicating what type of energy distribution is present.. It should be a list value." }, { "instruction": "What is the DiscretePhoton class in OpenMC's Python API?", "input": "OpenMC Python API DiscretePhoton class", "output": "The DiscretePhoton class represents discrete photon energy distribution. It provides 10 methods and 0 properties for working with discretephoton data in OpenMC." }, { "instruction": "What does the DiscretePhoton class do in OpenMC's Python API?", "input": "OpenMC Python API DiscretePhoton class description", "output": "The DiscretePhoton class discrete photon energy distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the primary_flag parameter do when creating a DiscretePhoton?", "input": "OpenMC Python API DiscretePhoton constructor parameter primary_flag", "output": "When creating a DiscretePhoton, the primary_flag parameter specifies indicator of whether the photon is a primary or non-primary photon.. It should be a int value." }, { "instruction": "What does the energy parameter do when creating a DiscretePhoton?", "input": "OpenMC Python API DiscretePhoton constructor parameter energy", "output": "When creating a DiscretePhoton, the energy parameter specifies photon energy (if lp==0 or lp==1) or binding energy (if lp==2).. It should be a float value." }, { "instruction": "What does the atomic_weight_ratio parameter do when creating a DiscretePhoton?", "input": "OpenMC Python API DiscretePhoton constructor parameter atomic_weight_ratio", "output": "When creating a DiscretePhoton, the atomic_weight_ratio parameter specifies atomic weight ratio of the target nuclide responsible for the emitted particle. It should be a float value." }, { "instruction": "What is the primary_flag attribute of a DiscretePhoton?", "input": "OpenMC Python API DiscretePhoton attribute primary_flag", "output": "The primary_flag attribute of a DiscretePhoton contains indicator of whether the photon is a primary or non-primary photon.. It's a int value that you can access after creating a DiscretePhoton instance." }, { "instruction": "What is the energy attribute of a DiscretePhoton?", "input": "OpenMC Python API DiscretePhoton attribute energy", "output": "The energy attribute of a DiscretePhoton contains photon energy (if lp==0 or lp==1) or binding energy (if lp==2).. It's a float value that you can access after creating a DiscretePhoton instance." }, { "instruction": "What is the atomic_weight_ratio attribute of a DiscretePhoton?", "input": "OpenMC Python API DiscretePhoton attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a DiscretePhoton contains atomic weight ratio of the target nuclide responsible for the emitted particle. It's a float value that you can access after creating a DiscretePhoton instance." }, { "instruction": "How do you call the __init__() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, primary_flag: Any, energy: Any, atomic_weight_ratio: Any). It takes 4 parameters." }, { "instruction": "How do you call the primary_flag() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.primary_flag() method signature", "output": "To call the primary_flag() method, use: @property def primary_flag(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the primary_flag() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.primary_flag() method signature", "output": "To call the primary_flag() method, use: @primary_flag.setter def primary_flag(self: Any, primary_flag: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @property def atomic_weight_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @atomic_weight_ratio.setter def atomic_weight_ratio(self: Any, atomic_weight_ratio: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for discretephoton operations." }, { "instruction": "How do you call the to_hdf5() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API DiscretePhoton.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.from_hdf5() method", "output": "The from_hdf5() method generate discrete photon energy distribution from hdf5 data. It's used for discretephoton operations." }, { "instruction": "How do you call the from_hdf5() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API DiscretePhoton.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.from_ace() method", "output": "The from_ace() method generate discrete photon energy distribution from an ace table. It's used for discretephoton operations." }, { "instruction": "How do you call the from_ace() method in the DiscretePhoton class?", "input": "OpenMC Python API DiscretePhoton.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API DiscretePhoton.from_ace() parameter ace", "output": "The ace parameter an ace table. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API DiscretePhoton.from_ace() parameter idx", "output": "The idx parameter offset to read from in xss array (default of zero). It should be a int value." }, { "instruction": "What is the LevelInelastic class in OpenMC's Python API?", "input": "OpenMC Python API LevelInelastic class", "output": "The LevelInelastic class represents level inelastic scattering. It provides 8 methods and 0 properties for working with levelinelastic data in OpenMC." }, { "instruction": "What does the LevelInelastic class do in OpenMC's Python API?", "input": "OpenMC Python API LevelInelastic class description", "output": "The LevelInelastic class level inelastic scattering. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the threshold parameter do when creating a LevelInelastic?", "input": "OpenMC Python API LevelInelastic constructor parameter threshold", "output": "When creating a LevelInelastic, the threshold parameter specifies energy threshold in the laboratory system, :math:`(a + 1)/a * |q|`. It should be a float value." }, { "instruction": "What does the mass_ratio parameter do when creating a LevelInelastic?", "input": "OpenMC Python API LevelInelastic constructor parameter mass_ratio", "output": "When creating a LevelInelastic, the mass_ratio parameter specifies :math:`(a/(a + 1))^2`. It should be a float value." }, { "instruction": "What is the threshold attribute of a LevelInelastic?", "input": "OpenMC Python API LevelInelastic attribute threshold", "output": "The threshold attribute of a LevelInelastic contains energy threshold in the laboratory system, :math:`(a + 1)/a * |q|`. It's a float value that you can access after creating a LevelInelastic instance." }, { "instruction": "What is the mass_ratio attribute of a LevelInelastic?", "input": "OpenMC Python API LevelInelastic attribute mass_ratio", "output": "The mass_ratio attribute of a LevelInelastic contains :math:`(a/(a + 1))^2`. It's a float value that you can access after creating a LevelInelastic instance." }, { "instruction": "How do you call the __init__() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, threshold: Any, mass_ratio: Any). It takes 3 parameters." }, { "instruction": "How do you call the threshold() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.threshold() method signature", "output": "To call the threshold() method, use: @property def threshold(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the threshold() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.threshold() method signature", "output": "To call the threshold() method, use: @threshold.setter def threshold(self: Any, threshold: Any). It takes 2 parameters." }, { "instruction": "How do you call the mass_ratio() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.mass_ratio() method signature", "output": "To call the mass_ratio() method, use: @property def mass_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mass_ratio() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.mass_ratio() method signature", "output": "To call the mass_ratio() method, use: @mass_ratio.setter def mass_ratio(self: Any, mass_ratio: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for levelinelastic operations." }, { "instruction": "How do you call the to_hdf5() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API LevelInelastic.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.from_hdf5() method", "output": "The from_hdf5() method generate level inelastic distribution from hdf5 data. It's used for levelinelastic operations." }, { "instruction": "How do you call the from_hdf5() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API LevelInelastic.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.from_ace() method", "output": "The from_ace() method generate level inelastic distribution from an ace table. It's used for levelinelastic operations." }, { "instruction": "How do you call the from_ace() method in the LevelInelastic class?", "input": "OpenMC Python API LevelInelastic.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API LevelInelastic.from_ace() parameter ace", "output": "The ace parameter an ace table. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API LevelInelastic.from_ace() parameter idx", "output": "The idx parameter offset to read from in xss array (default of zero). It should be a int value." }, { "instruction": "What is the ContinuousTabular class in OpenMC's Python API?", "input": "OpenMC Python API ContinuousTabular class", "output": "The ContinuousTabular class represents continuous tabular distribution. It provides 12 methods and 0 properties for working with continuoustabular data in OpenMC." }, { "instruction": "What does the ContinuousTabular class do in OpenMC's Python API?", "input": "OpenMC Python API ContinuousTabular class description", "output": "The ContinuousTabular class continuous tabular distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the breakpoints parameter do when creating a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular constructor parameter breakpoints", "output": "When creating a ContinuousTabular, the breakpoints parameter specifies breakpoints defining interpolation regions. It should be a Iterable of int value." }, { "instruction": "What does the interpolation parameter do when creating a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular constructor parameter interpolation", "output": "When creating a ContinuousTabular, the interpolation parameter specifies interpolation codes. It should be a Iterable of int value." }, { "instruction": "What does the energy parameter do when creating a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular constructor parameter energy", "output": "When creating a ContinuousTabular, the energy parameter specifies incoming energies at which distributions exist. It should be a Iterable of float value." }, { "instruction": "What does the energy_out parameter do when creating a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular constructor parameter energy_out", "output": "When creating a ContinuousTabular, the energy_out parameter specifies distribution of outgoing energies corresponding to each incoming energy. It should be a Iterable of openmc.stats.Univariate value." }, { "instruction": "What is the breakpoints attribute of a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular attribute breakpoints", "output": "The breakpoints attribute of a ContinuousTabular contains breakpoints defining interpolation regions. It's a Iterable of int value that you can access after creating a ContinuousTabular instance." }, { "instruction": "What is the interpolation attribute of a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular attribute interpolation", "output": "The interpolation attribute of a ContinuousTabular contains interpolation codes. It's a Iterable of int value that you can access after creating a ContinuousTabular instance." }, { "instruction": "What is the energy attribute of a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular attribute energy", "output": "The energy attribute of a ContinuousTabular contains incoming energies at which distributions exist. It's a Iterable of float value that you can access after creating a ContinuousTabular instance." }, { "instruction": "What is the energy_out attribute of a ContinuousTabular?", "input": "OpenMC Python API ContinuousTabular attribute energy_out", "output": "The energy_out attribute of a ContinuousTabular contains distribution of outgoing energies corresponding to each incoming energy. It's a Iterable of openmc.stats.Univariate value that you can access after creating a ContinuousTabular instance." }, { "instruction": "How do you call the __init__() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, breakpoints: Any, interpolation: Any, energy: Any, energy_out: Any). It takes 5 parameters." }, { "instruction": "How do you call the breakpoints() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.breakpoints() method signature", "output": "To call the breakpoints() method, use: @property def breakpoints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the breakpoints() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.breakpoints() method signature", "output": "To call the breakpoints() method, use: @breakpoints.setter def breakpoints(self: Any, breakpoints: Any). It takes 2 parameters." }, { "instruction": "How do you call the interpolation() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interpolation: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_out() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.energy_out() method signature", "output": "To call the energy_out() method, use: @property def energy_out(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_out() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.energy_out() method signature", "output": "To call the energy_out() method, use: @energy_out.setter def energy_out(self: Any, energy_out: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for continuoustabular operations." }, { "instruction": "How do you call the to_hdf5() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API ContinuousTabular.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.from_hdf5() method", "output": "The from_hdf5() method generate continuous tabular distribution from hdf5 data. It's used for continuoustabular operations." }, { "instruction": "How do you call the from_hdf5() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API ContinuousTabular.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.from_ace() method", "output": "The from_ace() method generate continuous tabular energy distribution from ace data. It's used for continuoustabular operations." }, { "instruction": "How do you call the from_ace() method in the ContinuousTabular class?", "input": "OpenMC Python API ContinuousTabular.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any, ldis: Any). It takes 4 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API ContinuousTabular.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API ContinuousTabular.from_ace() parameter idx", "output": "The idx parameter index in xss array of the start of the energy distribution data (ldis + locc - 1). It should be a int value." }, { "instruction": "What does the ldis parameter do in the from_ace() method?", "input": "OpenMC Python API ContinuousTabular.from_ace() parameter ldis", "output": "The ldis parameter index in xss array of the start of the energy distribution block (e.g. jxs[11]). It should be a int value." }, { "instruction": "What is the FissionEnergyRelease class in OpenMC's Python API?", "input": "OpenMC Python API FissionEnergyRelease class", "output": "The FissionEnergyRelease class represents energy relased by fission reactions. energy is carried away from fission reactions by many different particles. the attributes of this class specify how much energy is released in the form of fission fragments, neutrons, photons, etc. each component is also (in general) a function of the incident neutron energy. following a fission reaction, most of the energy release is carried by the daughter nuclei fragments. these fragments accelerate apart from the coulomb force on the time scale of ~10^-20 s [1]. those fragments emit prompt neutrons between ~10^-18 and ~10^-13 s after scission (although some prompt neutrons may come directly from the scission point) [1]. prompt photons follow with a time scale of ~10^-14 to ~10^-7 s [1]. the fission products then emit delayed neutrons with half lives between 0.1 and 100 s. the remaining fission energy comes from beta decays of the fission products which release beta particles, photons, and neutrinos (that escape the reactor and do not produce usable heat). use the class methods to instantiate this class from an hdf5 or endf dataset. the :meth:`fissionenergyrelease.from_hdf5` method builds this class from the usual openmc hdf5 data files. :meth:`fissionenergyrelease.from_endf` uses endf-formatted data. It provides 23 methods and 0 properties for working with fissionenergyrelease data in OpenMC." }, { "instruction": "What does the FissionEnergyRelease class do in OpenMC's Python API?", "input": "OpenMC Python API FissionEnergyRelease class description", "output": "The FissionEnergyRelease class energy relased by fission reactions. energy is carried away from fission reactions by many different particles. the attributes of this class specify how much energy is released in the form of fission fragments, neutrons, photons, etc. each component is also (in general) a function of the incident neutron energy. following a fission reaction, most of the energy release is carried by the daughter nuclei fragments. these fragments accelerate apart from the coulomb force on the time scale of ~10^-20 s [1]. those fragments emit prompt neutrons between ~10^-18 and ~10^-13 s after scission (although some prompt neutrons may come directly from the scission point) [1]. prompt photons follow with a time scale of ~10^-14 to ~10^-7 s [1]. the fission products then emit delayed neutrons with half lives between 0.1 and 100 s. the remaining fission energy comes from beta decays of the fission products which release beta particles, photons, and neutrinos (that escape the reactor and do not produce usable heat). use the class methods to instantiate this class from an hdf5 or endf dataset. the :meth:`fissionenergyrelease.from_hdf5` method builds this class from the usual openmc hdf5 data files. :meth:`fissionenergyrelease.from_endf` uses endf-formatted data. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the fragments attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute fragments", "output": "The fragments attribute of a FissionEnergyRelease contains function that accepts incident neutron energy value(s) and returns the kinetic energy of the fission daughter nuclides (after prompt neutron emission).. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the prompt_neutrons attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute prompt_neutrons", "output": "The prompt_neutrons attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of prompt fission neutrons.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the delayed_neutrons attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute delayed_neutrons", "output": "The delayed_neutrons attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of delayed neutrons emitted from fission products.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the prompt_photons attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute prompt_photons", "output": "The prompt_photons attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of prompt fission photons.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the delayed_photons attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute delayed_photons", "output": "The delayed_photons attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of delayed photons.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the betas attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute betas", "output": "The betas attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of delayed beta particles.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the neutrinos attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute neutrinos", "output": "The neutrinos attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of neutrinos.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the recoverable attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute recoverable", "output": "The recoverable attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of all products that can be absorbed in the reactor (all of the energy except for the neutrinos).. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the total attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute total", "output": "The total attribute of a FissionEnergyRelease contains function of energy that returns the kinetic energy of all products.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the q_prompt attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute q_prompt", "output": "The q_prompt attribute of a FissionEnergyRelease contains function of energy that returns the prompt fission q-value (fragments + prompt neutrons + prompt photons - incident neutron energy).. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the q_recoverable attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute q_recoverable", "output": "The q_recoverable attribute of a FissionEnergyRelease contains function of energy that returns the recoverable fission q-value (total release - neutrinos - incident neutron energy). this value is sometimes referred to as the pseudo-q-value.. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "What is the q_total attribute of a FissionEnergyRelease?", "input": "OpenMC Python API FissionEnergyRelease attribute q_total", "output": "The q_total attribute of a FissionEnergyRelease contains function of energy that returns the total fission q-value (total release - incident neutron energy).. It's a Callable value that you can access after creating a FissionEnergyRelease instance." }, { "instruction": "How do you call the __init__() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, fragments: Any, prompt_neutrons: Any, delayed_neutrons: Any, prompt_photons: Any, delayed_photons: Any, betas: Any, neutrinos: Any). It takes 8 parameters." }, { "instruction": "How do you call the fragments() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.fragments() method signature", "output": "To call the fragments() method, use: @property def fragments(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fragments() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.fragments() method signature", "output": "To call the fragments() method, use: @fragments.setter def fragments(self: Any, energy_release: Any). It takes 2 parameters." }, { "instruction": "How do you call the prompt_neutrons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.prompt_neutrons() method signature", "output": "To call the prompt_neutrons() method, use: @property def prompt_neutrons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the prompt_neutrons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.prompt_neutrons() method signature", "output": "To call the prompt_neutrons() method, use: @prompt_neutrons.setter def prompt_neutrons(self: Any, energy_release: Any). It takes 2 parameters." }, { "instruction": "How do you call the delayed_neutrons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.delayed_neutrons() method signature", "output": "To call the delayed_neutrons() method, use: @property def delayed_neutrons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the delayed_neutrons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.delayed_neutrons() method signature", "output": "To call the delayed_neutrons() method, use: @delayed_neutrons.setter def delayed_neutrons(self: Any, energy_release: Any). It takes 2 parameters." }, { "instruction": "How do you call the prompt_photons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.prompt_photons() method signature", "output": "To call the prompt_photons() method, use: @property def prompt_photons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the prompt_photons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.prompt_photons() method signature", "output": "To call the prompt_photons() method, use: @prompt_photons.setter def prompt_photons(self: Any, energy_release: Any). It takes 2 parameters." }, { "instruction": "How do you call the delayed_photons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.delayed_photons() method signature", "output": "To call the delayed_photons() method, use: @property def delayed_photons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the delayed_photons() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.delayed_photons() method signature", "output": "To call the delayed_photons() method, use: @delayed_photons.setter def delayed_photons(self: Any, energy_release: Any). It takes 2 parameters." }, { "instruction": "How do you call the betas() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.betas() method signature", "output": "To call the betas() method, use: @property def betas(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the betas() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.betas() method signature", "output": "To call the betas() method, use: @betas.setter def betas(self: Any, energy_release: Any). It takes 2 parameters." }, { "instruction": "How do you call the neutrinos() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.neutrinos() method signature", "output": "To call the neutrinos() method, use: @property def neutrinos(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the neutrinos() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.neutrinos() method signature", "output": "To call the neutrinos() method, use: @neutrinos.setter def neutrinos(self: Any, energy_release: Any). It takes 2 parameters." }, { "instruction": "How do you call the recoverable() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.recoverable() method signature", "output": "To call the recoverable() method, use: @property def recoverable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the total() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.total() method signature", "output": "To call the total() method, use: @property def total(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the q_prompt() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.q_prompt() method signature", "output": "To call the q_prompt() method, use: @property def q_prompt(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the q_recoverable() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.q_recoverable() method signature", "output": "To call the q_recoverable() method, use: @property def q_recoverable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the q_total() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.q_total() method signature", "output": "To call the q_total() method, use: @property def q_total(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_endf() method do in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.from_endf() method", "output": "The from_endf() method generate fission energy release data from an endf file. It's used for fissionenergyrelease operations." }, { "instruction": "How do you call the from_endf() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, incident_neutron: Any). It takes 3 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API FissionEnergyRelease.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the incident_neutron parameter do in the from_endf() method?", "input": "OpenMC Python API FissionEnergyRelease.from_endf() parameter incident_neutron", "output": "The incident_neutron parameter corresponding incident neutron dataset. It should be a openmc.data.IncidentNeutron value." }, { "instruction": "What does the from_hdf5() method do in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.from_hdf5() method", "output": "The from_hdf5() method generate fission energy release data from an hdf5 group. It's used for fissionenergyrelease operations." }, { "instruction": "How do you call the from_hdf5() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API FissionEnergyRelease.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the to_hdf5() method do in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.to_hdf5() method", "output": "The to_hdf5() method write energy release data to an hdf5 group. It's used for fissionenergyrelease operations." }, { "instruction": "How do you call the to_hdf5() method in the FissionEnergyRelease class?", "input": "OpenMC Python API FissionEnergyRelease.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API FissionEnergyRelease.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What is the Function1D class in OpenMC's Python API?", "input": "OpenMC Python API Function1D class", "output": "The Function1D class represents a function of one independent variable with hdf5 support.. It provides 3 methods and 0 properties for working with function1d data in OpenMC." }, { "instruction": "What does the Function1D class do in OpenMC's Python API?", "input": "OpenMC Python API Function1D class description", "output": "The Function1D class a function of one independent variable with hdf5 support.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __call__() method in the Function1D class?", "input": "OpenMC Python API Function1D.__call__() method signature", "output": "To call the __call__() method, use: @abstractmethod def __call__(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_hdf5() method do in the Function1D class?", "input": "OpenMC Python API Function1D.to_hdf5() method", "output": "The to_hdf5() method write function to an hdf5 group. It's used for function1d operations." }, { "instruction": "How do you call the to_hdf5() method in the Function1D class?", "input": "OpenMC Python API Function1D.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: @abstractmethod def to_hdf5(self: Any, group: Any, name: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API Function1D.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the name parameter do in the to_hdf5() method?", "input": "OpenMC Python API Function1D.to_hdf5() parameter name", "output": "The name parameter name of the dataset to create. It should be a str value." }, { "instruction": "What does the from_hdf5() method do in the Function1D class?", "input": "OpenMC Python API Function1D.from_hdf5() method", "output": "The from_hdf5() method generate function from an hdf5 dataset. It's used for function1d operations." }, { "instruction": "How do you call the from_hdf5() method in the Function1D class?", "input": "OpenMC Python API Function1D.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, dataset: Any). It takes 2 parameters." }, { "instruction": "What does the dataset parameter do in the from_hdf5() method?", "input": "OpenMC Python API Function1D.from_hdf5() parameter dataset", "output": "The dataset parameter dataset to read from. It should be a h5py.Dataset value." }, { "instruction": "What is the Tabulated1D class in OpenMC's Python API?", "input": "OpenMC Python API Tabulated1D class", "output": "The Tabulated1D class represents a one-dimensional tabulated function. this class mirrors the tab1 type from the endf-6 format. a tabulated function is specified by tabulated (x,y) pairs along with interpolation rules that determine the values between tabulated pairs. once an object has been created, it can be used as though it were an actual function, e.g.: >>> f = tabulated1d([0, 10], [4, 5]) >>> [f(xi) for xi in numpy.linspace(0, 10, 5)] [4.0, 4.25, 4.5, 4.75, 5.0]. It provides 18 methods and 0 properties for working with tabulated1d data in OpenMC." }, { "instruction": "What does the Tabulated1D class do in OpenMC's Python API?", "input": "OpenMC Python API Tabulated1D class description", "output": "The Tabulated1D class a one-dimensional tabulated function. this class mirrors the tab1 type from the endf-6 format. a tabulated function is specified by tabulated (x,y) pairs along with interpolation rules that determine the values between tabulated pairs. once an object has been created, it can be used as though it were an actual function, e.g.: >>> f = tabulated1d([0, 10], [4, 5]) >>> [f(xi) for xi in numpy.linspace(0, 10, 5)] [4.0, 4.25, 4.5, 4.75, 5.0]. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x parameter do when creating a Tabulated1D?", "input": "OpenMC Python API Tabulated1D constructor parameter x", "output": "When creating a Tabulated1D, the x parameter specifies independent variable. It should be a Iterable of float value." }, { "instruction": "What does the y parameter do when creating a Tabulated1D?", "input": "OpenMC Python API Tabulated1D constructor parameter y", "output": "When creating a Tabulated1D, the y parameter specifies dependent variable. It should be a Iterable of float value." }, { "instruction": "What does the breakpoints parameter do when creating a Tabulated1D?", "input": "OpenMC Python API Tabulated1D constructor parameter breakpoints", "output": "When creating a Tabulated1D, the breakpoints parameter specifies breakpoints for interpolation regions. It should be a Iterable of int value." }, { "instruction": "What does the interpolation parameter do when creating a Tabulated1D?", "input": "OpenMC Python API Tabulated1D constructor parameter interpolation", "output": "When creating a Tabulated1D, the interpolation parameter specifies interpolation scheme identification number, e.g., 3 means y is linear in ln(x).. It should be a Iterable of int value." }, { "instruction": "What is the x attribute of a Tabulated1D?", "input": "OpenMC Python API Tabulated1D attribute x", "output": "The x attribute of a Tabulated1D contains independent variable. It's a Iterable of float value that you can access after creating a Tabulated1D instance." }, { "instruction": "What is the y attribute of a Tabulated1D?", "input": "OpenMC Python API Tabulated1D attribute y", "output": "The y attribute of a Tabulated1D contains dependent variable. It's a Iterable of float value that you can access after creating a Tabulated1D instance." }, { "instruction": "What is the breakpoints attribute of a Tabulated1D?", "input": "OpenMC Python API Tabulated1D attribute breakpoints", "output": "The breakpoints attribute of a Tabulated1D contains breakpoints for interpolation regions. It's a Iterable of int value that you can access after creating a Tabulated1D instance." }, { "instruction": "What is the interpolation attribute of a Tabulated1D?", "input": "OpenMC Python API Tabulated1D attribute interpolation", "output": "The interpolation attribute of a Tabulated1D contains interpolation scheme identification number, e.g., 3 means y is linear in ln(x).. It's a Iterable of int value that you can access after creating a Tabulated1D instance." }, { "instruction": "What is the n_regions attribute of a Tabulated1D?", "input": "OpenMC Python API Tabulated1D attribute n_regions", "output": "The n_regions attribute of a Tabulated1D contains number of interpolation regions. It's a int value that you can access after creating a Tabulated1D instance." }, { "instruction": "What is the n_pairs attribute of a Tabulated1D?", "input": "OpenMC Python API Tabulated1D attribute n_pairs", "output": "The n_pairs attribute of a Tabulated1D contains number of tabulated (x,y) pairs. It's a int value that you can access after creating a Tabulated1D instance." }, { "instruction": "How do you call the __init__() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x: Any, y: Any, breakpoints: Any, interpolation: Any). It takes 5 parameters." }, { "instruction": "How do you call the __call__() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the _interpolate_scalar() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D._interpolate_scalar() method signature", "output": "To call the _interpolate_scalar() method, use: def _interpolate_scalar(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.x() method signature", "output": "To call the x() method, use: @property def x(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.x() method signature", "output": "To call the x() method, use: @x.setter def x(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the y() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.y() method signature", "output": "To call the y() method, use: @property def y(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the y() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.y() method signature", "output": "To call the y() method, use: @y.setter def y(self: Any, y: Any). It takes 2 parameters." }, { "instruction": "How do you call the breakpoints() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.breakpoints() method signature", "output": "To call the breakpoints() method, use: @property def breakpoints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the breakpoints() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.breakpoints() method signature", "output": "To call the breakpoints() method, use: @breakpoints.setter def breakpoints(self: Any, breakpoints: Any). It takes 2 parameters." }, { "instruction": "How do you call the interpolation() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interpolation: Any). It takes 2 parameters." }, { "instruction": "How do you call the n_pairs() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.n_pairs() method signature", "output": "To call the n_pairs() method, use: @property def n_pairs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_regions() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.n_regions() method signature", "output": "To call the n_regions() method, use: @property def n_regions(self: Any). It takes 1 parameters." }, { "instruction": "What does the integral() method do in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.integral() method", "output": "The integral() method integral of the tabulated function over its tabulated range. It's used for tabulated1d operations." }, { "instruction": "How do you call the integral() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.integral() method signature", "output": "To call the integral() method, use: def integral(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_hdf5() method do in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.to_hdf5() method", "output": "The to_hdf5() method write tabulated function to an hdf5 group. It's used for tabulated1d operations." }, { "instruction": "How do you call the to_hdf5() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any, name: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API Tabulated1D.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the name parameter do in the to_hdf5() method?", "input": "OpenMC Python API Tabulated1D.to_hdf5() parameter name", "output": "The name parameter name of the dataset to create. It should be a str value." }, { "instruction": "What does the from_hdf5() method do in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.from_hdf5() method", "output": "The from_hdf5() method generate tabulated function from an hdf5 dataset. It's used for tabulated1d operations." }, { "instruction": "How do you call the from_hdf5() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, dataset: Any). It takes 2 parameters." }, { "instruction": "What does the dataset parameter do in the from_hdf5() method?", "input": "OpenMC Python API Tabulated1D.from_hdf5() parameter dataset", "output": "The dataset parameter dataset to read from. It should be a h5py.Dataset value." }, { "instruction": "What does the from_ace() method do in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.from_ace() method", "output": "The from_ace() method create a tabulated1d object from an ace table. It's used for tabulated1d operations." }, { "instruction": "How do you call the from_ace() method in the Tabulated1D class?", "input": "OpenMC Python API Tabulated1D.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any, convert_units: Any). It takes 4 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API Tabulated1D.from_ace() parameter ace", "output": "The ace parameter an ace table. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API Tabulated1D.from_ace() parameter idx", "output": "The idx parameter offset to read from in xss array (default of zero). It should be a int value." }, { "instruction": "What does the convert_units parameter do in the from_ace() method?", "input": "OpenMC Python API Tabulated1D.from_ace() parameter convert_units", "output": "The convert_units parameter if the abscissa represents energy, indicate whether to convert mev to ev.. It should be a bool value." }, { "instruction": "What is the Polynomial class in OpenMC's Python API?", "input": "OpenMC Python API Polynomial class", "output": "The Polynomial class represents a power series class. It provides 2 methods and 0 properties for working with polynomial data in OpenMC." }, { "instruction": "What does the Polynomial class do in OpenMC's Python API?", "input": "OpenMC Python API Polynomial class description", "output": "The Polynomial class a power series class. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the coef parameter do when creating a Polynomial?", "input": "OpenMC Python API Polynomial constructor parameter coef", "output": "When creating a Polynomial, the coef parameter specifies polynomial coefficients in order of increasing degree. It should be a Iterable of float value." }, { "instruction": "What does the to_hdf5() method do in the Polynomial class?", "input": "OpenMC Python API Polynomial.to_hdf5() method", "output": "The to_hdf5() method write polynomial function to an hdf5 group. It's used for polynomial operations." }, { "instruction": "How do you call the to_hdf5() method in the Polynomial class?", "input": "OpenMC Python API Polynomial.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any, name: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API Polynomial.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the name parameter do in the to_hdf5() method?", "input": "OpenMC Python API Polynomial.to_hdf5() parameter name", "output": "The name parameter name of the dataset to create. It should be a str value." }, { "instruction": "What does the from_hdf5() method do in the Polynomial class?", "input": "OpenMC Python API Polynomial.from_hdf5() method", "output": "The from_hdf5() method generate function from an hdf5 dataset. It's used for polynomial operations." }, { "instruction": "How do you call the from_hdf5() method in the Polynomial class?", "input": "OpenMC Python API Polynomial.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, dataset: Any). It takes 2 parameters." }, { "instruction": "What does the dataset parameter do in the from_hdf5() method?", "input": "OpenMC Python API Polynomial.from_hdf5() parameter dataset", "output": "The dataset parameter dataset to read from. It should be a h5py.Dataset value." }, { "instruction": "What is the Combination class in OpenMC's Python API?", "input": "OpenMC Python API Combination class", "output": "The Combination class represents combination of multiple functions with a user-defined operator this class allows you to create a callable object which represents the combination of other callable objects by way of a series of user-defined operators connecting each of the callable objects. It provides 6 methods and 0 properties for working with combination data in OpenMC." }, { "instruction": "What does the Combination class do in OpenMC's Python API?", "input": "OpenMC Python API Combination class description", "output": "The Combination class combination of multiple functions with a user-defined operator this class allows you to create a callable object which represents the combination of other callable objects by way of a series of user-defined operators connecting each of the callable objects. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the functions parameter do when creating a Combination?", "input": "OpenMC Python API Combination constructor parameter functions", "output": "When creating a Combination, the functions parameter specifies functions to combine according to operations. It should be a Iterable of Callable value." }, { "instruction": "What does the operations parameter do when creating a Combination?", "input": "OpenMC Python API Combination constructor parameter operations", "output": "When creating a Combination, the operations parameter specifies operations to perform between functions; note that the standard order of operations will not be followed, but can be simulated by combinations of combination objects. the operations parameter must have a length one less than the number of functions.. It should be a Iterable of numpy.ufunc value." }, { "instruction": "What is the functions attribute of a Combination?", "input": "OpenMC Python API Combination attribute functions", "output": "The functions attribute of a Combination contains functions to combine according to operations. It's a Iterable of Callable value that you can access after creating a Combination instance." }, { "instruction": "What is the operations attribute of a Combination?", "input": "OpenMC Python API Combination attribute operations", "output": "The operations attribute of a Combination contains operations to perform between functions; note that the standard order of operations will not be followed, but can be simulated by combinations of combination objects. the operations parameter must have a length one less than the number of functions.. It's a Iterable of numpy.ufunc value that you can access after creating a Combination instance." }, { "instruction": "How do you call the __init__() method in the Combination class?", "input": "OpenMC Python API Combination.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, functions: Any, operations: Any). It takes 3 parameters." }, { "instruction": "How do you call the __call__() method in the Combination class?", "input": "OpenMC Python API Combination.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the functions() method in the Combination class?", "input": "OpenMC Python API Combination.functions() method signature", "output": "To call the functions() method, use: @property def functions(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the functions() method in the Combination class?", "input": "OpenMC Python API Combination.functions() method signature", "output": "To call the functions() method, use: @functions.setter def functions(self: Any, functions: Any). It takes 2 parameters." }, { "instruction": "How do you call the operations() method in the Combination class?", "input": "OpenMC Python API Combination.operations() method signature", "output": "To call the operations() method, use: @property def operations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the operations() method in the Combination class?", "input": "OpenMC Python API Combination.operations() method signature", "output": "To call the operations() method, use: @operations.setter def operations(self: Any, operations: Any). It takes 2 parameters." }, { "instruction": "What is the Sum class in OpenMC's Python API?", "input": "OpenMC Python API Sum class", "output": "The Sum class represents sum of multiple functions. this class allows you to create a callable object which represents the sum of other callable objects. this is used for redundant reactions whereby the cross section is defined as the sum of other cross sections. It provides 6 methods and 0 properties for working with sum data in OpenMC." }, { "instruction": "What does the Sum class do in OpenMC's Python API?", "input": "OpenMC Python API Sum class description", "output": "The Sum class sum of multiple functions. this class allows you to create a callable object which represents the sum of other callable objects. this is used for redundant reactions whereby the cross section is defined as the sum of other cross sections. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the functions parameter do when creating a Sum?", "input": "OpenMC Python API Sum constructor parameter functions", "output": "When creating a Sum, the functions parameter specifies functions which are to be added together. It should be a Iterable of Callable value." }, { "instruction": "What is the functions attribute of a Sum?", "input": "OpenMC Python API Sum attribute functions", "output": "The functions attribute of a Sum contains functions which are to be added together. It's a Iterable of Callable value that you can access after creating a Sum instance." }, { "instruction": "How do you call the __init__() method in the Sum class?", "input": "OpenMC Python API Sum.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, functions: Any). It takes 2 parameters." }, { "instruction": "How do you call the __call__() method in the Sum class?", "input": "OpenMC Python API Sum.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the functions() method in the Sum class?", "input": "OpenMC Python API Sum.functions() method signature", "output": "To call the functions() method, use: @property def functions(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the functions() method in the Sum class?", "input": "OpenMC Python API Sum.functions() method signature", "output": "To call the functions() method, use: @functions.setter def functions(self: Any, functions: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the Sum class?", "input": "OpenMC Python API Sum.to_hdf5() method", "output": "The to_hdf5() method write sum of functions to an hdf5 group .. versionadded:: 0.13.1. It's used for sum operations." }, { "instruction": "How do you call the to_hdf5() method in the Sum class?", "input": "OpenMC Python API Sum.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any, name: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API Sum.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the name parameter do in the to_hdf5() method?", "input": "OpenMC Python API Sum.to_hdf5() parameter name", "output": "The name parameter name of the dataset to create. It should be a str value." }, { "instruction": "What does the from_hdf5() method do in the Sum class?", "input": "OpenMC Python API Sum.from_hdf5() method", "output": "The from_hdf5() method generate sum of functions from an hdf5 group .. versionadded:: 0.13.1. It's used for sum operations." }, { "instruction": "How do you call the from_hdf5() method in the Sum class?", "input": "OpenMC Python API Sum.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Sum.from_hdf5() parameter group", "output": "The group parameter group to read from. It should be a h5py.Group value." }, { "instruction": "What is the Regions1D class in OpenMC's Python API?", "input": "OpenMC Python API Regions1D class", "output": "The Regions1D class represents piecewise composition of multiple functions. this class allows you to create a callable object which is composed of multiple other callable objects, each applying to a specific interval. It provides 6 methods and 0 properties for working with regions1d data in OpenMC." }, { "instruction": "What does the Regions1D class do in OpenMC's Python API?", "input": "OpenMC Python API Regions1D class description", "output": "The Regions1D class piecewise composition of multiple functions. this class allows you to create a callable object which is composed of multiple other callable objects, each applying to a specific interval. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the functions parameter do when creating a Regions1D?", "input": "OpenMC Python API Regions1D constructor parameter functions", "output": "When creating a Regions1D, the functions parameter specifies functions which are to be combined in a piecewise fashion. It should be a Iterable of Callable value." }, { "instruction": "What does the breakpoints parameter do when creating a Regions1D?", "input": "OpenMC Python API Regions1D constructor parameter breakpoints", "output": "When creating a Regions1D, the breakpoints parameter specifies the values of the dependent variable that define the domain of each function. the `i`\\ th and `(i+1)`\\ th values are the limits of the domain of the `i`\\ th function. values must be monotonically increasing.. It should be a Iterable of float value." }, { "instruction": "What is the functions attribute of a Regions1D?", "input": "OpenMC Python API Regions1D attribute functions", "output": "The functions attribute of a Regions1D contains functions which are to be combined in a piecewise fashion. It's a Iterable of Callable value that you can access after creating a Regions1D instance." }, { "instruction": "What is the breakpoints attribute of a Regions1D?", "input": "OpenMC Python API Regions1D attribute breakpoints", "output": "The breakpoints attribute of a Regions1D contains the breakpoints between each function. It's a Iterable of float value that you can access after creating a Regions1D instance." }, { "instruction": "How do you call the __init__() method in the Regions1D class?", "input": "OpenMC Python API Regions1D.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, functions: Any, breakpoints: Any). It takes 3 parameters." }, { "instruction": "How do you call the __call__() method in the Regions1D class?", "input": "OpenMC Python API Regions1D.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the functions() method in the Regions1D class?", "input": "OpenMC Python API Regions1D.functions() method signature", "output": "To call the functions() method, use: @property def functions(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the functions() method in the Regions1D class?", "input": "OpenMC Python API Regions1D.functions() method signature", "output": "To call the functions() method, use: @functions.setter def functions(self: Any, functions: Any). It takes 2 parameters." }, { "instruction": "How do you call the breakpoints() method in the Regions1D class?", "input": "OpenMC Python API Regions1D.breakpoints() method signature", "output": "To call the breakpoints() method, use: @property def breakpoints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the breakpoints() method in the Regions1D class?", "input": "OpenMC Python API Regions1D.breakpoints() method signature", "output": "To call the breakpoints() method, use: @breakpoints.setter def breakpoints(self: Any, breakpoints: Any). It takes 2 parameters." }, { "instruction": "What is the ResonancesWithBackground class in OpenMC's Python API?", "input": "OpenMC Python API ResonancesWithBackground class", "output": "The ResonancesWithBackground class represents cross section in resolved resonance region. It provides 7 methods and 0 properties for working with resonanceswithbackground data in OpenMC." }, { "instruction": "What does the ResonancesWithBackground class do in OpenMC's Python API?", "input": "OpenMC Python API ResonancesWithBackground class description", "output": "The ResonancesWithBackground class cross section in resolved resonance region. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the resonances parameter do when creating a ResonancesWithBackground?", "input": "OpenMC Python API ResonancesWithBackground constructor parameter resonances", "output": "When creating a ResonancesWithBackground, the resonances parameter specifies resolved resonance parameter data. It should be a openmc.data.Resonances value." }, { "instruction": "What does the background parameter do when creating a ResonancesWithBackground?", "input": "OpenMC Python API ResonancesWithBackground constructor parameter background", "output": "When creating a ResonancesWithBackground, the background parameter specifies background cross section as a function of energy. It should be a Callable value." }, { "instruction": "What does the mt parameter do when creating a ResonancesWithBackground?", "input": "OpenMC Python API ResonancesWithBackground constructor parameter mt", "output": "When creating a ResonancesWithBackground, the mt parameter specifies mt value of the reaction. It should be a int value." }, { "instruction": "What is the resonances attribute of a ResonancesWithBackground?", "input": "OpenMC Python API ResonancesWithBackground attribute resonances", "output": "The resonances attribute of a ResonancesWithBackground contains resolved resonance parameter data. It's a openmc.data.Resonances value that you can access after creating a ResonancesWithBackground instance." }, { "instruction": "What is the background attribute of a ResonancesWithBackground?", "input": "OpenMC Python API ResonancesWithBackground attribute background", "output": "The background attribute of a ResonancesWithBackground contains background cross section as a function of energy. It's a Callable value that you can access after creating a ResonancesWithBackground instance." }, { "instruction": "What is the mt attribute of a ResonancesWithBackground?", "input": "OpenMC Python API ResonancesWithBackground attribute mt", "output": "The mt attribute of a ResonancesWithBackground contains mt value of the reaction. It's a int value that you can access after creating a ResonancesWithBackground instance." }, { "instruction": "How do you call the __init__() method in the ResonancesWithBackground class?", "input": "OpenMC Python API ResonancesWithBackground.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, resonances: Any, background: Any, mt: Any). It takes 4 parameters." }, { "instruction": "How do you call the background() method in the ResonancesWithBackground class?", "input": "OpenMC Python API ResonancesWithBackground.background() method signature", "output": "To call the background() method, use: @property def background(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the background() method in the ResonancesWithBackground class?", "input": "OpenMC Python API ResonancesWithBackground.background() method signature", "output": "To call the background() method, use: @background.setter def background(self: Any, background: Any). It takes 2 parameters." }, { "instruction": "How do you call the mt() method in the ResonancesWithBackground class?", "input": "OpenMC Python API ResonancesWithBackground.mt() method signature", "output": "To call the mt() method, use: @property def mt(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mt() method in the ResonancesWithBackground class?", "input": "OpenMC Python API ResonancesWithBackground.mt() method signature", "output": "To call the mt() method, use: @mt.setter def mt(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "How do you call the resonances() method in the ResonancesWithBackground class?", "input": "OpenMC Python API ResonancesWithBackground.resonances() method signature", "output": "To call the resonances() method, use: @property def resonances(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the resonances() method in the ResonancesWithBackground class?", "input": "OpenMC Python API ResonancesWithBackground.resonances() method signature", "output": "To call the resonances() method, use: @resonances.setter def resonances(self: Any, resonances: Any). It takes 2 parameters." }, { "instruction": "What does the sum_functions() function do in OpenMC's Python API?", "input": "OpenMC Python API sum_functions() function", "output": "The sum_functions() function add tabulated/polynomials functions together. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the sum_functions() function in OpenMC's Python API?", "input": "OpenMC Python API sum_functions() function purpose", "output": "The sum_functions() function add tabulated/polynomials functions together. It's part of OpenMC's Python API." }, { "instruction": "How do you call the sum_functions() function in OpenMC's Python API?", "input": "OpenMC Python API sum_functions() function signature", "output": "To call the sum_functions() function, use: def sum_functions(funcs: Any). It takes 1 parameters." }, { "instruction": "What does the funcs parameter do in the sum_functions() function?", "input": "OpenMC Python API sum_functions() parameter funcs", "output": "The funcs parameter functions to add. It should be a list of Function1D value." }, { "instruction": "What does the linearize() function do in OpenMC's Python API?", "input": "OpenMC Python API linearize() function", "output": "The linearize() function return a tabulated representation of a one-variable function. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the linearize() function in OpenMC's Python API?", "input": "OpenMC Python API linearize() function purpose", "output": "The linearize() function return a tabulated representation of a one-variable function. It's part of OpenMC's Python API." }, { "instruction": "How do you call the linearize() function in OpenMC's Python API?", "input": "OpenMC Python API linearize() function signature", "output": "To call the linearize() function, use: def linearize(x: Any, f: Any, tolerance: Any). It takes 3 parameters." }, { "instruction": "What does the x parameter do in the linearize() function?", "input": "OpenMC Python API linearize() parameter x", "output": "The x parameter initial x values at which the function should be evaluated. It should be a Iterable of float value." }, { "instruction": "What does the f parameter do in the linearize() function?", "input": "OpenMC Python API linearize() parameter f", "output": "The f parameter function of a single variable. It should be a Callable value." }, { "instruction": "What does the tolerance parameter do in the linearize() function?", "input": "OpenMC Python API linearize() parameter tolerance", "output": "The tolerance parameter tolerance on the interpolation error. It should be a float value." }, { "instruction": "What does the thin() function do in OpenMC's Python API?", "input": "OpenMC Python API thin() function", "output": "The thin() function check for (x,y) points that can be removed. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the thin() function in OpenMC's Python API?", "input": "OpenMC Python API thin() function purpose", "output": "The thin() function check for (x,y) points that can be removed. It's part of OpenMC's Python API." }, { "instruction": "How do you call the thin() function in OpenMC's Python API?", "input": "OpenMC Python API thin() function signature", "output": "To call the thin() function, use: def thin(x: Any, y: Any, tolerance: Any). It takes 3 parameters." }, { "instruction": "What does the x parameter do in the thin() function?", "input": "OpenMC Python API thin() parameter x", "output": "The x parameter independent variable. It should be a numpy.ndarray value." }, { "instruction": "What does the y parameter do in the thin() function?", "input": "OpenMC Python API thin() parameter y", "output": "The y parameter dependent variable. It should be a numpy.ndarray value." }, { "instruction": "What does the tolerance parameter do in the thin() function?", "input": "OpenMC Python API thin() parameter tolerance", "output": "The tolerance parameter tolerance on interpolation error. It should be a float value." }, { "instruction": "What is the _AtomicRepresentation class in OpenMC's Python API?", "input": "OpenMC Python API _AtomicRepresentation class", "output": "The _AtomicRepresentation class represents atomic representation of an isotope or a particle. It provides 8 methods and 0 properties for working with _atomicrepresentation data in OpenMC." }, { "instruction": "What does the _AtomicRepresentation class do in OpenMC's Python API?", "input": "OpenMC Python API _AtomicRepresentation class description", "output": "The _AtomicRepresentation class atomic representation of an isotope or a particle. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the z parameter do when creating a _AtomicRepresentation?", "input": "OpenMC Python API _AtomicRepresentation constructor parameter z", "output": "When creating a _AtomicRepresentation, the z parameter specifies number of protons (atomic number). It should be a int value." }, { "instruction": "What does the a parameter do when creating a _AtomicRepresentation?", "input": "OpenMC Python API _AtomicRepresentation constructor parameter a", "output": "When creating a _AtomicRepresentation, the a parameter specifies number of nucleons (mass number). It should be a int value." }, { "instruction": "What is the z attribute of a _AtomicRepresentation?", "input": "OpenMC Python API _AtomicRepresentation attribute z", "output": "The z attribute of a _AtomicRepresentation contains number of protons (atomic number). It's a int value that you can access after creating a _AtomicRepresentation instance." }, { "instruction": "What is the a attribute of a _AtomicRepresentation?", "input": "OpenMC Python API _AtomicRepresentation attribute a", "output": "The a attribute of a _AtomicRepresentation contains number of nucleons (mass number). It's a int value that you can access after creating a _AtomicRepresentation instance." }, { "instruction": "What is the n attribute of a _AtomicRepresentation?", "input": "OpenMC Python API _AtomicRepresentation attribute n", "output": "The n attribute of a _AtomicRepresentation contains number of neutrons. It's a int value that you can access after creating a _AtomicRepresentation instance." }, { "instruction": "What is the za attribute of a _AtomicRepresentation?", "input": "OpenMC Python API _AtomicRepresentation attribute za", "output": "The za attribute of a _AtomicRepresentation contains za identifier, 1000*z + a, where z is the atomic number and a the mass number. It's a int value that you can access after creating a _AtomicRepresentation instance." }, { "instruction": "How do you call the __init__() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, z: Any, a: Any). It takes 3 parameters." }, { "instruction": "What does the __add__() method do in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.__add__() method", "output": "The __add__() method add two _atomicrepresentations. It's used for _atomicrepresentation operations." }, { "instruction": "How do you call the __add__() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.__add__() method signature", "output": "To call the __add__() method, use: def __add__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the __sub__() method do in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.__sub__() method", "output": "The __sub__() method substract two _atomicrepresentations. It's used for _atomicrepresentation operations." }, { "instruction": "How do you call the __sub__() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.__sub__() method signature", "output": "To call the __sub__() method, use: def __sub__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the a() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.a() method signature", "output": "To call the a() method, use: @property def a(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the z() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.z() method signature", "output": "To call the z() method, use: @property def z(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.n() method signature", "output": "To call the n() method, use: @property def n(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the za() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.za() method signature", "output": "To call the za() method, use: @property def za(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_za() method do in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.from_za() method", "output": "The from_za() method instantiate an _atomicrepresentation from a za identifier. It's used for _atomicrepresentation operations." }, { "instruction": "How do you call the from_za() method in the _AtomicRepresentation class?", "input": "OpenMC Python API _AtomicRepresentation.from_za() method signature", "output": "To call the from_za() method, use: @classmethod def from_za(cls: Any, za: Any). It takes 2 parameters." }, { "instruction": "What does the za parameter do in the from_za() method?", "input": "OpenMC Python API _AtomicRepresentation.from_za() parameter za", "output": "The za parameter za identifier, 1000*z + a, where z is the atomic number and a the mass number. It should be a int value." }, { "instruction": "What is the KalbachMann class in OpenMC's Python API?", "input": "OpenMC Python API KalbachMann class", "output": "The KalbachMann class represents kalbach-mann distribution. It provides 17 methods and 0 properties for working with kalbachmann data in OpenMC." }, { "instruction": "What does the KalbachMann class do in OpenMC's Python API?", "input": "OpenMC Python API KalbachMann class description", "output": "The KalbachMann class kalbach-mann distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the breakpoints parameter do when creating a KalbachMann?", "input": "OpenMC Python API KalbachMann constructor parameter breakpoints", "output": "When creating a KalbachMann, the breakpoints parameter specifies breakpoints defining interpolation regions. It should be a Iterable of int value." }, { "instruction": "What does the interpolation parameter do when creating a KalbachMann?", "input": "OpenMC Python API KalbachMann constructor parameter interpolation", "output": "When creating a KalbachMann, the interpolation parameter specifies interpolation codes. It should be a Iterable of int value." }, { "instruction": "What does the energy parameter do when creating a KalbachMann?", "input": "OpenMC Python API KalbachMann constructor parameter energy", "output": "When creating a KalbachMann, the energy parameter specifies incoming energies at which distributions exist. It should be a Iterable of float value." }, { "instruction": "What does the energy_out parameter do when creating a KalbachMann?", "input": "OpenMC Python API KalbachMann constructor parameter energy_out", "output": "When creating a KalbachMann, the energy_out parameter specifies distribution of outgoing energies corresponding to each incoming energy. It should be a Iterable of openmc.stats.Univariate value." }, { "instruction": "What does the precompound parameter do when creating a KalbachMann?", "input": "OpenMC Python API KalbachMann constructor parameter precompound", "output": "When creating a KalbachMann, the precompound parameter specifies precompound factor 'r' as a function of outgoing energy for each incoming energy. It should be a Iterable of openmc.data.Tabulated1D value." }, { "instruction": "What does the slope parameter do when creating a KalbachMann?", "input": "OpenMC Python API KalbachMann constructor parameter slope", "output": "When creating a KalbachMann, the slope parameter specifies kalbach-chadwick angular distribution slope value 'a' as a function of outgoing energy for each incoming energy. It should be a Iterable of openmc.data.Tabulated1D value." }, { "instruction": "What is the breakpoints attribute of a KalbachMann?", "input": "OpenMC Python API KalbachMann attribute breakpoints", "output": "The breakpoints attribute of a KalbachMann contains breakpoints defining interpolation regions. It's a Iterable of int value that you can access after creating a KalbachMann instance." }, { "instruction": "What is the interpolation attribute of a KalbachMann?", "input": "OpenMC Python API KalbachMann attribute interpolation", "output": "The interpolation attribute of a KalbachMann contains interpolation codes. It's a Iterable of int value that you can access after creating a KalbachMann instance." }, { "instruction": "What is the energy attribute of a KalbachMann?", "input": "OpenMC Python API KalbachMann attribute energy", "output": "The energy attribute of a KalbachMann contains incoming energies at which distributions exist. It's a Iterable of float value that you can access after creating a KalbachMann instance." }, { "instruction": "What is the energy_out attribute of a KalbachMann?", "input": "OpenMC Python API KalbachMann attribute energy_out", "output": "The energy_out attribute of a KalbachMann contains distribution of outgoing energies corresponding to each incoming energy. It's a Iterable of openmc.stats.Univariate value that you can access after creating a KalbachMann instance." }, { "instruction": "What is the precompound attribute of a KalbachMann?", "input": "OpenMC Python API KalbachMann attribute precompound", "output": "The precompound attribute of a KalbachMann contains precompound factor 'r' as a function of outgoing energy for each incoming energy. It's a Iterable of openmc.data.Tabulated1D value that you can access after creating a KalbachMann instance." }, { "instruction": "What is the slope attribute of a KalbachMann?", "input": "OpenMC Python API KalbachMann attribute slope", "output": "The slope attribute of a KalbachMann contains kalbach-chadwick angular distribution slope value 'a' as a function of outgoing energy for each incoming energy. It's a Iterable of openmc.data.Tabulated1D value that you can access after creating a KalbachMann instance." }, { "instruction": "How do you call the __init__() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, breakpoints: Any, interpolation: Any, energy: Any, energy_out: Any, precompound: Any, slope: Any). It takes 7 parameters." }, { "instruction": "How do you call the breakpoints() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.breakpoints() method signature", "output": "To call the breakpoints() method, use: @property def breakpoints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the breakpoints() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.breakpoints() method signature", "output": "To call the breakpoints() method, use: @breakpoints.setter def breakpoints(self: Any, breakpoints: Any). It takes 2 parameters." }, { "instruction": "How do you call the interpolation() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interpolation: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_out() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.energy_out() method signature", "output": "To call the energy_out() method, use: @property def energy_out(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_out() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.energy_out() method signature", "output": "To call the energy_out() method, use: @energy_out.setter def energy_out(self: Any, energy_out: Any). It takes 2 parameters." }, { "instruction": "How do you call the precompound() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.precompound() method signature", "output": "To call the precompound() method, use: @property def precompound(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the precompound() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.precompound() method signature", "output": "To call the precompound() method, use: @precompound.setter def precompound(self: Any, precompound: Any). It takes 2 parameters." }, { "instruction": "How do you call the slope() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.slope() method signature", "output": "To call the slope() method, use: @property def slope(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the slope() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.slope() method signature", "output": "To call the slope() method, use: @slope.setter def slope(self: Any, slope: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for kalbachmann operations." }, { "instruction": "How do you call the to_hdf5() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API KalbachMann.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.from_hdf5() method", "output": "The from_hdf5() method generate kalbach-mann distribution from hdf5 data. It's used for kalbachmann operations." }, { "instruction": "How do you call the from_hdf5() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API KalbachMann.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.from_ace() method", "output": "The from_ace() method generate kalbach-mann energy-angle distribution from ace data. It's used for kalbachmann operations." }, { "instruction": "How do you call the from_ace() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any, ldis: Any). It takes 4 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API KalbachMann.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API KalbachMann.from_ace() parameter idx", "output": "The idx parameter index in xss array of the start of the energy distribution data (ldis + locc - 1). It should be a int value." }, { "instruction": "What does the ldis parameter do in the from_ace() method?", "input": "OpenMC Python API KalbachMann.from_ace() parameter ldis", "output": "The ldis parameter index in xss array of the start of the energy distribution block (e.g. jxs[11]). It should be a int value." }, { "instruction": "What does the from_endf() method do in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.from_endf() method", "output": "The from_endf() method generate kalbach-mann distribution from an endf evaluation. if the projectile is a neutron, the slope is calculated when it is not given explicitly. .. versionchanged:: 0.13.1 arguments changed to accommodate slope calculation. It's used for kalbachmann operations." }, { "instruction": "How do you call the from_endf() method in the KalbachMann class?", "input": "OpenMC Python API KalbachMann.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, za_emitted: Any, za_target: Any, projectile_mass: Any). It takes 5 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API KalbachMann.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of the kalbach-mann distribution. It should be a file-like object value." }, { "instruction": "What does the za_emitted parameter do in the from_endf() method?", "input": "OpenMC Python API KalbachMann.from_endf() parameter za_emitted", "output": "The za_emitted parameter za identifier of the emitted particle. It should be a int value." }, { "instruction": "What does the za_target parameter do in the from_endf() method?", "input": "OpenMC Python API KalbachMann.from_endf() parameter za_target", "output": "The za_target parameter za identifier of the target. It should be a int value." }, { "instruction": "What does the projectile_mass parameter do in the from_endf() method?", "input": "OpenMC Python API KalbachMann.from_endf() parameter projectile_mass", "output": "The projectile_mass parameter mass of the projectile. It should be a float value." }, { "instruction": "What does the _separation_energy() function do in OpenMC's Python API?", "input": "OpenMC Python API _separation_energy() function", "output": "The _separation_energy() function calculates the separation energy as defined in endf-6 manual bnl-203218-2018-inre, revision 215, file 6 description for law=1 and lang=2. this function can be used for the incident or emitted particle of the following reaction: a + a -> c -> b + b. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _separation_energy() function in OpenMC's Python API?", "input": "OpenMC Python API _separation_energy() function purpose", "output": "The _separation_energy() function calculates the separation energy as defined in endf-6 manual bnl-203218-2018-inre, revision 215, file 6 description for law=1 and lang=2. this function can be used for the incident or emitted particle of the following reaction: a + a -> c -> b + b. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _separation_energy() function in OpenMC's Python API?", "input": "OpenMC Python API _separation_energy() function signature", "output": "To call the _separation_energy() function, use: def _separation_energy(compound: Any, nucleus: Any, particle: Any). It takes 3 parameters." }, { "instruction": "What does the compound parameter do in the _separation_energy() function?", "input": "OpenMC Python API _separation_energy() parameter compound", "output": "The compound parameter atomic representation of the compound (c). It should be a _AtomicRepresentation value." }, { "instruction": "What does the nucleus parameter do in the _separation_energy() function?", "input": "OpenMC Python API _separation_energy() parameter nucleus", "output": "The nucleus parameter atomic representation of the nucleus (a or b). It should be a _AtomicRepresentation value." }, { "instruction": "What does the particle parameter do in the _separation_energy() function?", "input": "OpenMC Python API _separation_energy() parameter particle", "output": "The particle parameter atomic representation of the particle (a or b). It should be a _AtomicRepresentation value." }, { "instruction": "What does the _separation_energy() function return in OpenMC's Python API?", "input": "OpenMC Python API _separation_energy() return value", "output": "The _separation_energy() function returns separation energy in mev. The return type is float." }, { "instruction": "What does the kalbach_slope() function do in OpenMC's Python API?", "input": "OpenMC Python API kalbach_slope() function", "output": "The kalbach_slope() function returns kalbach-mann slope from calculations. the associated reaction is defined as: a + a -> c -> b + b where: - a is the targeted nucleus, - a is the projectile, - c is the compound, - b is the residual nucleus, - b is the emitted particle. the kalbach-mann slope calculation is done as defined in endf-6 manual bnl-203218-2018-inre, revision 215, file 6 description for law=1 and lang=2. one exception to this, is that the entrance and emission channel energies are not calculated with the awr number, but approximated with the number of mass instead. .. versionadded:: 0.13.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the kalbach_slope() function in OpenMC's Python API?", "input": "OpenMC Python API kalbach_slope() function purpose", "output": "The kalbach_slope() function returns kalbach-mann slope from calculations. the associated reaction is defined as: a + a -> c -> b + b where: - a is the targeted nucleus, - a is the projectile, - c is the compound, - b is the residual nucleus, - b is the emitted particle. the kalbach-mann slope calculation is done as defined in endf-6 manual bnl-203218-2018-inre, revision 215, file 6 description for law=1 and lang=2. one exception to this, is that the entrance and emission channel energies are not calculated with the awr number, but approximated with the number of mass instead. .. versionadded:: 0.13.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the kalbach_slope() function in OpenMC's Python API?", "input": "OpenMC Python API kalbach_slope() function signature", "output": "To call the kalbach_slope() function, use: def kalbach_slope(energy_projectile: Any, energy_emitted: Any, za_projectile: Any, za_emitted: Any, za_target: Any). It takes 5 parameters." }, { "instruction": "What does the energy_projectile parameter do in the kalbach_slope() function?", "input": "OpenMC Python API kalbach_slope() parameter energy_projectile", "output": "The energy_projectile parameter energy of the projectile in the laboratory system in ev. It should be a float value." }, { "instruction": "What does the energy_emitted parameter do in the kalbach_slope() function?", "input": "OpenMC Python API kalbach_slope() parameter energy_emitted", "output": "The energy_emitted parameter energy of the emitted particle in the center of mass system in ev. It should be a float value." }, { "instruction": "What does the za_projectile parameter do in the kalbach_slope() function?", "input": "OpenMC Python API kalbach_slope() parameter za_projectile", "output": "The za_projectile parameter za identifier of the projectile. It should be a int value." }, { "instruction": "What does the za_emitted parameter do in the kalbach_slope() function?", "input": "OpenMC Python API kalbach_slope() parameter za_emitted", "output": "The za_emitted parameter za identifier of the emitted particle. It should be a int value." }, { "instruction": "What does the za_target parameter do in the kalbach_slope() function?", "input": "OpenMC Python API kalbach_slope() parameter za_target", "output": "The za_target parameter za identifier of the targeted nucleus. It should be a int value." }, { "instruction": "What does the kalbach_slope() function return in OpenMC's Python API?", "input": "OpenMC Python API kalbach_slope() return value", "output": "The kalbach_slope() function returns kalbach-mann slope given with the same format as ace file.. The return type is float." }, { "instruction": "What is the LaboratoryAngleEnergy class in OpenMC's Python API?", "input": "OpenMC Python API LaboratoryAngleEnergy class", "output": "The LaboratoryAngleEnergy class represents laboratory angle-energy distribution. It provides 13 methods and 0 properties for working with laboratoryangleenergy data in OpenMC." }, { "instruction": "What does the LaboratoryAngleEnergy class do in OpenMC's Python API?", "input": "OpenMC Python API LaboratoryAngleEnergy class description", "output": "The LaboratoryAngleEnergy class laboratory angle-energy distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the breakpoints parameter do when creating a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy constructor parameter breakpoints", "output": "When creating a LaboratoryAngleEnergy, the breakpoints parameter specifies breakpoints defining interpolation regions. It should be a Iterable of int value." }, { "instruction": "What does the interpolation parameter do when creating a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy constructor parameter interpolation", "output": "When creating a LaboratoryAngleEnergy, the interpolation parameter specifies interpolation codes. It should be a Iterable of int value." }, { "instruction": "What does the energy parameter do when creating a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy constructor parameter energy", "output": "When creating a LaboratoryAngleEnergy, the energy parameter specifies incoming energies at which distributions exist. It should be a Iterable of float value." }, { "instruction": "What does the mu parameter do when creating a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy constructor parameter mu", "output": "When creating a LaboratoryAngleEnergy, the mu parameter specifies distribution of scattering cosines for each incoming energy. It should be a Iterable of openmc.stats.Univariate value." }, { "instruction": "What does the energy_out parameter do when creating a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy constructor parameter energy_out", "output": "When creating a LaboratoryAngleEnergy, the energy_out parameter specifies distribution of outgoing energies for each incoming energy/scattering cosine. It should be a Iterable of Iterable of openmc.stats.Univariate value." }, { "instruction": "What is the breakpoints attribute of a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy attribute breakpoints", "output": "The breakpoints attribute of a LaboratoryAngleEnergy contains breakpoints defining interpolation regions. It's a Iterable of int value that you can access after creating a LaboratoryAngleEnergy instance." }, { "instruction": "What is the interpolation attribute of a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy attribute interpolation", "output": "The interpolation attribute of a LaboratoryAngleEnergy contains interpolation codes. It's a Iterable of int value that you can access after creating a LaboratoryAngleEnergy instance." }, { "instruction": "What is the energy attribute of a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy attribute energy", "output": "The energy attribute of a LaboratoryAngleEnergy contains incoming energies at which distributions exist. It's a Iterable of float value that you can access after creating a LaboratoryAngleEnergy instance." }, { "instruction": "What is the mu attribute of a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy attribute mu", "output": "The mu attribute of a LaboratoryAngleEnergy contains distribution of scattering cosines for each incoming energy. It's a Iterable of openmc.stats.Univariate value that you can access after creating a LaboratoryAngleEnergy instance." }, { "instruction": "What is the energy_out attribute of a LaboratoryAngleEnergy?", "input": "OpenMC Python API LaboratoryAngleEnergy attribute energy_out", "output": "The energy_out attribute of a LaboratoryAngleEnergy contains distribution of outgoing energies for each incoming energy/scattering cosine. It's a Iterable of Iterable of openmc.stats.Univariate value that you can access after creating a LaboratoryAngleEnergy instance." }, { "instruction": "How do you call the __init__() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, breakpoints: Any, interpolation: Any, energy: Any, mu: Any, energy_out: Any). It takes 6 parameters." }, { "instruction": "How do you call the breakpoints() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.breakpoints() method signature", "output": "To call the breakpoints() method, use: @property def breakpoints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the breakpoints() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.breakpoints() method signature", "output": "To call the breakpoints() method, use: @breakpoints.setter def breakpoints(self: Any, breakpoints: Any). It takes 2 parameters." }, { "instruction": "How do you call the interpolation() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interpolation: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the mu() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.mu() method signature", "output": "To call the mu() method, use: @property def mu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mu() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.mu() method signature", "output": "To call the mu() method, use: @mu.setter def mu(self: Any, mu: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_out() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.energy_out() method signature", "output": "To call the energy_out() method, use: @property def energy_out(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_out() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.energy_out() method signature", "output": "To call the energy_out() method, use: @energy_out.setter def energy_out(self: Any, energy_out: Any). It takes 2 parameters." }, { "instruction": "What does the from_endf() method do in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.from_endf() method", "output": "The from_endf() method generate laboratory angle-energy distribution from an endf evaluation. It's used for laboratoryangleenergy operations." }, { "instruction": "How do you call the from_endf() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any). It takes 2 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API LaboratoryAngleEnergy.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the start of a section for a correlated angle-energy distribution. It should be a file-like object value." }, { "instruction": "How do you call the to_hdf5() method in the LaboratoryAngleEnergy class?", "input": "OpenMC Python API LaboratoryAngleEnergy.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What is the DataLibrary class in OpenMC's Python API?", "input": "OpenMC Python API DataLibrary class", "output": "The DataLibrary class represents collection of cross section data libraries.\n\n this class behaves like a list where each item is a dictionary summarizing\n cross section data from a single file. the dictionary has keys 'path',\n 'type', and 'materials'.\n\n .. versionchanged:: 0.14.0\n this class now behaves like a list rather than requiring you to access\n the list of libraries through a special attribute.. It provides 7 methods and 0 properties for working with datalibrary data in OpenMC." }, { "instruction": "What does the DataLibrary class do in OpenMC's Python API?", "input": "OpenMC Python API DataLibrary class description", "output": "The DataLibrary class collection of cross section data libraries.\n\n this class behaves like a list where each item is a dictionary summarizing\n cross section data from a single file. the dictionary has keys 'path',\n 'type', and 'materials'.\n\n .. versionchanged:: 0.14.0\n this class now behaves like a list rather than requiring you to access\n the list of libraries through a special attribute.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the libraries() method in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.libraries() method signature", "output": "To call the libraries() method, use: @property def libraries(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_by_material() method do in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.get_by_material() method", "output": "The get_by_material() method return the library dictionary containing a given material. It's used for datalibrary operations." }, { "instruction": "How do you call the get_by_material() method in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.get_by_material() method signature", "output": "To call the get_by_material() method, use: def get_by_material(self: Any, name: Any, data_type: Any). It takes 3 parameters." }, { "instruction": "What does the name parameter do in the get_by_material() method?", "input": "OpenMC Python API DataLibrary.get_by_material() parameter name", "output": "The name parameter name of material, e.g. 'am241'. It should be a str value." }, { "instruction": "What does the data_type parameter do in the get_by_material() method?", "input": "OpenMC Python API DataLibrary.get_by_material() parameter data_type", "output": "The data_type parameter name of data type, e.g. 'neutron', 'photon', 'wmp', or 'thermal' .. versionadded:: 0.12. It should be a str value." }, { "instruction": "What does the get_by_material() method return in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.get_by_material() return value", "output": "The get_by_material() method returns dictionary summarizing cross section data from a single file; the dictionary has keys 'path', 'type', and 'materials'.. The return type is dict or None." }, { "instruction": "What does the remove_by_material() method do in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.remove_by_material() method", "output": "The remove_by_material() method remove the library dictionary containing a specific material. It's used for datalibrary operations." }, { "instruction": "How do you call the remove_by_material() method in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.remove_by_material() method signature", "output": "To call the remove_by_material() method, use: def remove_by_material(self: Any, name: str, data_type: Any). It takes 3 parameters." }, { "instruction": "What does the name parameter do in the remove_by_material() method?", "input": "OpenMC Python API DataLibrary.remove_by_material() parameter name", "output": "The name parameter name of material, e.g. 'am241'. It should be a str value." }, { "instruction": "What does the data_type parameter do in the remove_by_material() method?", "input": "OpenMC Python API DataLibrary.remove_by_material() parameter data_type", "output": "The data_type parameter name of data type, e.g. 'neutron', 'photon', 'wmp', or 'thermal'. It should be a str value." }, { "instruction": "What does the register_file() method do in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.register_file() method", "output": "The register_file() method register a file with the data library. It's used for datalibrary operations." }, { "instruction": "How do you call the register_file() method in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.register_file() method signature", "output": "To call the register_file() method, use: def register_file(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the register_file() method?", "input": "OpenMC Python API DataLibrary.register_file() parameter filename", "output": "The filename parameter path to the file to be registered. if an ``xml`` file, treat as the depletion chain file without materials.. It should be a str or Path value." }, { "instruction": "What does the export_to_xml() method do in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.export_to_xml() method", "output": "The export_to_xml() method export cross section data library to an xml file. It's used for datalibrary operations." }, { "instruction": "How do you call the export_to_xml() method in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the export_to_xml() method?", "input": "OpenMC Python API DataLibrary.export_to_xml() parameter path", "output": "The path parameter path to file to write. defaults to 'cross_sections.xml'.. It should be a str value." }, { "instruction": "What does the from_xml() method do in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.from_xml() method", "output": "The from_xml() method read cross section data library from an xml file. It's used for datalibrary operations." }, { "instruction": "How do you call the from_xml() method in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the from_xml() method?", "input": "OpenMC Python API DataLibrary.from_xml() parameter path", "output": "The path parameter path to xml file to read. if not provided, openmc.config['cross_sections'] will be used.. It should be a str, optional value." }, { "instruction": "What does the from_xml() method return in the DataLibrary class?", "input": "OpenMC Python API DataLibrary.from_xml() return value", "output": "The from_xml() method returns data library object initialized from the provided xml. The return type is openmc.data.DataLibrary." }, { "instruction": "What is the WindowedMultipole class in OpenMC's Python API?", "input": "OpenMC Python API WindowedMultipole class", "output": "The WindowedMultipole class represents resonant cross sections represented in the windowed multipole format. It provides 30 methods and 0 properties for working with windowedmultipole data in OpenMC." }, { "instruction": "What does the WindowedMultipole class do in OpenMC's Python API?", "input": "OpenMC Python API WindowedMultipole class description", "output": "The WindowedMultipole class resonant cross sections represented in the windowed multipole format. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole constructor parameter name", "output": "When creating a WindowedMultipole, the name parameter specifies name of the nuclide using the gnds naming convention. It should be a str value." }, { "instruction": "What is the name attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute name", "output": "The name attribute of a WindowedMultipole contains name of the nuclide using the gnds naming convention. It's a str value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the spacing attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute spacing", "output": "The spacing attribute of a WindowedMultipole contains the width of each window in sqrt(e)-space. for example, the frst window will end at (sqrt(e_min) + spacing)**2 and the second window at (sqrt(e_min) + 2*spacing)**2.. It's a float value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the sqrtAWR attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute sqrtAWR", "output": "The sqrtAWR attribute of a WindowedMultipole contains square root of the atomic weight ratio of the target nuclide.. It's a float value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the E_min attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute E_min", "output": "The E_min attribute of a WindowedMultipole contains lowest energy in ev the library is valid for.. It's a float value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the E_max attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute E_max", "output": "The E_max attribute of a WindowedMultipole contains highest energy in ev the library is valid for.. It's a float value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the data attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute data", "output": "The data attribute of a WindowedMultipole contains a 2d array of complex poles and residues. data[i, 0] gives the energy at which pole i is located. data[i, 1:] gives the residues associated with the i-th pole. there are 3 residues, one each for the scattering, absorption, and fission channels.. It's a np.ndarray value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the windows attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute windows", "output": "The windows attribute of a WindowedMultipole contains a 2d array of integral values. windows[i, 0] - 1 is the index of the first pole in window i. windows[i, 1] - 1 is the index of the last pole in window i.. It's a np.ndarray value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the broaden_poly attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute broaden_poly", "output": "The broaden_poly attribute of a WindowedMultipole contains a 1d array of boolean values indicating whether or not the polynomial curvefit in that window should be doppler broadened.. It's a np.ndarray value that you can access after creating a WindowedMultipole instance." }, { "instruction": "What is the curvefit attribute of a WindowedMultipole?", "input": "OpenMC Python API WindowedMultipole attribute curvefit", "output": "The curvefit attribute of a WindowedMultipole contains a 3d array of real curvefit polynomial coefficients. curvefit[i, 0, :] gives coefficients for the scattering cross section in window i. curvefit[i, 1, :] gives absorption coefficients and curvefit[i, 2, :] gives fission coefficients. the polynomial terms are increasing powers of sqrt(e) starting with 1/e e.g: a/e + b/sqrt(e) + c + d sqrt(e) + .... It's a np.ndarray value that you can access after creating a WindowedMultipole instance." }, { "instruction": "How do you call the __init__() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the fit_order() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.fit_order() method signature", "output": "To call the fit_order() method, use: @property def fit_order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fissionable() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.fissionable() method signature", "output": "To call the fissionable() method, use: @property def fissionable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_poles() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.n_poles() method signature", "output": "To call the n_poles() method, use: @property def n_poles(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_windows() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.n_windows() method signature", "output": "To call the n_windows() method, use: @property def n_windows(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the poles_per_window() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.poles_per_window() method signature", "output": "To call the poles_per_window() method, use: @property def poles_per_window(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the spacing() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.spacing() method signature", "output": "To call the spacing() method, use: @property def spacing(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the spacing() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.spacing() method signature", "output": "To call the spacing() method, use: @spacing.setter def spacing(self: Any, spacing: Any). It takes 2 parameters." }, { "instruction": "How do you call the sqrtAWR() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.sqrtAWR() method signature", "output": "To call the sqrtAWR() method, use: @property def sqrtAWR(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sqrtAWR() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.sqrtAWR() method signature", "output": "To call the sqrtAWR() method, use: @sqrtAWR.setter def sqrtAWR(self: Any, sqrtAWR: Any). It takes 2 parameters." }, { "instruction": "How do you call the E_min() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.E_min() method signature", "output": "To call the E_min() method, use: @property def E_min(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the E_min() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.E_min() method signature", "output": "To call the E_min() method, use: @E_min.setter def E_min(self: Any, E_min: Any). It takes 2 parameters." }, { "instruction": "How do you call the E_max() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.E_max() method signature", "output": "To call the E_max() method, use: @property def E_max(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the E_max() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.E_max() method signature", "output": "To call the E_max() method, use: @E_max.setter def E_max(self: Any, E_max: Any). It takes 2 parameters." }, { "instruction": "How do you call the data() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.data() method signature", "output": "To call the data() method, use: @property def data(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the data() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.data() method signature", "output": "To call the data() method, use: @data.setter def data(self: Any, data: Any). It takes 2 parameters." }, { "instruction": "How do you call the windows() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.windows() method signature", "output": "To call the windows() method, use: @property def windows(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the windows() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.windows() method signature", "output": "To call the windows() method, use: @windows.setter def windows(self: Any, windows: Any). It takes 2 parameters." }, { "instruction": "How do you call the broaden_poly() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.broaden_poly() method signature", "output": "To call the broaden_poly() method, use: @property def broaden_poly(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the broaden_poly() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.broaden_poly() method signature", "output": "To call the broaden_poly() method, use: @broaden_poly.setter def broaden_poly(self: Any, broaden_poly: Any). It takes 2 parameters." }, { "instruction": "How do you call the curvefit() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.curvefit() method signature", "output": "To call the curvefit() method, use: @property def curvefit(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the curvefit() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.curvefit() method signature", "output": "To call the curvefit() method, use: @curvefit.setter def curvefit(self: Any, curvefit: Any). It takes 2 parameters." }, { "instruction": "What does the from_hdf5() method do in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.from_hdf5() method", "output": "The from_hdf5() method construct a windowedmultipole object from an hdf5 group or file. It's used for windowedmultipole operations." }, { "instruction": "How do you call the from_hdf5() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the group_or_filename parameter do in the from_hdf5() method?", "input": "OpenMC Python API WindowedMultipole.from_hdf5() parameter group_or_filename", "output": "The group_or_filename parameter hdf5 group containing multipole data. if given as a string, it is assumed to be the filename for the hdf5 file, and the first group is used to read from.. It should be a h5py.Group or str value." }, { "instruction": "What does the from_endf() method do in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.from_endf() method", "output": "The from_endf() method generate windowed multipole neutron data from an endf evaluation. .. versionadded:: 0.12.1. It's used for windowedmultipole operations." }, { "instruction": "How do you call the from_endf() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, endf_file: Any, log: Any, vf_options: Any, wmp_options: Any). It takes 5 parameters." }, { "instruction": "What does the endf_file parameter do in the from_endf() method?", "input": "OpenMC Python API WindowedMultipole.from_endf() parameter endf_file", "output": "The endf_file parameter path to endf evaluation. It should be a str value." }, { "instruction": "What does the log parameter do in the from_endf() method?", "input": "OpenMC Python API WindowedMultipole.from_endf() parameter log", "output": "The log parameter whether to print running logs (use int for verbosity control). It should be a bool or int, optional value." }, { "instruction": "What does the vf_options parameter do in the from_endf() method?", "input": "OpenMC Python API WindowedMultipole.from_endf() parameter vf_options", "output": "The vf_options parameter dictionary of keyword arguments, e.g. {'njoy_error': 0.001}, passed to :func:`openmc.data.multipole.vectfit_nuclide`. It should be a dict, optional value." }, { "instruction": "What does the wmp_options parameter do in the from_endf() method?", "input": "OpenMC Python API WindowedMultipole.from_endf() parameter wmp_options", "output": "The wmp_options parameter dictionary of keyword arguments, e.g. {'search': true, 'rtol': 0.01}, passed to :func:`openmc.data.windowedmultipole.from_multipole`. It should be a dict, optional value." }, { "instruction": "What does the from_multipole() method do in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.from_multipole() method", "output": "The from_multipole() method generate windowed multipole neutron data from multipole data. It's used for windowedmultipole operations." }, { "instruction": "How do you call the from_multipole() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.from_multipole() method signature", "output": "To call the from_multipole() method, use: @classmethod def from_multipole(cls: Any, mp_data: Any, search: Any, log: Any). It takes 4 parameters." }, { "instruction": "What does the mp_data parameter do in the from_multipole() method?", "input": "OpenMC Python API WindowedMultipole.from_multipole() parameter mp_data", "output": "The mp_data parameter dictionary or path to the multipole data stored in a pickle file. It should be a dictionary or str value." }, { "instruction": "What does the search parameter do in the from_multipole() method?", "input": "OpenMC Python API WindowedMultipole.from_multipole() parameter search", "output": "The search parameter whether to search for optimal window size and curvefit order. defaults to true if no windowing parameters are specified.. It should be a bool, optional value." }, { "instruction": "What does the log parameter do in the from_multipole() method?", "input": "OpenMC Python API WindowedMultipole.from_multipole() parameter log", "output": "The log parameter whether to print running logs (use int for verbosity control) **kwargs keyword arguments passed to :func:`openmc.data.multipole._windowing`. It should be a bool or int, optional value." }, { "instruction": "What does the _evaluate() method do in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole._evaluate() method", "output": "The _evaluate() method compute scattering, absorption, and fission cross sections. It's used for windowedmultipole operations." }, { "instruction": "How do you call the _evaluate() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole._evaluate() method signature", "output": "To call the _evaluate() method, use: def _evaluate(self: Any, E: Any, T: Any). It takes 3 parameters." }, { "instruction": "What does the E parameter do in the _evaluate() method?", "input": "OpenMC Python API WindowedMultipole._evaluate() parameter E", "output": "The E parameter energy of the incident neutron in ev.. It should be a Real value." }, { "instruction": "What does the T parameter do in the _evaluate() method?", "input": "OpenMC Python API WindowedMultipole._evaluate() parameter T", "output": "The T parameter temperature of the target in k.. It should be a Real value." }, { "instruction": "What does the __call__() method do in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.__call__() method", "output": "The __call__() method compute scattering, absorption, and fission cross sections. It's used for windowedmultipole operations." }, { "instruction": "How do you call the __call__() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, E: Any, T: Any). It takes 3 parameters." }, { "instruction": "What does the E parameter do in the __call__() method?", "input": "OpenMC Python API WindowedMultipole.__call__() parameter E", "output": "The E parameter energy of the incident neutron in ev.. It should be a Real or Iterable of Real value." }, { "instruction": "What does the T parameter do in the __call__() method?", "input": "OpenMC Python API WindowedMultipole.__call__() parameter T", "output": "The T parameter temperature of the target in k.. It should be a Real value." }, { "instruction": "What does the export_to_hdf5() method do in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.export_to_hdf5() method", "output": "The export_to_hdf5() method export windowed multipole data to an hdf5 file. It's used for windowedmultipole operations." }, { "instruction": "How do you call the export_to_hdf5() method in the WindowedMultipole class?", "input": "OpenMC Python API WindowedMultipole.export_to_hdf5() method signature", "output": "To call the export_to_hdf5() method, use: def export_to_hdf5(self: Any, path: Any, mode: Any, libver: Any). It takes 4 parameters." }, { "instruction": "What does the path parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API WindowedMultipole.export_to_hdf5() parameter path", "output": "The path parameter path to write hdf5 file to. It should be a str value." }, { "instruction": "What does the mode parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API WindowedMultipole.export_to_hdf5() parameter mode", "output": "The mode parameter mode that is used to open the hdf5 file. this is the second argument to the :class:`h5py.file` constructor.. It should be a {'r+', 'w', 'x', 'a'} value." }, { "instruction": "What does the libver parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API WindowedMultipole.export_to_hdf5() parameter libver", "output": "The libver parameter compatibility mode for the hdf5 file. 'latest' will produce files that are less backwards compatible but have performance benefits.. It should be a {'earliest', 'latest'} value." }, { "instruction": "What does the _faddeeva() function do in OpenMC's Python API?", "input": "OpenMC Python API _faddeeva() function", "output": "The _faddeeva() function evaluate the complex faddeeva function. technically, the value we want is given by the equation: .. math:: w(z) = \\frac{i}{\\pi} \\int_{-\\infty}^{\\infty} \\frac{1}{z - t} \\exp(-t^2) \\text{d}t as shown in equation 63 from hwang, r. n. \"a rigorous pole representation of multilevel cross sections and its practical applications.\" nuclear science and engineering 96.3 (1987): 192-209. the :func:`scipy.special.wofz` function evaluates :math:`w(z) = \\exp(-z^2) \\text{erfc}(-iz)`. these two forms of the faddeeva function are related by a transformation. if we call the integral form :math:`w_\\text{int}`, and the function form :math:`w_\\text{fun}`: .. math:: w_\\text{int}(z) = \\begin{cases} w_\\text{fun}(z) & \\text{for } \\text{im}(z) > 0\\\\ -w_\\text{fun}(z^*)^* & \\text{for } \\text{im}(z) < 0 \\end{cases}. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _faddeeva() function in OpenMC's Python API?", "input": "OpenMC Python API _faddeeva() function purpose", "output": "The _faddeeva() function evaluate the complex faddeeva function. technically, the value we want is given by the equation: .. math:: w(z) = \\frac{i}{\\pi} \\int_{-\\infty}^{\\infty} \\frac{1}{z - t} \\exp(-t^2) \\text{d}t as shown in equation 63 from hwang, r. n. \"a rigorous pole representation of multilevel cross sections and its practical applications.\" nuclear science and engineering 96.3 (1987): 192-209. the :func:`scipy.special.wofz` function evaluates :math:`w(z) = \\exp(-z^2) \\text{erfc}(-iz)`. these two forms of the faddeeva function are related by a transformation. if we call the integral form :math:`w_\\text{int}`, and the function form :math:`w_\\text{fun}`: .. math:: w_\\text{int}(z) = \\begin{cases} w_\\text{fun}(z) & \\text{for } \\text{im}(z) > 0\\\\ -w_\\text{fun}(z^*)^* & \\text{for } \\text{im}(z) < 0 \\end{cases}. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _faddeeva() function in OpenMC's Python API?", "input": "OpenMC Python API _faddeeva() function signature", "output": "To call the _faddeeva() function, use: def _faddeeva(z: Any). It takes 1 parameters." }, { "instruction": "What does the z parameter do in the _faddeeva() function?", "input": "OpenMC Python API _faddeeva() parameter z", "output": "The z parameter argument to the faddeeva function.. It should be a complex value." }, { "instruction": "What does the _broaden_wmp_polynomials() function do in OpenMC's Python API?", "input": "OpenMC Python API _broaden_wmp_polynomials() function", "output": "The _broaden_wmp_polynomials() function evaluate doppler-broadened windowed multipole curvefit. the curvefit is a polynomial of the form :math:`\\frac{a}{e} + \\frac{b}{\\sqrt{e}} + c + d \\sqrt{e} + \\ldots`. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _broaden_wmp_polynomials() function in OpenMC's Python API?", "input": "OpenMC Python API _broaden_wmp_polynomials() function purpose", "output": "The _broaden_wmp_polynomials() function evaluate doppler-broadened windowed multipole curvefit. the curvefit is a polynomial of the form :math:`\\frac{a}{e} + \\frac{b}{\\sqrt{e}} + c + d \\sqrt{e} + \\ldots`. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _broaden_wmp_polynomials() function in OpenMC's Python API?", "input": "OpenMC Python API _broaden_wmp_polynomials() function signature", "output": "To call the _broaden_wmp_polynomials() function, use: def _broaden_wmp_polynomials(E: Any, dopp: Any, n: Any). It takes 3 parameters." }, { "instruction": "What does the E parameter do in the _broaden_wmp_polynomials() function?", "input": "OpenMC Python API _broaden_wmp_polynomials() parameter E", "output": "The E parameter energy to evaluate at.. It should be a float value." }, { "instruction": "What does the dopp parameter do in the _broaden_wmp_polynomials() function?", "input": "OpenMC Python API _broaden_wmp_polynomials() parameter dopp", "output": "The dopp parameter sqrt(atomic weight ratio / kt) in units of ev.. It should be a float value." }, { "instruction": "What does the n parameter do in the _broaden_wmp_polynomials() function?", "input": "OpenMC Python API _broaden_wmp_polynomials() parameter n", "output": "The n parameter number of components to the polynomial.. It should be a int value." }, { "instruction": "What does the _vectfit_xs() function do in OpenMC's Python API?", "input": "OpenMC Python API _vectfit_xs() function", "output": "The _vectfit_xs() function convert point-wise cross section to multipole data via vector fitting. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _vectfit_xs() function in OpenMC's Python API?", "input": "OpenMC Python API _vectfit_xs() function purpose", "output": "The _vectfit_xs() function convert point-wise cross section to multipole data via vector fitting. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _vectfit_xs() function in OpenMC's Python API?", "input": "OpenMC Python API _vectfit_xs() function signature", "output": "To call the _vectfit_xs() function, use: def _vectfit_xs(energy: Any, ce_xs: Any, mts: Any, rtol: Any, atol: Any, orders: Any, n_vf_iter: Any, log: Any, path_out: Any). It takes 9 parameters." }, { "instruction": "What does the energy parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter energy", "output": "The energy parameter energy array. It should be a np.ndarray value." }, { "instruction": "What does the ce_xs parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter ce_xs", "output": "The ce_xs parameter point-wise cross sections to be fitted, with shape (number of reactions, number of energy points). It should be a np.ndarray value." }, { "instruction": "What does the mts parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter mts", "output": "The mts parameter reaction list. It should be a Iterable of int value." }, { "instruction": "What does the rtol parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter rtol", "output": "The rtol parameter relative error tolerance. It should be a float, optional value." }, { "instruction": "What does the atol parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter atol", "output": "The atol parameter absolute error tolerance. It should be a float, optional value." }, { "instruction": "What does the orders parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter orders", "output": "The orders parameter a list of orders (number of poles) to be searched. It should be a Iterable of int, optional value." }, { "instruction": "What does the n_vf_iter parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter n_vf_iter", "output": "The n_vf_iter parameter number of maximum vf iterations. It should be a int, optional value." }, { "instruction": "What does the log parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter log", "output": "The log parameter whether to print running logs (use int for verbosity control). It should be a bool or int, optional value." }, { "instruction": "What does the path_out parameter do in the _vectfit_xs() function?", "input": "OpenMC Python API _vectfit_xs() parameter path_out", "output": "The path_out parameter path to save the figures to show discrepancies between the original and fitted cross sections for different reactions. It should be a str, optional value." }, { "instruction": "What does the vectfit_nuclide() function do in OpenMC's Python API?", "input": "OpenMC Python API vectfit_nuclide() function", "output": "The vectfit_nuclide() function generate multipole data for a nuclide from endf. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the vectfit_nuclide() function in OpenMC's Python API?", "input": "OpenMC Python API vectfit_nuclide() function purpose", "output": "The vectfit_nuclide() function generate multipole data for a nuclide from endf. It's part of OpenMC's Python API." }, { "instruction": "How do you call the vectfit_nuclide() function in OpenMC's Python API?", "input": "OpenMC Python API vectfit_nuclide() function signature", "output": "To call the vectfit_nuclide() function, use: def vectfit_nuclide(endf_file: Any, njoy_error: Any, vf_pieces: Any, log: Any, path_out: Any, mp_filename: Any). It takes 6 parameters." }, { "instruction": "What does the endf_file parameter do in the vectfit_nuclide() function?", "input": "OpenMC Python API vectfit_nuclide() parameter endf_file", "output": "The endf_file parameter path to endf evaluation. It should be a str value." }, { "instruction": "What does the njoy_error parameter do in the vectfit_nuclide() function?", "input": "OpenMC Python API vectfit_nuclide() parameter njoy_error", "output": "The njoy_error parameter fractional error tolerance for processing point-wise data with njoy. It should be a float, optional value." }, { "instruction": "What does the vf_pieces parameter do in the vectfit_nuclide() function?", "input": "OpenMC Python API vectfit_nuclide() parameter vf_pieces", "output": "The vf_pieces parameter number of equal-in-momentum spaced energy pieces for data fitting. It should be a integer, optional value." }, { "instruction": "What does the log parameter do in the vectfit_nuclide() function?", "input": "OpenMC Python API vectfit_nuclide() parameter log", "output": "The log parameter whether to print running logs (use int for verbosity control). It should be a bool or int, optional value." }, { "instruction": "What does the path_out parameter do in the vectfit_nuclide() function?", "input": "OpenMC Python API vectfit_nuclide() parameter path_out", "output": "The path_out parameter path to write out mutipole data file and vector fitting figures. It should be a str, optional value." }, { "instruction": "What does the mp_filename parameter do in the vectfit_nuclide() function?", "input": "OpenMC Python API vectfit_nuclide() parameter mp_filename", "output": "The mp_filename parameter file name to write out multipole data **kwargs keyword arguments passed to :func:`openmc.data.multipole._vectfit_xs`. It should be a str, optional value." }, { "instruction": "What does the _windowing() function do in OpenMC's Python API?", "input": "OpenMC Python API _windowing() function", "output": "The _windowing() function generate windowed multipole library from multipole data with specific settings of window size, curve fit order, etc. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _windowing() function in OpenMC's Python API?", "input": "OpenMC Python API _windowing() function purpose", "output": "The _windowing() function generate windowed multipole library from multipole data with specific settings of window size, curve fit order, etc. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _windowing() function in OpenMC's Python API?", "input": "OpenMC Python API _windowing() function signature", "output": "To call the _windowing() function, use: def _windowing(mp_data: Any, n_cf: Any, rtol: Any, atol: Any, n_win: Any, spacing: Any, log: Any). It takes 7 parameters." }, { "instruction": "What does the mp_data parameter do in the _windowing() function?", "input": "OpenMC Python API _windowing() parameter mp_data", "output": "The mp_data parameter multipole data. It should be a dict value." }, { "instruction": "What does the n_cf parameter do in the _windowing() function?", "input": "OpenMC Python API _windowing() parameter n_cf", "output": "The n_cf parameter curve fitting order. It should be a int value." }, { "instruction": "What does the rtol parameter do in the _windowing() function?", "input": "OpenMC Python API _windowing() parameter rtol", "output": "The rtol parameter maximum relative error tolerance. It should be a float, optional value." }, { "instruction": "What does the atol parameter do in the _windowing() function?", "input": "OpenMC Python API _windowing() parameter atol", "output": "The atol parameter minimum absolute error tolerance. It should be a float, optional value." }, { "instruction": "What does the n_win parameter do in the _windowing() function?", "input": "OpenMC Python API _windowing() parameter n_win", "output": "The n_win parameter number of equal-in-mementum spaced energy windows. It should be a int, optional value." }, { "instruction": "What does the spacing parameter do in the _windowing() function?", "input": "OpenMC Python API _windowing() parameter spacing", "output": "The spacing parameter inner window spacing (sqrt energy space). It should be a float, optional value." }, { "instruction": "What does the log parameter do in the _windowing() function?", "input": "OpenMC Python API _windowing() parameter log", "output": "The log parameter whether to print running logs (use int for verbosity control). It should be a bool or int, optional value." }, { "instruction": "What is the NBodyPhaseSpace class in OpenMC's Python API?", "input": "OpenMC Python API NBodyPhaseSpace class", "output": "The NBodyPhaseSpace class represents n-body phase space distribution. It provides 13 methods and 0 properties for working with nbodyphasespace data in OpenMC." }, { "instruction": "What does the NBodyPhaseSpace class do in OpenMC's Python API?", "input": "OpenMC Python API NBodyPhaseSpace class description", "output": "The NBodyPhaseSpace class n-body phase space distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the total_mass parameter do when creating a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace constructor parameter total_mass", "output": "When creating a NBodyPhaseSpace, the total_mass parameter specifies total mass of product particles. It should be a float value." }, { "instruction": "What does the n_particles parameter do when creating a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace constructor parameter n_particles", "output": "When creating a NBodyPhaseSpace, the n_particles parameter specifies number of product particles. It should be a int value." }, { "instruction": "What does the atomic_weight_ratio parameter do when creating a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace constructor parameter atomic_weight_ratio", "output": "When creating a NBodyPhaseSpace, the atomic_weight_ratio parameter specifies atomic weight ratio of target nuclide. It should be a float value." }, { "instruction": "What does the q_value parameter do when creating a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace constructor parameter q_value", "output": "When creating a NBodyPhaseSpace, the q_value parameter specifies q value for reaction in ev. It should be a float value." }, { "instruction": "What is the total_mass attribute of a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace attribute total_mass", "output": "The total_mass attribute of a NBodyPhaseSpace contains total mass of product particles. It's a float value that you can access after creating a NBodyPhaseSpace instance." }, { "instruction": "What is the n_particles attribute of a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace attribute n_particles", "output": "The n_particles attribute of a NBodyPhaseSpace contains number of product particles. It's a int value that you can access after creating a NBodyPhaseSpace instance." }, { "instruction": "What is the atomic_weight_ratio attribute of a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a NBodyPhaseSpace contains atomic weight ratio of target nuclide. It's a float value that you can access after creating a NBodyPhaseSpace instance." }, { "instruction": "What is the q_value attribute of a NBodyPhaseSpace?", "input": "OpenMC Python API NBodyPhaseSpace attribute q_value", "output": "The q_value attribute of a NBodyPhaseSpace contains q value for reaction in ev. It's a float value that you can access after creating a NBodyPhaseSpace instance." }, { "instruction": "How do you call the __init__() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, total_mass: Any, n_particles: Any, atomic_weight_ratio: Any, q_value: Any). It takes 5 parameters." }, { "instruction": "How do you call the total_mass() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.total_mass() method signature", "output": "To call the total_mass() method, use: @property def total_mass(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the total_mass() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.total_mass() method signature", "output": "To call the total_mass() method, use: @total_mass.setter def total_mass(self: Any, total_mass: Any). It takes 2 parameters." }, { "instruction": "How do you call the n_particles() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.n_particles() method signature", "output": "To call the n_particles() method, use: @property def n_particles(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_particles() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.n_particles() method signature", "output": "To call the n_particles() method, use: @n_particles.setter def n_particles(self: Any, n_particles: Any). It takes 2 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @property def atomic_weight_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @atomic_weight_ratio.setter def atomic_weight_ratio(self: Any, atomic_weight_ratio: Any). It takes 2 parameters." }, { "instruction": "How do you call the q_value() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.q_value() method signature", "output": "To call the q_value() method, use: @property def q_value(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the q_value() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.q_value() method signature", "output": "To call the q_value() method, use: @q_value.setter def q_value(self: Any, q_value: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for nbodyphasespace operations." }, { "instruction": "How do you call the to_hdf5() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API NBodyPhaseSpace.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.from_hdf5() method", "output": "The from_hdf5() method generate n-body phase space distribution from hdf5 data. It's used for nbodyphasespace operations." }, { "instruction": "How do you call the from_hdf5() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API NBodyPhaseSpace.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.from_ace() method", "output": "The from_ace() method generate n-body phase space distribution from ace data. It's used for nbodyphasespace operations." }, { "instruction": "How do you call the from_ace() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, idx: Any, q_value: Any). It takes 4 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API NBodyPhaseSpace.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the idx parameter do in the from_ace() method?", "input": "OpenMC Python API NBodyPhaseSpace.from_ace() parameter idx", "output": "The idx parameter index in xss array of the start of the energy distribution data (ldis + locc - 1). It should be a int value." }, { "instruction": "What does the q_value parameter do in the from_ace() method?", "input": "OpenMC Python API NBodyPhaseSpace.from_ace() parameter q_value", "output": "The q_value parameter q-value for reaction in ev. It should be a float value." }, { "instruction": "What does the from_endf() method do in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.from_endf() method", "output": "The from_endf() method generate n-body phase space distribution from an endf evaluation. It's used for nbodyphasespace operations." }, { "instruction": "How do you call the from_endf() method in the NBodyPhaseSpace class?", "input": "OpenMC Python API NBodyPhaseSpace.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any). It takes 2 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API NBodyPhaseSpace.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positions at the start of the n-body phase space distribution. It should be a file-like object value." }, { "instruction": "What is the IncidentNeutron class in OpenMC's Python API?", "input": "OpenMC Python API IncidentNeutron class", "output": "The IncidentNeutron class represents continuous-energy neutron interaction data. this class stores data derived from an endf-6 format neutron interaction sublibrary. instances of this class are not normally instantiated by the user but rather created using the factory methods :meth:`incidentneutron.from_hdf5`, :meth:`incidentneutron.from_ace`, and :meth:`incidentneutron.from_endf`. It provides 36 methods and 0 properties for working with incidentneutron data in OpenMC." }, { "instruction": "What does the IncidentNeutron class do in OpenMC's Python API?", "input": "OpenMC Python API IncidentNeutron class description", "output": "The IncidentNeutron class continuous-energy neutron interaction data. this class stores data derived from an endf-6 format neutron interaction sublibrary. instances of this class are not normally instantiated by the user but rather created using the factory methods :meth:`incidentneutron.from_hdf5`, :meth:`incidentneutron.from_ace`, and :meth:`incidentneutron.from_endf`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron constructor parameter name", "output": "When creating a IncidentNeutron, the name parameter specifies name of the nuclide using the gnds naming convention. It should be a str value." }, { "instruction": "What does the atomic_number parameter do when creating a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron constructor parameter atomic_number", "output": "When creating a IncidentNeutron, the atomic_number parameter specifies number of protons in the target nucleus. It should be a int value." }, { "instruction": "What does the mass_number parameter do when creating a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron constructor parameter mass_number", "output": "When creating a IncidentNeutron, the mass_number parameter specifies number of nucleons in the target nucleus. It should be a int value." }, { "instruction": "What does the metastable parameter do when creating a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron constructor parameter metastable", "output": "When creating a IncidentNeutron, the metastable parameter specifies metastable state of the target nucleus. a value of zero indicates ground state.. It should be a int value." }, { "instruction": "What does the atomic_weight_ratio parameter do when creating a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron constructor parameter atomic_weight_ratio", "output": "When creating a IncidentNeutron, the atomic_weight_ratio parameter specifies atomic mass ratio of the target nuclide.. It should be a float value." }, { "instruction": "What does the kTs parameter do when creating a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron constructor parameter kTs", "output": "When creating a IncidentNeutron, the kTs parameter specifies list of temperatures of the target nuclide in the data set. the temperatures have units of ev.. It should be a Iterable of float value." }, { "instruction": "What is the atomic_number attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute atomic_number", "output": "The atomic_number attribute of a IncidentNeutron contains number of protons in the target nucleus. It's a int value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the atomic_symbol attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute atomic_symbol", "output": "The atomic_symbol attribute of a IncidentNeutron contains atomic symbol of the nuclide, e.g., 'zr'. It's a str value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the atomic_weight_ratio attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a IncidentNeutron contains atomic weight ratio of the target nuclide.. It's a float value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the fission_energy attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute fission_energy", "output": "The fission_energy attribute of a IncidentNeutron contains the energy released by fission, tabulated by component (e.g. prompt neutrons or beta particles) and dependent on incident neutron energy. It's a None or openmc.data.FissionEnergyRelease value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the mass_number attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute mass_number", "output": "The mass_number attribute of a IncidentNeutron contains number of nucleons in the target nucleus. It's a int value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the metastable attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute metastable", "output": "The metastable attribute of a IncidentNeutron contains metastable state of the target nucleus. a value of zero indicates ground state.. It's a int value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the name attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute name", "output": "The name attribute of a IncidentNeutron contains name of the nuclide using the gnds naming convention. It's a str value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the reactions attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute reactions", "output": "The reactions attribute of a IncidentNeutron contains contains the cross sections, secondary angle and energy distributions, and other associated data for each reaction. the keys are the mt values and the values are reaction objects.. It's a dict value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the resonances attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute resonances", "output": "The resonances attribute of a IncidentNeutron contains resonance parameters. It's a openmc.data.Resonances or None value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the resonance_covariance attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute resonance_covariance", "output": "The resonance_covariance attribute of a IncidentNeutron contains covariance for resonance parameters. It's a openmc.data.ResonanceCovariance or None value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the temperatures attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute temperatures", "output": "The temperatures attribute of a IncidentNeutron contains list of string representations of the temperatures of the target nuclide in the data set. the temperatures are strings of the temperature, rounded to the nearest integer; e.g., '294k'. It's a list of str value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the kTs attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute kTs", "output": "The kTs attribute of a IncidentNeutron contains list of temperatures of the target nuclide in the data set. the temperatures have units of ev.. It's a Iterable of float value that you can access after creating a IncidentNeutron instance." }, { "instruction": "What is the urr attribute of a IncidentNeutron?", "input": "OpenMC Python API IncidentNeutron attribute urr", "output": "The urr attribute of a IncidentNeutron contains dictionary whose keys are temperatures (e.g., '294k') and values are unresolved resonance region probability tables.. It's a dict value that you can access after creating a IncidentNeutron instance." }, { "instruction": "How do you call the __init__() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, name: Any, atomic_number: Any, mass_number: Any, metastable: Any, atomic_weight_ratio: Any, kTs: Any). It takes 7 parameters." }, { "instruction": "How do you call the __contains__() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "How do you call the __getitem__() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __iter__() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the atomic_number() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.atomic_number() method signature", "output": "To call the atomic_number() method, use: @property def atomic_number(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_number() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.atomic_number() method signature", "output": "To call the atomic_number() method, use: @atomic_number.setter def atomic_number(self: Any, atomic_number: Any). It takes 2 parameters." }, { "instruction": "How do you call the mass_number() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.mass_number() method signature", "output": "To call the mass_number() method, use: @property def mass_number(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mass_number() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.mass_number() method signature", "output": "To call the mass_number() method, use: @mass_number.setter def mass_number(self: Any, mass_number: Any). It takes 2 parameters." }, { "instruction": "How do you call the metastable() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.metastable() method signature", "output": "To call the metastable() method, use: @property def metastable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the metastable() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.metastable() method signature", "output": "To call the metastable() method, use: @metastable.setter def metastable(self: Any, metastable: Any). It takes 2 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @property def atomic_weight_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @atomic_weight_ratio.setter def atomic_weight_ratio(self: Any, atomic_weight_ratio: Any). It takes 2 parameters." }, { "instruction": "How do you call the fission_energy() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.fission_energy() method signature", "output": "To call the fission_energy() method, use: @property def fission_energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fission_energy() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.fission_energy() method signature", "output": "To call the fission_energy() method, use: @fission_energy.setter def fission_energy(self: Any, fission_energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the reactions() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.reactions() method signature", "output": "To call the reactions() method, use: @property def reactions(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the reactions() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.reactions() method signature", "output": "To call the reactions() method, use: @reactions.setter def reactions(self: Any, reactions: Any). It takes 2 parameters." }, { "instruction": "How do you call the resonances() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.resonances() method signature", "output": "To call the resonances() method, use: @property def resonances(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the resonances() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.resonances() method signature", "output": "To call the resonances() method, use: @resonances.setter def resonances(self: Any, resonances: Any). It takes 2 parameters." }, { "instruction": "How do you call the resonance_covariance() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.resonance_covariance() method signature", "output": "To call the resonance_covariance() method, use: @property def resonance_covariance(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the resonance_covariance() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.resonance_covariance() method signature", "output": "To call the resonance_covariance() method, use: @resonance_covariance.setter def resonance_covariance(self: Any, resonance_covariance: Any). It takes 2 parameters." }, { "instruction": "How do you call the urr() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.urr() method signature", "output": "To call the urr() method, use: @property def urr(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the urr() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.urr() method signature", "output": "To call the urr() method, use: @urr.setter def urr(self: Any, urr: Any). It takes 2 parameters." }, { "instruction": "How do you call the temperatures() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.temperatures() method signature", "output": "To call the temperatures() method, use: @property def temperatures(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_symbol() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.atomic_symbol() method signature", "output": "To call the atomic_symbol() method, use: @property def atomic_symbol(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_temperature_from_ace() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.add_temperature_from_ace() method", "output": "The add_temperature_from_ace() method append data from an ace file at a different temperature. It's used for incidentneutron operations." }, { "instruction": "How do you call the add_temperature_from_ace() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.add_temperature_from_ace() method signature", "output": "To call the add_temperature_from_ace() method, use: def add_temperature_from_ace(self: Any, ace_or_filename: Any, metastable_scheme: Any). It takes 3 parameters." }, { "instruction": "What does the ace_or_filename parameter do in the add_temperature_from_ace() method?", "input": "OpenMC Python API IncidentNeutron.add_temperature_from_ace() parameter ace_or_filename", "output": "The ace_or_filename parameter ace table to read from. if given as a string, it is assumed to be the filename for the ace file.. It should be a openmc.data.ace.Table or str value." }, { "instruction": "What does the metastable_scheme parameter do in the add_temperature_from_ace() method?", "input": "OpenMC Python API IncidentNeutron.add_temperature_from_ace() parameter metastable_scheme", "output": "The metastable_scheme parameter determine how zaid identifiers are to be interpreted in the case of a metastable nuclide. because the normal zaid (=1000*z + a) does not encode metastable information, different conventions are used among different libraries. in mcnp libraries, the convention is to add 400 for a metastable nuclide except for am242m, for which 95242 is metastable and 95642 (or 1095242 in newer libraries) is the ground state. for nndc libraries, zaid is given as 1000*z + a + 100*m.. It should be a {'nndc', 'mcnp'} value." }, { "instruction": "What does the add_elastic_0K_from_endf() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.add_elastic_0K_from_endf() method", "output": "The add_elastic_0K_from_endf() method append 0k elastic scattering cross section from an endf file. It's used for incidentneutron operations." }, { "instruction": "How do you call the add_elastic_0K_from_endf() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.add_elastic_0K_from_endf() method signature", "output": "To call the add_elastic_0K_from_endf() method, use: def add_elastic_0K_from_endf(self: Any, filename: Any, overwrite: Any). It takes 3 parameters." }, { "instruction": "What does the filename parameter do in the add_elastic_0K_from_endf() method?", "input": "OpenMC Python API IncidentNeutron.add_elastic_0K_from_endf() parameter filename", "output": "The filename parameter path to endf file. It should be a str value." }, { "instruction": "What does the overwrite parameter do in the add_elastic_0K_from_endf() method?", "input": "OpenMC Python API IncidentNeutron.add_elastic_0K_from_endf() parameter overwrite", "output": "The overwrite parameter if existing 0 k data is present, this flag can be used to indicate that it should be overwritten. otherwise, an exception will be thrown. **kwargs keyword arguments passed to :func:`openmc.data.njoy.make_pendf`. It should be a bool value." }, { "instruction": "What does the get_reaction_components() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.get_reaction_components() method", "output": "The get_reaction_components() method determine what reactions make up redundant reaction. It's used for incidentneutron operations." }, { "instruction": "How do you call the get_reaction_components() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.get_reaction_components() method signature", "output": "To call the get_reaction_components() method, use: def get_reaction_components(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "What does the mt parameter do in the get_reaction_components() method?", "input": "OpenMC Python API IncidentNeutron.get_reaction_components() parameter mt", "output": "The mt parameter endf mt number of the reaction to find components of.. It should be a int value." }, { "instruction": "What does the get_reaction_components() method return in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.get_reaction_components() return value", "output": "The get_reaction_components() method returns endf mt numbers of reactions that make up the redundant reaction and have cross sections provided.. The return type is list of int." }, { "instruction": "What does the export_to_hdf5() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.export_to_hdf5() method", "output": "The export_to_hdf5() method export incident neutron data to an hdf5 file. It's used for incidentneutron operations." }, { "instruction": "How do you call the export_to_hdf5() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.export_to_hdf5() method signature", "output": "To call the export_to_hdf5() method, use: def export_to_hdf5(self: Any, path: Any, mode: Any, libver: Any). It takes 4 parameters." }, { "instruction": "What does the path parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API IncidentNeutron.export_to_hdf5() parameter path", "output": "The path parameter path to write hdf5 file to. It should be a str value." }, { "instruction": "What does the mode parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API IncidentNeutron.export_to_hdf5() parameter mode", "output": "The mode parameter mode that is used to open the hdf5 file. this is the second argument to the :class:`h5py.file` constructor.. It should be a {'r+', 'w', 'x', 'a'} value." }, { "instruction": "What does the libver parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API IncidentNeutron.export_to_hdf5() parameter libver", "output": "The libver parameter compatibility mode for the hdf5 file. 'latest' will produce files that are less backwards compatible but have performance benefits.. It should be a {'earliest', 'latest'} value." }, { "instruction": "What does the from_hdf5() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_hdf5() method", "output": "The from_hdf5() method generate continuous-energy neutron interaction data from hdf5 group. It's used for incidentneutron operations." }, { "instruction": "How do you call the from_hdf5() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the group_or_filename parameter do in the from_hdf5() method?", "input": "OpenMC Python API IncidentNeutron.from_hdf5() parameter group_or_filename", "output": "The group_or_filename parameter hdf5 group containing interaction data. if given as a string, it is assumed to be the filename for the hdf5 file, and the first group is used to read from.. It should be a h5py.Group or str value." }, { "instruction": "What does the from_ace() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_ace() method", "output": "The from_ace() method generate incident neutron continuous-energy data from an ace table. It's used for incidentneutron operations." }, { "instruction": "How do you call the from_ace() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace_or_filename: Any, metastable_scheme: Any). It takes 3 parameters." }, { "instruction": "What does the ace_or_filename parameter do in the from_ace() method?", "input": "OpenMC Python API IncidentNeutron.from_ace() parameter ace_or_filename", "output": "The ace_or_filename parameter ace table to read from. if the value is a string, it is assumed to be the filename for the ace file.. It should be a openmc.data.ace.Table or str value." }, { "instruction": "What does the metastable_scheme parameter do in the from_ace() method?", "input": "OpenMC Python API IncidentNeutron.from_ace() parameter metastable_scheme", "output": "The metastable_scheme parameter determine how zaid identifiers are to be interpreted in the case of a metastable nuclide. because the normal zaid (=1000*z + a) does not encode metastable information, different conventions are used among different libraries. in mcnp libraries, the convention is to add 400 for a metastable nuclide except for am242m, for which 95242 is metastable and 95642 (or 1095242 in newer libraries) is the ground state. for nndc libraries, zaid is given as 1000*z + a + 100*m.. It should be a {'nndc', 'mcnp'} value." }, { "instruction": "What does the from_endf() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_endf() method", "output": "The from_endf() method generate incident neutron continuous-energy data from an endf evaluation. It's used for incidentneutron operations." }, { "instruction": "How do you call the from_endf() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev_or_filename: Any, covariance: Any). It takes 3 parameters." }, { "instruction": "What does the ev_or_filename parameter do in the from_endf() method?", "input": "OpenMC Python API IncidentNeutron.from_endf() parameter ev_or_filename", "output": "The ev_or_filename parameter endf evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a openmc.data.endf.Evaluation or str value." }, { "instruction": "What does the covariance parameter do in the from_endf() method?", "input": "OpenMC Python API IncidentNeutron.from_endf() parameter covariance", "output": "The covariance parameter flag to indicate whether or not covariance data from file 32 should be retrieved. It should be a bool value." }, { "instruction": "What does the from_njoy() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_njoy() method", "output": "The from_njoy() method generate incident neutron data by running njoy. It's used for incidentneutron operations." }, { "instruction": "How do you call the from_njoy() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_njoy() method signature", "output": "To call the from_njoy() method, use: @classmethod def from_njoy(cls: Any, filename: Any, temperatures: Any, evaluation: Any). It takes 4 parameters." }, { "instruction": "What does the filename parameter do in the from_njoy() method?", "input": "OpenMC Python API IncidentNeutron.from_njoy() parameter filename", "output": "The filename parameter path to endf file. It should be a str value." }, { "instruction": "What does the temperatures parameter do in the from_njoy() method?", "input": "OpenMC Python API IncidentNeutron.from_njoy() parameter temperatures", "output": "The temperatures parameter temperatures in kelvin to produce data at. if omitted, data is produced at room temperature (293.6 k). It should be a iterable of float value." }, { "instruction": "What does the evaluation parameter do in the from_njoy() method?", "input": "OpenMC Python API IncidentNeutron.from_njoy() parameter evaluation", "output": "The evaluation parameter if the endf file contains multiple material evaluations, this argument indicates which evaluation to use. **kwargs keyword arguments passed to :func:`openmc.data.njoy.make_ace`. It should be a openmc.data.endf.Evaluation, optional value." }, { "instruction": "What does the from_njoy() method return in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron.from_njoy() return value", "output": "The from_njoy() method returns incident neutron continuous-energy data. The return type is openmc.data.IncidentNeutron." }, { "instruction": "What does the _get_redundant_reaction() method do in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron._get_redundant_reaction() method", "output": "The _get_redundant_reaction() method create redundant reaction from its components. It's used for incidentneutron operations." }, { "instruction": "How do you call the _get_redundant_reaction() method in the IncidentNeutron class?", "input": "OpenMC Python API IncidentNeutron._get_redundant_reaction() method signature", "output": "To call the _get_redundant_reaction() method, use: def _get_redundant_reaction(self: Any, mt: Any, mts: Any). It takes 3 parameters." }, { "instruction": "What does the mt parameter do in the _get_redundant_reaction() method?", "input": "OpenMC Python API IncidentNeutron._get_redundant_reaction() parameter mt", "output": "The mt parameter mt value of the desired reaction. It should be a int value." }, { "instruction": "What does the mts parameter do in the _get_redundant_reaction() method?", "input": "OpenMC Python API IncidentNeutron._get_redundant_reaction() parameter mts", "output": "The mts parameter mt values of its components. It should be a iterable of int value." }, { "instruction": "How do you call the get_file3_xs() function in OpenMC's Python API?", "input": "OpenMC Python API get_file3_xs() function signature", "output": "To call the get_file3_xs() function, use: def get_file3_xs(ev: Any, mt: Any, E: Any). It takes 3 parameters." }, { "instruction": "What does the run() function do in OpenMC's Python API?", "input": "OpenMC Python API run() function", "output": "The run() function run njoy with given commands. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the run() function in OpenMC's Python API?", "input": "OpenMC Python API run() function purpose", "output": "The run() function run njoy with given commands. It's part of OpenMC's Python API." }, { "instruction": "How do you call the run() function in OpenMC's Python API?", "input": "OpenMC Python API run() function signature", "output": "To call the run() function, use: def run(commands: Any, tapein: Any, tapeout: Any, input_filename: Any, stdout: Any, njoy_exec: Any). It takes 6 parameters." }, { "instruction": "What does the commands parameter do in the run() function?", "input": "OpenMC Python API run() parameter commands", "output": "The commands parameter input commands for njoy. It should be a str value." }, { "instruction": "What does the tapein parameter do in the run() function?", "input": "OpenMC Python API run() parameter tapein", "output": "The tapein parameter dictionary mapping tape numbers to paths for any input files. It should be a dict value." }, { "instruction": "What does the tapeout parameter do in the run() function?", "input": "OpenMC Python API run() parameter tapeout", "output": "The tapeout parameter dictionary mapping tape numbers to paths for any output files. It should be a dict value." }, { "instruction": "What does the input_filename parameter do in the run() function?", "input": "OpenMC Python API run() parameter input_filename", "output": "The input_filename parameter file name to write out njoy input commands. It should be a str, optional value." }, { "instruction": "What does the stdout parameter do in the run() function?", "input": "OpenMC Python API run() parameter stdout", "output": "The stdout parameter whether to display output when running njoy. It should be a bool, optional value." }, { "instruction": "What does the njoy_exec parameter do in the run() function?", "input": "OpenMC Python API run() parameter njoy_exec", "output": "The njoy_exec parameter path to njoy executable. It should be a str, optional value." }, { "instruction": "What does the make_pendf() function do in OpenMC's Python API?", "input": "OpenMC Python API make_pendf() function", "output": "The make_pendf() function generate pointwise endf file from an endf file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the make_pendf() function in OpenMC's Python API?", "input": "OpenMC Python API make_pendf() function purpose", "output": "The make_pendf() function generate pointwise endf file from an endf file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the make_pendf() function in OpenMC's Python API?", "input": "OpenMC Python API make_pendf() function signature", "output": "To call the make_pendf() function, use: def make_pendf(filename: Any, pendf: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the make_pendf() function?", "input": "OpenMC Python API make_pendf() parameter filename", "output": "The filename parameter path to endf file. It should be a str value." }, { "instruction": "What does the pendf parameter do in the make_pendf() function?", "input": "OpenMC Python API make_pendf() parameter pendf", "output": "The pendf parameter path of pointwise endf file to write **kwargs keyword arguments passed to :func:`openmc.data.njoy.make_ace`. all njoy module arguments other than pendf default to false.. It should be a str, optional value." }, { "instruction": "What does the make_ace() function do in OpenMC's Python API?", "input": "OpenMC Python API make_ace() function", "output": "The make_ace() function generate incident neutron ace file from an endf file file names can be passed to ``[acer, xsdir, pendf, broadr, heatr, gaspr, purr]`` to specify the exact output for the given module. otherwise, the files will be writen to the current directory or directory specified by ``output_dir``. default file names mirror the variable names, e.g. ``heatr`` output will be written to a file named ``heatr`` unless otherwise specified. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the make_ace() function in OpenMC's Python API?", "input": "OpenMC Python API make_ace() function purpose", "output": "The make_ace() function generate incident neutron ace file from an endf file file names can be passed to ``[acer, xsdir, pendf, broadr, heatr, gaspr, purr]`` to specify the exact output for the given module. otherwise, the files will be writen to the current directory or directory specified by ``output_dir``. default file names mirror the variable names, e.g. ``heatr`` output will be written to a file named ``heatr`` unless otherwise specified. It's part of OpenMC's Python API." }, { "instruction": "How do you call the make_ace() function in OpenMC's Python API?", "input": "OpenMC Python API make_ace() function signature", "output": "To call the make_ace() function, use: def make_ace(filename: Any, temperatures: Any, acer: Any, xsdir: Any, output_dir: Any, pendf: Any, error: Any, broadr: Any, heatr: Any, gaspr: Any, purr: Any, evaluation: Any, smoothing: Any). It takes 13 parameters." }, { "instruction": "What does the filename parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter filename", "output": "The filename parameter path to endf file. It should be a str value." }, { "instruction": "What does the temperatures parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter temperatures", "output": "The temperatures parameter temperatures in kelvin to produce ace files at. if omitted, data is produced at room temperature (293.6 k).. It should be a iterable of float, optional value." }, { "instruction": "What does the acer parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter acer", "output": "The acer parameter flag indicating if acer should be run. if a string is give, write the resulting ``ace`` file to this location. path of ace file to write. defaults to ``\"ace\"``. It should be a bool or str, optional value." }, { "instruction": "What does the xsdir parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter xsdir", "output": "The xsdir parameter path of xsdir file to write. defaults to ``\"xsdir\"`` in the same directory as ``acer``. It should be a str, optional value." }, { "instruction": "What does the output_dir parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter output_dir", "output": "The output_dir parameter directory to write output for requested modules. if not provided and at least one of ``[pendf, broadr, heatr, gaspr, purr, acer]`` is ``true``, then write output files to current directory. if given, must be a path to a directory.. It should be a str, optional value." }, { "instruction": "What does the pendf parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter pendf", "output": "The pendf parameter path of pendf file to write. if omitted, the pendf file is not saved.. It should be a str, optional value." }, { "instruction": "What does the error parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter error", "output": "The error parameter fractional error tolerance for njoy processing. It should be a float, optional value." }, { "instruction": "What does the broadr parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter broadr", "output": "The broadr parameter indicating whether to doppler broaden xs when running njoy. if string, write the output tape to this file.. It should be a bool or str, optional value." }, { "instruction": "What does the heatr parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter heatr", "output": "The heatr parameter indicating whether to add heating kerma when running njoy. if string, write the output tape to this file.. It should be a bool or str, optional value." }, { "instruction": "What does the gaspr parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter gaspr", "output": "The gaspr parameter indicating whether to add gas production data when running njoy. if string, write the output tape to this file.. It should be a bool or str, optional value." }, { "instruction": "What does the purr parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter purr", "output": "The purr parameter indicating whether to add probability table when running njoy. if string, write the output tape to this file.. It should be a bool or str, optional value." }, { "instruction": "What does the evaluation parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter evaluation", "output": "The evaluation parameter if the endf file contains multiple material evaluations, this argument indicates which evaluation should be used.. It should be a openmc.data.endf.Evaluation, optional value." }, { "instruction": "What does the smoothing parameter do in the make_ace() function?", "input": "OpenMC Python API make_ace() parameter smoothing", "output": "The smoothing parameter if the smoothing option (acer card 6) is on (true) or off (false). **kwargs keyword arguments passed to :func:`openmc.data.njoy.run`. It should be a bool, optional value." }, { "instruction": "What does the make_ace_thermal() function do in OpenMC's Python API?", "input": "OpenMC Python API make_ace_thermal() function", "output": "The make_ace_thermal() function generate thermal scattering ace file from endf files. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the make_ace_thermal() function in OpenMC's Python API?", "input": "OpenMC Python API make_ace_thermal() function purpose", "output": "The make_ace_thermal() function generate thermal scattering ace file from endf files. It's part of OpenMC's Python API." }, { "instruction": "How do you call the make_ace_thermal() function in OpenMC's Python API?", "input": "OpenMC Python API make_ace_thermal() function signature", "output": "To call the make_ace_thermal() function, use: def make_ace_thermal(filename: Any, filename_thermal: Any, temperatures: Any, ace: Any, xsdir: Any, output_dir: Any, error: Any, iwt: Any, evaluation: Any, evaluation_thermal: Any, table_name: Any, zaids: Any, nmix: Any). It takes 13 parameters." }, { "instruction": "What does the filename parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter filename", "output": "The filename parameter path to endf neutron sublibrary file. It should be a str value." }, { "instruction": "What does the filename_thermal parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter filename_thermal", "output": "The filename_thermal parameter path to endf thermal scattering sublibrary file. It should be a str value." }, { "instruction": "What does the temperatures parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter temperatures", "output": "The temperatures parameter temperatures in kelvin to produce data at. if omitted, data is produced at all temperatures given in the endf thermal scattering sublibrary.. It should be a iterable of float, optional value." }, { "instruction": "What does the ace parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter ace", "output": "The ace parameter path of ace file to write. default to ``\"ace\"``.. It should be a str, optional value." }, { "instruction": "What does the xsdir parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter xsdir", "output": "The xsdir parameter path of xsdir file to write. defaults to ``\"xsdir\"`` in the same directory as ``ace``. It should be a str, optional value." }, { "instruction": "What does the output_dir parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter output_dir", "output": "The output_dir parameter directory to write ace and xsdir files. if not provided, then write output files to current directory. if given, must be a path to a directory.. It should be a str, optional value." }, { "instruction": "What does the error parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter error", "output": "The error parameter fractional error tolerance for njoy processing. It should be a float, optional value." }, { "instruction": "What does the iwt parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter iwt", "output": "The iwt parameter `iwt` parameter used in njoy/acer card 9. It should be a int value." }, { "instruction": "What does the evaluation parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter evaluation", "output": "The evaluation parameter if the endf neutron sublibrary file contains multiple material evaluations, this argument indicates which evaluation to use.. It should be a openmc.data.endf.Evaluation, optional value." }, { "instruction": "What does the evaluation_thermal parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter evaluation_thermal", "output": "The evaluation_thermal parameter if the endf thermal scattering sublibrary file contains multiple material evaluations, this argument indicates which evaluation to use.. It should be a openmc.data.endf.Evaluation, optional value." }, { "instruction": "What does the table_name parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter table_name", "output": "The table_name parameter name to assign to ace table. It should be a str, optional value." }, { "instruction": "What does the zaids parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter zaids", "output": "The zaids parameter zaids that the thermal scattering data applies to. It should be a list of int, optional value." }, { "instruction": "What does the nmix parameter do in the make_ace_thermal() function?", "input": "OpenMC Python API make_ace_thermal() parameter nmix", "output": "The nmix parameter number of atom types in mixed moderator **kwargs keyword arguments passed to :func:`openmc.data.njoy.run`. It should be a int, optional value." }, { "instruction": "What is the AtomicRelaxation class in OpenMC's Python API?", "input": "OpenMC Python API AtomicRelaxation class", "output": "The AtomicRelaxation class represents atomic relaxation data. this class stores the binding energy, number of electrons, and electron transitions possible from ioniziation for each electron subshell of an atom. all of the data originates from an endf-6 atomic relaxation sub-library (nsub=6). instances of this class are not normally instantiated directly but rather created using the factory method :math:`atomicrelaxation.from_endf`. It provides 12 methods and 0 properties for working with atomicrelaxation data in OpenMC." }, { "instruction": "What does the AtomicRelaxation class do in OpenMC's Python API?", "input": "OpenMC Python API AtomicRelaxation class description", "output": "The AtomicRelaxation class atomic relaxation data. this class stores the binding energy, number of electrons, and electron transitions possible from ioniziation for each electron subshell of an atom. all of the data originates from an endf-6 atomic relaxation sub-library (nsub=6). instances of this class are not normally instantiated directly but rather created using the factory method :math:`atomicrelaxation.from_endf`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the binding_energy parameter do when creating a AtomicRelaxation?", "input": "OpenMC Python API AtomicRelaxation constructor parameter binding_energy", "output": "When creating a AtomicRelaxation, the binding_energy parameter specifies dictionary indicating the binding energy in ev (values) for given subshells (keys). the subshells should be given as strings, e.g., 'k', 'l1', 'l2', etc.. It should be a dict value." }, { "instruction": "What does the num_electrons parameter do when creating a AtomicRelaxation?", "input": "OpenMC Python API AtomicRelaxation constructor parameter num_electrons", "output": "When creating a AtomicRelaxation, the num_electrons parameter specifies dictionary indicating the number of electrons in a subshell when neutral (values) for given subshells (keys). the subshells should be given as strings, e.g., 'k', 'l1', 'l2', etc.. It should be a dict value." }, { "instruction": "What does the transitions parameter do when creating a AtomicRelaxation?", "input": "OpenMC Python API AtomicRelaxation constructor parameter transitions", "output": "When creating a AtomicRelaxation, the transitions parameter specifies dictionary indicating allowed transitions and their probabilities (values) for given subshells (keys). the subshells should be given as strings, e.g., 'k', 'l1', 'l2', etc. the transitions are represented as a dataframe with columns indicating the secondary and tertiary subshell, the energy of the transition in ev, and the fractional probability of the transition.. It should be a dict of str to pandas.DataFrame value." }, { "instruction": "What is the binding_energy attribute of a AtomicRelaxation?", "input": "OpenMC Python API AtomicRelaxation attribute binding_energy", "output": "The binding_energy attribute of a AtomicRelaxation contains dictionary indicating the binding energy in ev (values) for given subshells (keys). the subshells should be given as strings, e.g., 'k', 'l1', 'l2', etc.. It's a dict value that you can access after creating a AtomicRelaxation instance." }, { "instruction": "What is the num_electrons attribute of a AtomicRelaxation?", "input": "OpenMC Python API AtomicRelaxation attribute num_electrons", "output": "The num_electrons attribute of a AtomicRelaxation contains dictionary indicating the number of electrons in a subshell when neutral (values) for given subshells (keys). the subshells should be given as strings, e.g., 'k', 'l1', 'l2', etc.. It's a dict value that you can access after creating a AtomicRelaxation instance." }, { "instruction": "What is the subshells attribute of a AtomicRelaxation?", "input": "OpenMC Python API AtomicRelaxation attribute subshells", "output": "The subshells attribute of a AtomicRelaxation contains list of subshells as strings, e.g. ``['k', 'l1', ...]``. It's a list value that you can access after creating a AtomicRelaxation instance." }, { "instruction": "What is the transitions attribute of a AtomicRelaxation?", "input": "OpenMC Python API AtomicRelaxation attribute transitions", "output": "The transitions attribute of a AtomicRelaxation contains dictionary indicating allowed transitions and their probabilities (values) for given subshells (keys). the subshells should be given as strings, e.g., 'k', 'l1', 'l2', etc. the transitions are represented as a dataframe with columns indicating the secondary and tertiary subshell, the energy of the transition in ev, and the fractional probability of the transition. see also -------- incidentphoton. It's a pandas.DataFrame value that you can access after creating a AtomicRelaxation instance." }, { "instruction": "How do you call the __init__() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, binding_energy: Any, num_electrons: Any, transitions: Any). It takes 4 parameters." }, { "instruction": "How do you call the binding_energy() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.binding_energy() method signature", "output": "To call the binding_energy() method, use: @property def binding_energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the binding_energy() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.binding_energy() method signature", "output": "To call the binding_energy() method, use: @binding_energy.setter def binding_energy(self: Any, binding_energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_electrons() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.num_electrons() method signature", "output": "To call the num_electrons() method, use: @property def num_electrons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_electrons() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.num_electrons() method signature", "output": "To call the num_electrons() method, use: @num_electrons.setter def num_electrons(self: Any, num_electrons: Any). It takes 2 parameters." }, { "instruction": "How do you call the subshells() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.subshells() method signature", "output": "To call the subshells() method, use: @property def subshells(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the transitions() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.transitions() method signature", "output": "To call the transitions() method, use: @property def transitions(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the transitions() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.transitions() method signature", "output": "To call the transitions() method, use: @transitions.setter def transitions(self: Any, transitions: Any). It takes 2 parameters." }, { "instruction": "What does the from_ace() method do in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.from_ace() method", "output": "The from_ace() method generate atomic relaxation data from an ace file. It's used for atomicrelaxation operations." }, { "instruction": "How do you call the from_ace() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any). It takes 2 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API AtomicRelaxation.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the from_endf() method do in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.from_endf() method", "output": "The from_endf() method generate atomic relaxation data from an endf evaluation. It's used for atomicrelaxation operations." }, { "instruction": "How do you call the from_endf() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the ev_or_filename parameter do in the from_endf() method?", "input": "OpenMC Python API AtomicRelaxation.from_endf() parameter ev_or_filename", "output": "The ev_or_filename parameter endf atomic relaxation evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a str or openmc.data.endf.Evaluation value." }, { "instruction": "What does the from_hdf5() method do in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.from_hdf5() method", "output": "The from_hdf5() method generate atomic relaxation data from an hdf5 group. It's used for atomicrelaxation operations." }, { "instruction": "How do you call the from_hdf5() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API AtomicRelaxation.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the to_hdf5() method do in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.to_hdf5() method", "output": "The to_hdf5() method write atomic relaxation data to an hdf5 group. It's used for atomicrelaxation operations." }, { "instruction": "How do you call the to_hdf5() method in the AtomicRelaxation class?", "input": "OpenMC Python API AtomicRelaxation.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any, shell: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API AtomicRelaxation.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the shell parameter do in the to_hdf5() method?", "input": "OpenMC Python API AtomicRelaxation.to_hdf5() parameter shell", "output": "The shell parameter the subshell to write data for. It should be a str value." }, { "instruction": "What is the IncidentPhoton class in OpenMC's Python API?", "input": "OpenMC Python API IncidentPhoton class", "output": "The IncidentPhoton class represents photon interaction data. this class stores photo-atomic, photo-nuclear, atomic relaxation, compton profile, stopping power, and bremsstrahlung data assembled from different sources. to create an instance, the factory method :meth:`incidentphoton.from_endf` can be used. to add atomic relaxation or compton profile data, set the :attr:`incidentphoton.atomic_relaxation` and :attr:`incidentphoton.compton_profiles` attributes directly. It provides 15 methods and 0 properties for working with incidentphoton data in OpenMC." }, { "instruction": "What does the IncidentPhoton class do in OpenMC's Python API?", "input": "OpenMC Python API IncidentPhoton class description", "output": "The IncidentPhoton class photon interaction data. this class stores photo-atomic, photo-nuclear, atomic relaxation, compton profile, stopping power, and bremsstrahlung data assembled from different sources. to create an instance, the factory method :meth:`incidentphoton.from_endf` can be used. to add atomic relaxation or compton profile data, set the :attr:`incidentphoton.atomic_relaxation` and :attr:`incidentphoton.compton_profiles` attributes directly. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the atomic_number parameter do when creating a IncidentPhoton?", "input": "OpenMC Python API IncidentPhoton constructor parameter atomic_number", "output": "When creating a IncidentPhoton, the atomic_number parameter specifies number of protons in the target nucleus. It should be a int value." }, { "instruction": "What is the atomic_number attribute of a IncidentPhoton?", "input": "OpenMC Python API IncidentPhoton attribute atomic_number", "output": "The atomic_number attribute of a IncidentPhoton contains number of protons in the target nucleus. It's a int value that you can access after creating a IncidentPhoton instance." }, { "instruction": "What is the atomic_relaxation attribute of a IncidentPhoton?", "input": "OpenMC Python API IncidentPhoton attribute atomic_relaxation", "output": "The atomic_relaxation attribute of a IncidentPhoton contains atomic relaxation data. It's a openmc.data.AtomicRelaxation or None value that you can access after creating a IncidentPhoton instance." }, { "instruction": "What is the bremsstrahlung attribute of a IncidentPhoton?", "input": "OpenMC Python API IncidentPhoton attribute bremsstrahlung", "output": "The bremsstrahlung attribute of a IncidentPhoton contains dictionary of bremsstrahlung data with keys 'i' (mean excitation energy in [ev]), 'num_electrons' (number of electrons in each subshell), 'ionization_energy' (ionization potential of each subshell), 'electron_energy' (incident electron kinetic energy values in [ev]), 'photon_energy' (ratio of the energy of the emitted photon to the incident electron kinetic energy), and 'dcs' (cross section values in [b]). the cross sections are in scaled form: :math:`(\\beta^2/z^2) e_k (d\\sigma/de_k)`, where :math:`e_k` is the energy of the emitted photon. a negative number of electrons in a subshell indicates conduction electrons.. It's a dict value that you can access after creating a IncidentPhoton instance." }, { "instruction": "What is the compton_profiles attribute of a IncidentPhoton?", "input": "OpenMC Python API IncidentPhoton attribute compton_profiles", "output": "The compton_profiles attribute of a IncidentPhoton contains dictionary of compton profile data with keys 'num_electrons' (number of electrons in each subshell), 'binding_energy' (ionization potential of each subshell), and 'j' (hartree-fock compton profile as a function of the projection of the electron momentum on the scattering vector, :math:`p_z` for each subshell). note that subshell occupancies may not match the atomic relaxation data.. It's a dict value that you can access after creating a IncidentPhoton instance." }, { "instruction": "What is the reactions attribute of a IncidentPhoton?", "input": "OpenMC Python API IncidentPhoton attribute reactions", "output": "The reactions attribute of a IncidentPhoton contains contains the cross sections for each photon reaction. the keys are mt values and the values are instances of :class:`photonreaction`.. It's a dict value that you can access after creating a IncidentPhoton instance." }, { "instruction": "How do you call the __init__() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, atomic_number: Any). It takes 2 parameters." }, { "instruction": "How do you call the __contains__() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "How do you call the __getitem__() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __iter__() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_number() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.atomic_number() method signature", "output": "To call the atomic_number() method, use: @property def atomic_number(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_number() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.atomic_number() method signature", "output": "To call the atomic_number() method, use: @atomic_number.setter def atomic_number(self: Any, atomic_number: Any). It takes 2 parameters." }, { "instruction": "How do you call the atomic_relaxation() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.atomic_relaxation() method signature", "output": "To call the atomic_relaxation() method, use: @property def atomic_relaxation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_relaxation() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.atomic_relaxation() method signature", "output": "To call the atomic_relaxation() method, use: @atomic_relaxation.setter def atomic_relaxation(self: Any, atomic_relaxation: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_ace() method do in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.from_ace() method", "output": "The from_ace() method generate incident photon data from an ace table. It's used for incidentphoton operations." }, { "instruction": "How do you call the from_ace() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the ace_or_filename parameter do in the from_ace() method?", "input": "OpenMC Python API IncidentPhoton.from_ace() parameter ace_or_filename", "output": "The ace_or_filename parameter ace table to read from. if given as a string, it is assumed to be the filename for the ace file.. It should be a str or openmc.data.ace.Table value." }, { "instruction": "What does the from_endf() method do in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.from_endf() method", "output": "The from_endf() method generate incident photon data from an endf evaluation. It's used for incidentphoton operations." }, { "instruction": "How do you call the from_endf() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, photoatomic: Any, relaxation: Any). It takes 3 parameters." }, { "instruction": "What does the photoatomic parameter do in the from_endf() method?", "input": "OpenMC Python API IncidentPhoton.from_endf() parameter photoatomic", "output": "The photoatomic parameter endf photoatomic data evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a str or openmc.data.endf.Evaluation value." }, { "instruction": "What does the relaxation parameter do in the from_endf() method?", "input": "OpenMC Python API IncidentPhoton.from_endf() parameter relaxation", "output": "The relaxation parameter endf atomic relaxation data evaluation to read from. if given as a string, it is assumed to be the filename for the endf file.. It should be a str or openmc.data.endf.Evaluation, optional value." }, { "instruction": "What does the from_hdf5() method do in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.from_hdf5() method", "output": "The from_hdf5() method generate photon reaction from an hdf5 group. It's used for incidentphoton operations." }, { "instruction": "How do you call the from_hdf5() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group_or_filename: Any). It takes 2 parameters." }, { "instruction": "What does the group_or_filename parameter do in the from_hdf5() method?", "input": "OpenMC Python API IncidentPhoton.from_hdf5() parameter group_or_filename", "output": "The group_or_filename parameter hdf5 group containing interaction data. if given as a string, it is assumed to be the filename for the hdf5 file, and the first group is used to read from.. It should be a h5py.Group or str value." }, { "instruction": "What does the export_to_hdf5() method do in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.export_to_hdf5() method", "output": "The export_to_hdf5() method export incident photon data to an hdf5 file. It's used for incidentphoton operations." }, { "instruction": "How do you call the export_to_hdf5() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton.export_to_hdf5() method signature", "output": "To call the export_to_hdf5() method, use: def export_to_hdf5(self: Any, path: Any, mode: Any, libver: Any). It takes 4 parameters." }, { "instruction": "What does the path parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API IncidentPhoton.export_to_hdf5() parameter path", "output": "The path parameter path to write hdf5 file to. It should be a str value." }, { "instruction": "What does the mode parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API IncidentPhoton.export_to_hdf5() parameter mode", "output": "The mode parameter mode that is used to open the hdf5 file. this is the second argument to the :class:`h5py.file` constructor.. It should be a {'r+', 'w', 'x', 'a'} value." }, { "instruction": "What does the libver parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API IncidentPhoton.export_to_hdf5() parameter libver", "output": "The libver parameter compatibility mode for the hdf5 file. 'latest' will produce files that are less backwards compatible but have performance benefits.. It should be a {'earliest', 'latest'} value." }, { "instruction": "What does the _add_bremsstrahlung() method do in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton._add_bremsstrahlung() method", "output": "The _add_bremsstrahlung() method add the data used in the thick-target bremsstrahlung approximation. It's used for incidentphoton operations." }, { "instruction": "How do you call the _add_bremsstrahlung() method in the IncidentPhoton class?", "input": "OpenMC Python API IncidentPhoton._add_bremsstrahlung() method signature", "output": "To call the _add_bremsstrahlung() method, use: def _add_bremsstrahlung(self: Any). It takes 1 parameters." }, { "instruction": "What is the PhotonReaction class in OpenMC's Python API?", "input": "OpenMC Python API PhotonReaction class", "output": "The PhotonReaction class represents photon-induced reaction. It provides 14 methods and 0 properties for working with photonreaction data in OpenMC." }, { "instruction": "What does the PhotonReaction class do in OpenMC's Python API?", "input": "OpenMC Python API PhotonReaction class description", "output": "The PhotonReaction class photon-induced reaction. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mt parameter do when creating a PhotonReaction?", "input": "OpenMC Python API PhotonReaction constructor parameter mt", "output": "When creating a PhotonReaction, the mt parameter specifies the endf mt number for this reaction.. It should be a int value." }, { "instruction": "What is the anomalous_real attribute of a PhotonReaction?", "input": "OpenMC Python API PhotonReaction attribute anomalous_real", "output": "The anomalous_real attribute of a PhotonReaction contains real part of the anomalous scattering factor. It's a openmc.data.Tabulated1D value that you can access after creating a PhotonReaction instance." }, { "instruction": "What is the anomlaous_imag attribute of a PhotonReaction?", "input": "OpenMC Python API PhotonReaction attribute anomlaous_imag", "output": "The anomlaous_imag attribute of a PhotonReaction contains imaginary part of the anomalous scatttering factor. It's a openmc.data.Tabulated1D value that you can access after creating a PhotonReaction instance." }, { "instruction": "What is the mt attribute of a PhotonReaction?", "input": "OpenMC Python API PhotonReaction attribute mt", "output": "The mt attribute of a PhotonReaction contains the endf mt number for this reaction.. It's a int value that you can access after creating a PhotonReaction instance." }, { "instruction": "What is the scattering_factor attribute of a PhotonReaction?", "input": "OpenMC Python API PhotonReaction attribute scattering_factor", "output": "The scattering_factor attribute of a PhotonReaction contains coherent or incoherent form factor.. It's a openmc.data.Tabulated1D value that you can access after creating a PhotonReaction instance." }, { "instruction": "What is the xs attribute of a PhotonReaction?", "input": "OpenMC Python API PhotonReaction attribute xs", "output": "The xs attribute of a PhotonReaction contains cross section as a function of incident photon energy. It's a Callable value that you can access after creating a PhotonReaction instance." }, { "instruction": "How do you call the __init__() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the anomalous_real() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.anomalous_real() method signature", "output": "To call the anomalous_real() method, use: @property def anomalous_real(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the anomalous_real() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.anomalous_real() method signature", "output": "To call the anomalous_real() method, use: @anomalous_real.setter def anomalous_real(self: Any, anomalous_real: Any). It takes 2 parameters." }, { "instruction": "How do you call the anomalous_imag() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.anomalous_imag() method signature", "output": "To call the anomalous_imag() method, use: @property def anomalous_imag(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the anomalous_imag() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.anomalous_imag() method signature", "output": "To call the anomalous_imag() method, use: @anomalous_imag.setter def anomalous_imag(self: Any, anomalous_imag: Any). It takes 2 parameters." }, { "instruction": "How do you call the scattering_factor() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.scattering_factor() method signature", "output": "To call the scattering_factor() method, use: @property def scattering_factor(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scattering_factor() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.scattering_factor() method signature", "output": "To call the scattering_factor() method, use: @scattering_factor.setter def scattering_factor(self: Any, scattering_factor: Any). It takes 2 parameters." }, { "instruction": "How do you call the xs() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.xs() method signature", "output": "To call the xs() method, use: @property def xs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.xs() method signature", "output": "To call the xs() method, use: @xs.setter def xs(self: Any, xs: Any). It takes 2 parameters." }, { "instruction": "What does the from_ace() method do in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.from_ace() method", "output": "The from_ace() method generate photon reaction from an ace table. It's used for photonreaction operations." }, { "instruction": "How do you call the from_ace() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, mt: Any). It takes 3 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API PhotonReaction.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the mt parameter do in the from_ace() method?", "input": "OpenMC Python API PhotonReaction.from_ace() parameter mt", "output": "The mt parameter the mt value of the reaction to get data for. It should be a int value." }, { "instruction": "What does the from_endf() method do in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.from_endf() method", "output": "The from_endf() method generate photon reaction from an endf evaluation. It's used for photonreaction operations." }, { "instruction": "How do you call the from_endf() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, mt: Any). It takes 3 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API PhotonReaction.from_endf() parameter ev", "output": "The ev parameter endf photo-atomic interaction data evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the mt parameter do in the from_endf() method?", "input": "OpenMC Python API PhotonReaction.from_endf() parameter mt", "output": "The mt parameter the mt value of the reaction to get data for. It should be a int value." }, { "instruction": "What does the from_hdf5() method do in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.from_hdf5() method", "output": "The from_hdf5() method generate photon reaction from an hdf5 group. It's used for photonreaction operations." }, { "instruction": "How do you call the from_hdf5() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any, mt: Any, energy: Any). It takes 4 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API PhotonReaction.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the mt parameter do in the from_hdf5() method?", "input": "OpenMC Python API PhotonReaction.from_hdf5() parameter mt", "output": "The mt parameter the mt value of the reaction to get data for. It should be a int value." }, { "instruction": "What does the energy parameter do in the from_hdf5() method?", "input": "OpenMC Python API PhotonReaction.from_hdf5() parameter energy", "output": "The energy parameter arrays of energies at which cross sections are tabulated at. It should be a Iterable of float value." }, { "instruction": "What does the to_hdf5() method do in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.to_hdf5() method", "output": "The to_hdf5() method write photon reaction to an hdf5 group. It's used for photonreaction operations." }, { "instruction": "How do you call the to_hdf5() method in the PhotonReaction class?", "input": "OpenMC Python API PhotonReaction.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any, energy: Any, Z: Any). It takes 4 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API PhotonReaction.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the energy parameter do in the to_hdf5() method?", "input": "OpenMC Python API PhotonReaction.to_hdf5() parameter energy", "output": "The energy parameter arrays of energies at which cross sections are tabulated at. It should be a Iterable of float value." }, { "instruction": "What does the Z parameter do in the to_hdf5() method?", "input": "OpenMC Python API PhotonReaction.to_hdf5() parameter Z", "output": "The Z parameter atomic number. It should be a int value." }, { "instruction": "What is the Product class in OpenMC's Python API?", "input": "OpenMC Python API Product class", "output": "The Product class represents secondary particle emitted in a nuclear reaction. It provides 16 methods and 0 properties for working with product data in OpenMC." }, { "instruction": "What does the Product class do in OpenMC's Python API?", "input": "OpenMC Python API Product class description", "output": "The Product class secondary particle emitted in a nuclear reaction. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the particle parameter do when creating a Product?", "input": "OpenMC Python API Product constructor parameter particle", "output": "When creating a Product, the particle parameter specifies the particle type of the reaction product. defaults to 'neutron'.. It should be a str, optional value." }, { "instruction": "What is the applicability attribute of a Product?", "input": "OpenMC Python API Product attribute applicability", "output": "The applicability attribute of a Product contains probability of sampling a given distribution for this product.. It's a Iterable of openmc.data.Tabulated1D value that you can access after creating a Product instance." }, { "instruction": "What is the decay_rate attribute of a Product?", "input": "OpenMC Python API Product attribute decay_rate", "output": "The decay_rate attribute of a Product contains decay rate in inverse seconds. It's a float value that you can access after creating a Product instance." }, { "instruction": "What is the distribution attribute of a Product?", "input": "OpenMC Python API Product attribute distribution", "output": "The distribution attribute of a Product contains distributions of energy and angle of product.. It's a Iterable of openmc.data.AngleEnergy value that you can access after creating a Product instance." }, { "instruction": "What is the emission_mode attribute of a Product?", "input": "OpenMC Python API Product attribute emission_mode", "output": "The emission_mode attribute of a Product contains indicate whether the particle is emitted immediately or whether it results from the decay of reaction product (e.g., neutron emitted from a delayed neutron precursor). a special value of 'total' is used when the yield represents particles from prompt and delayed sources.. It's a {'prompt', 'delayed', 'total'} value that you can access after creating a Product instance." }, { "instruction": "What is the particle attribute of a Product?", "input": "OpenMC Python API Product attribute particle", "output": "The particle attribute of a Product contains the particle type of the reaction product. It's a str value that you can access after creating a Product instance." }, { "instruction": "What is the yield_ attribute of a Product?", "input": "OpenMC Python API Product attribute yield_", "output": "The yield_ attribute of a Product contains yield of secondary particle in the reaction.. It's a openmc.data.Function1D value that you can access after creating a Product instance." }, { "instruction": "How do you call the __init__() method in the Product class?", "input": "OpenMC Python API Product.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, particle: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Product class?", "input": "OpenMC Python API Product.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the applicability() method in the Product class?", "input": "OpenMC Python API Product.applicability() method signature", "output": "To call the applicability() method, use: @property def applicability(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the applicability() method in the Product class?", "input": "OpenMC Python API Product.applicability() method signature", "output": "To call the applicability() method, use: @applicability.setter def applicability(self: Any, applicability: Any). It takes 2 parameters." }, { "instruction": "How do you call the decay_rate() method in the Product class?", "input": "OpenMC Python API Product.decay_rate() method signature", "output": "To call the decay_rate() method, use: @property def decay_rate(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the decay_rate() method in the Product class?", "input": "OpenMC Python API Product.decay_rate() method signature", "output": "To call the decay_rate() method, use: @decay_rate.setter def decay_rate(self: Any, decay_rate: Any). It takes 2 parameters." }, { "instruction": "How do you call the distribution() method in the Product class?", "input": "OpenMC Python API Product.distribution() method signature", "output": "To call the distribution() method, use: @property def distribution(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the distribution() method in the Product class?", "input": "OpenMC Python API Product.distribution() method signature", "output": "To call the distribution() method, use: @distribution.setter def distribution(self: Any, distribution: Any). It takes 2 parameters." }, { "instruction": "How do you call the emission_mode() method in the Product class?", "input": "OpenMC Python API Product.emission_mode() method signature", "output": "To call the emission_mode() method, use: @property def emission_mode(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the emission_mode() method in the Product class?", "input": "OpenMC Python API Product.emission_mode() method signature", "output": "To call the emission_mode() method, use: @emission_mode.setter def emission_mode(self: Any, emission_mode: Any). It takes 2 parameters." }, { "instruction": "How do you call the particle() method in the Product class?", "input": "OpenMC Python API Product.particle() method signature", "output": "To call the particle() method, use: @property def particle(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the particle() method in the Product class?", "input": "OpenMC Python API Product.particle() method signature", "output": "To call the particle() method, use: @particle.setter def particle(self: Any, particle: Any). It takes 2 parameters." }, { "instruction": "How do you call the yield_() method in the Product class?", "input": "OpenMC Python API Product.yield_() method signature", "output": "To call the yield_() method, use: @property def yield_(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the yield_() method in the Product class?", "input": "OpenMC Python API Product.yield_() method signature", "output": "To call the yield_() method, use: @yield_.setter def yield_(self: Any, yield_: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the Product class?", "input": "OpenMC Python API Product.to_hdf5() method", "output": "The to_hdf5() method write product to an hdf5 group. It's used for product operations." }, { "instruction": "How do you call the to_hdf5() method in the Product class?", "input": "OpenMC Python API Product.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API Product.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the Product class?", "input": "OpenMC Python API Product.from_hdf5() method", "output": "The from_hdf5() method generate reaction product from hdf5 data. It's used for product operations." }, { "instruction": "How do you call the from_hdf5() method in the Product class?", "input": "OpenMC Python API Product.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Product.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What is the Reaction class in OpenMC's Python API?", "input": "OpenMC Python API Reaction class", "output": "The Reaction class represents a nuclear reaction a reaction object represents a single reaction channel for a nuclide with an associated cross section and, if present, a secondary angle and energy distribution. It provides 18 methods and 0 properties for working with reaction data in OpenMC." }, { "instruction": "What does the Reaction class do in OpenMC's Python API?", "input": "OpenMC Python API Reaction class description", "output": "The Reaction class a nuclear reaction a reaction object represents a single reaction channel for a nuclide with an associated cross section and, if present, a secondary angle and energy distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mt parameter do when creating a Reaction?", "input": "OpenMC Python API Reaction constructor parameter mt", "output": "When creating a Reaction, the mt parameter specifies the endf mt number for this reaction.. It should be a int value." }, { "instruction": "What is the center_of_mass attribute of a Reaction?", "input": "OpenMC Python API Reaction attribute center_of_mass", "output": "The center_of_mass attribute of a Reaction contains indicates whether scattering kinematics should be performed in the center-of-mass or laboratory reference frame. grid above the threshold value in barns.. It's a bool value that you can access after creating a Reaction instance." }, { "instruction": "What is the redundant attribute of a Reaction?", "input": "OpenMC Python API Reaction attribute redundant", "output": "The redundant attribute of a Reaction contains indicates whether or not this is a redundant reaction. It's a bool value that you can access after creating a Reaction instance." }, { "instruction": "What is the mt attribute of a Reaction?", "input": "OpenMC Python API Reaction attribute mt", "output": "The mt attribute of a Reaction contains the endf mt number for this reaction.. It's a int value that you can access after creating a Reaction instance." }, { "instruction": "What is the q_value attribute of a Reaction?", "input": "OpenMC Python API Reaction attribute q_value", "output": "The q_value attribute of a Reaction contains the q-value of this reaction in ev.. It's a float value that you can access after creating a Reaction instance." }, { "instruction": "What is the xs attribute of a Reaction?", "input": "OpenMC Python API Reaction attribute xs", "output": "The xs attribute of a Reaction contains microscopic cross section for this reaction as a function of incident energy; these cross sections are provided in a dictionary where the key is the temperature of the cross section set.. It's a dict of str to openmc.data.Function1D value that you can access after creating a Reaction instance." }, { "instruction": "What is the products attribute of a Reaction?", "input": "OpenMC Python API Reaction attribute products", "output": "The products attribute of a Reaction contains reaction products. It's a Iterable of openmc.data.Product value that you can access after creating a Reaction instance." }, { "instruction": "What is the derived_products attribute of a Reaction?", "input": "OpenMC Python API Reaction attribute derived_products", "output": "The derived_products attribute of a Reaction contains derived reaction products. used for 'total' fission neutron data when prompt/delayed data also exists.. It's a Iterable of openmc.data.Product value that you can access after creating a Reaction instance." }, { "instruction": "How do you call the __init__() method in the Reaction class?", "input": "OpenMC Python API Reaction.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mt: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Reaction class?", "input": "OpenMC Python API Reaction.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the center_of_mass() method in the Reaction class?", "input": "OpenMC Python API Reaction.center_of_mass() method signature", "output": "To call the center_of_mass() method, use: @property def center_of_mass(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the center_of_mass() method in the Reaction class?", "input": "OpenMC Python API Reaction.center_of_mass() method signature", "output": "To call the center_of_mass() method, use: @center_of_mass.setter def center_of_mass(self: Any, center_of_mass: Any). It takes 2 parameters." }, { "instruction": "How do you call the redundant() method in the Reaction class?", "input": "OpenMC Python API Reaction.redundant() method signature", "output": "To call the redundant() method, use: @property def redundant(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the redundant() method in the Reaction class?", "input": "OpenMC Python API Reaction.redundant() method signature", "output": "To call the redundant() method, use: @redundant.setter def redundant(self: Any, redundant: Any). It takes 2 parameters." }, { "instruction": "How do you call the q_value() method in the Reaction class?", "input": "OpenMC Python API Reaction.q_value() method signature", "output": "To call the q_value() method, use: @property def q_value(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the q_value() method in the Reaction class?", "input": "OpenMC Python API Reaction.q_value() method signature", "output": "To call the q_value() method, use: @q_value.setter def q_value(self: Any, q_value: Any). It takes 2 parameters." }, { "instruction": "How do you call the products() method in the Reaction class?", "input": "OpenMC Python API Reaction.products() method signature", "output": "To call the products() method, use: @property def products(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the products() method in the Reaction class?", "input": "OpenMC Python API Reaction.products() method signature", "output": "To call the products() method, use: @products.setter def products(self: Any, products: Any). It takes 2 parameters." }, { "instruction": "How do you call the derived_products() method in the Reaction class?", "input": "OpenMC Python API Reaction.derived_products() method signature", "output": "To call the derived_products() method, use: @property def derived_products(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the derived_products() method in the Reaction class?", "input": "OpenMC Python API Reaction.derived_products() method signature", "output": "To call the derived_products() method, use: @derived_products.setter def derived_products(self: Any, derived_products: Any). It takes 2 parameters." }, { "instruction": "How do you call the xs() method in the Reaction class?", "input": "OpenMC Python API Reaction.xs() method signature", "output": "To call the xs() method, use: @property def xs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs() method in the Reaction class?", "input": "OpenMC Python API Reaction.xs() method signature", "output": "To call the xs() method, use: @xs.setter def xs(self: Any, xs: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the Reaction class?", "input": "OpenMC Python API Reaction.to_hdf5() method", "output": "The to_hdf5() method write reaction to an hdf5 group. It's used for reaction operations." }, { "instruction": "How do you call the to_hdf5() method in the Reaction class?", "input": "OpenMC Python API Reaction.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API Reaction.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the Reaction class?", "input": "OpenMC Python API Reaction.from_hdf5() method", "output": "The from_hdf5() method generate reaction from an hdf5 group. It's used for reaction operations." }, { "instruction": "How do you call the from_hdf5() method in the Reaction class?", "input": "OpenMC Python API Reaction.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any, energy: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Reaction.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the energy parameter do in the from_hdf5() method?", "input": "OpenMC Python API Reaction.from_hdf5() parameter energy", "output": "The energy parameter dictionary whose keys are temperatures (e.g., '300k') and values are arrays of energies at which cross sections are tabulated at.. It should be a dict value." }, { "instruction": "How do you call the from_ace() method in the Reaction class?", "input": "OpenMC Python API Reaction.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any, i_reaction: Any). It takes 3 parameters." }, { "instruction": "What does the from_endf() method do in the Reaction class?", "input": "OpenMC Python API Reaction.from_endf() method", "output": "The from_endf() method generate a reaction from an endf evaluation. It's used for reaction operations." }, { "instruction": "How do you call the from_endf() method in the Reaction class?", "input": "OpenMC Python API Reaction.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, mt: Any). It takes 3 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API Reaction.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the mt parameter do in the from_endf() method?", "input": "OpenMC Python API Reaction.from_endf() parameter mt", "output": "The mt parameter the mt value of the reaction to get data for. It should be a int value." }, { "instruction": "What does the from_endf() method return in the Reaction class?", "input": "OpenMC Python API Reaction.from_endf() return value", "output": "The from_endf() method returns reaction data. The return type is openmc.data.Reaction." }, { "instruction": "What does the _get_products() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_products() function", "output": "The _get_products() function generate products from mf=6 in an endf evaluation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_products() function in OpenMC's Python API?", "input": "OpenMC Python API _get_products() function purpose", "output": "The _get_products() function generate products from mf=6 in an endf evaluation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_products() function in OpenMC's Python API?", "input": "OpenMC Python API _get_products() function signature", "output": "To call the _get_products() function, use: def _get_products(ev: Any, mt: Any). It takes 2 parameters." }, { "instruction": "What does the ev parameter do in the _get_products() function?", "input": "OpenMC Python API _get_products() parameter ev", "output": "The ev parameter endf evaluation to read from. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the mt parameter do in the _get_products() function?", "input": "OpenMC Python API _get_products() parameter mt", "output": "The mt parameter the mt value of the reaction to get products for. It should be a int value." }, { "instruction": "What does the _get_products() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_products() return value", "output": "The _get_products() function returns products of the reaction. The return type is list of openmc.data.Product." }, { "instruction": "What does the _get_fission_products_ace() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_ace() function", "output": "The _get_fission_products_ace() function generate fission products from an ace table. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_fission_products_ace() function in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_ace() function purpose", "output": "The _get_fission_products_ace() function generate fission products from an ace table. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_fission_products_ace() function in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_ace() function signature", "output": "To call the _get_fission_products_ace() function, use: def _get_fission_products_ace(ace: Any). It takes 1 parameters." }, { "instruction": "What does the ace parameter do in the _get_fission_products_ace() function?", "input": "OpenMC Python API _get_fission_products_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the _get_fission_products_ace() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_ace() return value", "output": "The _get_fission_products_ace() function returns prompt and delayed fission neutrons. The return type is list of openmc.data.Product." }, { "instruction": "What does the _get_fission_products_ace() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_ace() return value", "output": "The _get_fission_products_ace() function returns \"total\" fission neutron. The return type is list of openmc.data.Product." }, { "instruction": "What does the _get_fission_products_endf() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_endf() function", "output": "The _get_fission_products_endf() function generate fission products from an endf evaluation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_fission_products_endf() function in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_endf() function purpose", "output": "The _get_fission_products_endf() function generate fission products from an endf evaluation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_fission_products_endf() function in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_endf() function signature", "output": "To call the _get_fission_products_endf() function, use: def _get_fission_products_endf(ev: Any). It takes 1 parameters." }, { "instruction": "What does the ev parameter do in the _get_fission_products_endf() function?", "input": "OpenMC Python API _get_fission_products_endf() parameter ev", "output": "The ev parameter . It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the _get_fission_products_endf() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_endf() return value", "output": "The _get_fission_products_endf() function returns prompt and delayed fission neutrons. The return type is list of openmc.data.Product." }, { "instruction": "What does the _get_fission_products_endf() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_fission_products_endf() return value", "output": "The _get_fission_products_endf() function returns \"total\" fission neutron. The return type is list of openmc.data.Product." }, { "instruction": "What does the _get_activation_products() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_activation_products() function", "output": "The _get_activation_products() function generate activation products from an endf evaluation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_activation_products() function in OpenMC's Python API?", "input": "OpenMC Python API _get_activation_products() function purpose", "output": "The _get_activation_products() function generate activation products from an endf evaluation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_activation_products() function in OpenMC's Python API?", "input": "OpenMC Python API _get_activation_products() function signature", "output": "To call the _get_activation_products() function, use: def _get_activation_products(ev: Any, rx: Any). It takes 2 parameters." }, { "instruction": "What does the ev parameter do in the _get_activation_products() function?", "input": "OpenMC Python API _get_activation_products() parameter ev", "output": "The ev parameter the endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the rx parameter do in the _get_activation_products() function?", "input": "OpenMC Python API _get_activation_products() parameter rx", "output": "The rx parameter reaction which generates activation products. It should be a openmc.data.Reaction value." }, { "instruction": "What does the _get_activation_products() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_activation_products() return value", "output": "The _get_activation_products() function returns activation products. The return type is list of openmc.data.Product." }, { "instruction": "What does the _get_photon_products_ace() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_ace() function", "output": "The _get_photon_products_ace() function generate photon products from an ace table. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_photon_products_ace() function in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_ace() function purpose", "output": "The _get_photon_products_ace() function generate photon products from an ace table. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_photon_products_ace() function in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_ace() function signature", "output": "To call the _get_photon_products_ace() function, use: def _get_photon_products_ace(ace: Any, rx: Any). It takes 2 parameters." }, { "instruction": "What does the ace parameter do in the _get_photon_products_ace() function?", "input": "OpenMC Python API _get_photon_products_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "What does the rx parameter do in the _get_photon_products_ace() function?", "input": "OpenMC Python API _get_photon_products_ace() parameter rx", "output": "The rx parameter reaction that generates photons. It should be a openmc.data.Reaction value." }, { "instruction": "What does the _get_photon_products_ace() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_ace() return value", "output": "The _get_photon_products_ace() function returns photons produced from reaction with given mt. The return type is list of openmc.Products." }, { "instruction": "What does the _get_photon_products_endf() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_endf() function", "output": "The _get_photon_products_endf() function generate photon products from an endf evaluation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_photon_products_endf() function in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_endf() function purpose", "output": "The _get_photon_products_endf() function generate photon products from an endf evaluation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_photon_products_endf() function in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_endf() function signature", "output": "To call the _get_photon_products_endf() function, use: def _get_photon_products_endf(ev: Any, rx: Any). It takes 2 parameters." }, { "instruction": "What does the ev parameter do in the _get_photon_products_endf() function?", "input": "OpenMC Python API _get_photon_products_endf() parameter ev", "output": "The ev parameter endf evaluation to read from. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the rx parameter do in the _get_photon_products_endf() function?", "input": "OpenMC Python API _get_photon_products_endf() parameter rx", "output": "The rx parameter reaction that generates photons. It should be a openmc.data.Reaction value." }, { "instruction": "What does the _get_photon_products_endf() function return in OpenMC's Python API?", "input": "OpenMC Python API _get_photon_products_endf() return value", "output": "The _get_photon_products_endf() function returns photons produced from reaction with given mt. The return type is list of openmc.Products." }, { "instruction": "What is the Resonances class in OpenMC's Python API?", "input": "OpenMC Python API Resonances class", "output": "The Resonances class represents resolved and unresolved resonance data. It provides 7 methods and 0 properties for working with resonances data in OpenMC." }, { "instruction": "What does the Resonances class do in OpenMC's Python API?", "input": "OpenMC Python API Resonances class description", "output": "The Resonances class resolved and unresolved resonance data. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the ranges parameter do when creating a Resonances?", "input": "OpenMC Python API Resonances constructor parameter ranges", "output": "When creating a Resonances, the ranges parameter specifies distinct energy ranges for resonance data. It should be a list of openmc.data.ResonanceRange value." }, { "instruction": "What is the ranges attribute of a Resonances?", "input": "OpenMC Python API Resonances attribute ranges", "output": "The ranges attribute of a Resonances contains distinct energy ranges for resonance data. It's a list of openmc.data.ResonanceRange value that you can access after creating a Resonances instance." }, { "instruction": "What is the resolved attribute of a Resonances?", "input": "OpenMC Python API Resonances attribute resolved", "output": "The resolved attribute of a Resonances contains resolved resonance range. It's a openmc.data.ResonanceRange or None value that you can access after creating a Resonances instance." }, { "instruction": "What is the unresolved attribute of a Resonances?", "input": "OpenMC Python API Resonances attribute unresolved", "output": "The unresolved attribute of a Resonances contains unresolved resonance range. It's a openmc.data.Unresolved or None value that you can access after creating a Resonances instance." }, { "instruction": "How do you call the __init__() method in the Resonances class?", "input": "OpenMC Python API Resonances.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, ranges: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the Resonances class?", "input": "OpenMC Python API Resonances.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ranges() method in the Resonances class?", "input": "OpenMC Python API Resonances.ranges() method signature", "output": "To call the ranges() method, use: @property def ranges(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ranges() method in the Resonances class?", "input": "OpenMC Python API Resonances.ranges() method signature", "output": "To call the ranges() method, use: @ranges.setter def ranges(self: Any, ranges: Any). It takes 2 parameters." }, { "instruction": "How do you call the resolved() method in the Resonances class?", "input": "OpenMC Python API Resonances.resolved() method signature", "output": "To call the resolved() method, use: @property def resolved(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the unresolved() method in the Resonances class?", "input": "OpenMC Python API Resonances.unresolved() method signature", "output": "To call the unresolved() method, use: @property def unresolved(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_endf() method do in the Resonances class?", "input": "OpenMC Python API Resonances.from_endf() method", "output": "The from_endf() method generate resonance data from an endf evaluation. It's used for resonances operations." }, { "instruction": "How do you call the from_endf() method in the Resonances class?", "input": "OpenMC Python API Resonances.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any). It takes 2 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API Resonances.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What is the ResonanceRange class in OpenMC's Python API?", "input": "OpenMC Python API ResonanceRange class", "output": "The ResonanceRange class represents resolved resonance range. It provides 4 methods and 0 properties for working with resonancerange data in OpenMC." }, { "instruction": "What does the ResonanceRange class do in OpenMC's Python API?", "input": "OpenMC Python API ResonanceRange class description", "output": "The ResonanceRange class resolved resonance range. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the target_spin parameter do when creating a ResonanceRange?", "input": "OpenMC Python API ResonanceRange constructor parameter target_spin", "output": "When creating a ResonanceRange, the target_spin parameter specifies intrinsic spin, :math:`i`, of the target nuclide. It should be a float value." }, { "instruction": "What does the energy_min parameter do when creating a ResonanceRange?", "input": "OpenMC Python API ResonanceRange constructor parameter energy_min", "output": "When creating a ResonanceRange, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a ResonanceRange?", "input": "OpenMC Python API ResonanceRange constructor parameter energy_max", "output": "When creating a ResonanceRange, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the channel parameter do when creating a ResonanceRange?", "input": "OpenMC Python API ResonanceRange constructor parameter channel", "output": "When creating a ResonanceRange, the channel parameter specifies dictionary whose keys are l-values and values are channel radii as a function of energy. It should be a dict value." }, { "instruction": "What does the scattering parameter do when creating a ResonanceRange?", "input": "OpenMC Python API ResonanceRange constructor parameter scattering", "output": "When creating a ResonanceRange, the scattering parameter specifies dictionary whose keys are l-values and values are scattering radii as a function of energy. It should be a dict value." }, { "instruction": "What is the channel_radius attribute of a ResonanceRange?", "input": "OpenMC Python API ResonanceRange attribute channel_radius", "output": "The channel_radius attribute of a ResonanceRange contains dictionary whose keys are l-values and values are channel radii as a function of energy. It's a dict value that you can access after creating a ResonanceRange instance." }, { "instruction": "What is the energy_max attribute of a ResonanceRange?", "input": "OpenMC Python API ResonanceRange attribute energy_max", "output": "The energy_max attribute of a ResonanceRange contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ResonanceRange instance." }, { "instruction": "What is the energy_min attribute of a ResonanceRange?", "input": "OpenMC Python API ResonanceRange attribute energy_min", "output": "The energy_min attribute of a ResonanceRange contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ResonanceRange instance." }, { "instruction": "What is the scattering_radius attribute of a ResonanceRange?", "input": "OpenMC Python API ResonanceRange attribute scattering_radius", "output": "The scattering_radius attribute of a ResonanceRange contains dictionary whose keys are l-values and values are scattering radii as a function of energ. It's a dict value that you can access after creating a ResonanceRange instance." }, { "instruction": "What is the target_spin attribute of a ResonanceRange?", "input": "OpenMC Python API ResonanceRange attribute target_spin", "output": "The target_spin attribute of a ResonanceRange contains intrinsic spin, :math:`i`, of the target nuclide. It's a float value that you can access after creating a ResonanceRange instance." }, { "instruction": "How do you call the __init__() method in the ResonanceRange class?", "input": "OpenMC Python API ResonanceRange.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, target_spin: Any, energy_min: Any, energy_max: Any, channel: Any, scattering: Any). It takes 6 parameters." }, { "instruction": "How do you call the __copy__() method in the ResonanceRange class?", "input": "OpenMC Python API ResonanceRange.__copy__() method signature", "output": "To call the __copy__() method, use: def __copy__(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_endf() method do in the ResonanceRange class?", "input": "OpenMC Python API ResonanceRange.from_endf() method", "output": "The from_endf() method create resonance range from an endf evaluation. this factory method is only used when lru=0, indicating that only a scattering radius appears in mf=2, mt=151. all subclasses of resonancerange override this method with their own. It's used for resonancerange operations." }, { "instruction": "How do you call the from_endf() method in the ResonanceRange class?", "input": "OpenMC Python API ResonanceRange.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, file_obj: Any, items: Any). It takes 4 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API ResonanceRange.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API ResonanceRange.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the second record of a resonance range subsection in mf=2, mt=151. It should be a file-like object value." }, { "instruction": "What does the items parameter do in the from_endf() method?", "input": "OpenMC Python API ResonanceRange.from_endf() parameter items", "output": "The items parameter items from the cont record at the start of the resonance range subsection. It should be a list value." }, { "instruction": "What does the reconstruct() method do in the ResonanceRange class?", "input": "OpenMC Python API ResonanceRange.reconstruct() method", "output": "The reconstruct() method evaluate cross section at specified energies. It's used for resonancerange operations." }, { "instruction": "How do you call the reconstruct() method in the ResonanceRange class?", "input": "OpenMC Python API ResonanceRange.reconstruct() method signature", "output": "To call the reconstruct() method, use: def reconstruct(self: Any, energies: Any). It takes 2 parameters." }, { "instruction": "What does the energies parameter do in the reconstruct() method?", "input": "OpenMC Python API ResonanceRange.reconstruct() parameter energies", "output": "The energies parameter energies at which the cross section should be evaluated. It should be a float or Iterable of float value." }, { "instruction": "What is the MultiLevelBreitWigner class in OpenMC's Python API?", "input": "OpenMC Python API MultiLevelBreitWigner class", "output": "The MultiLevelBreitWigner class represents multi-level breit-wigner resolved resonance formalism data. multi-level breit-wigner resolved resonance data is identified by lrf=2 in the endf-6 format. It provides 3 methods and 0 properties for working with multilevelbreitwigner data in OpenMC." }, { "instruction": "What does the MultiLevelBreitWigner class do in OpenMC's Python API?", "input": "OpenMC Python API MultiLevelBreitWigner class description", "output": "The MultiLevelBreitWigner class multi-level breit-wigner resolved resonance formalism data. multi-level breit-wigner resolved resonance data is identified by lrf=2 in the endf-6 format. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the target_spin parameter do when creating a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner constructor parameter target_spin", "output": "When creating a MultiLevelBreitWigner, the target_spin parameter specifies intrinsic spin, :math:`i`, of the target nuclide. It should be a float value." }, { "instruction": "What does the energy_min parameter do when creating a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner constructor parameter energy_min", "output": "When creating a MultiLevelBreitWigner, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner constructor parameter energy_max", "output": "When creating a MultiLevelBreitWigner, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the channel parameter do when creating a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner constructor parameter channel", "output": "When creating a MultiLevelBreitWigner, the channel parameter specifies dictionary whose keys are l-values and values are channel radii as a function of energy. It should be a dict value." }, { "instruction": "What does the scattering parameter do when creating a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner constructor parameter scattering", "output": "When creating a MultiLevelBreitWigner, the scattering parameter specifies dictionary whose keys are l-values and values are scattering radii as a function of energy. It should be a dict value." }, { "instruction": "What is the atomic_weight_ratio attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a MultiLevelBreitWigner contains atomic weight ratio of the target nuclide given as a function of l-value. note that this may be different than the value for the evaluation as a whole.. It's a float value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "What is the channel_radius attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute channel_radius", "output": "The channel_radius attribute of a MultiLevelBreitWigner contains dictionary whose keys are l-values and values are channel radii as a function of energy. It's a dict value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "What is the energy_max attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute energy_max", "output": "The energy_max attribute of a MultiLevelBreitWigner contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "What is the energy_min attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute energy_min", "output": "The energy_min attribute of a MultiLevelBreitWigner contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "What is the parameters attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute parameters", "output": "The parameters attribute of a MultiLevelBreitWigner contains energies, spins, and resonances widths for each resonance. It's a pandas.DataFrame value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "What is the q_value attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute q_value", "output": "The q_value attribute of a MultiLevelBreitWigner contains q-value to be added to incident particle's center-of-mass energy to determine the channel energy for use in the penetrability factor. the keys of the dictionary are l-values.. It's a dict value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "What is the scattering_radius attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute scattering_radius", "output": "The scattering_radius attribute of a MultiLevelBreitWigner contains dictionary whose keys are l-values and values are scattering radii as a function of energy. It's a dict value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "What is the target_spin attribute of a MultiLevelBreitWigner?", "input": "OpenMC Python API MultiLevelBreitWigner attribute target_spin", "output": "The target_spin attribute of a MultiLevelBreitWigner contains intrinsic spin, :math:`i`, of the target nuclide. It's a float value that you can access after creating a MultiLevelBreitWigner instance." }, { "instruction": "How do you call the __init__() method in the MultiLevelBreitWigner class?", "input": "OpenMC Python API MultiLevelBreitWigner.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, target_spin: Any, energy_min: Any, energy_max: Any, channel: Any, scattering: Any). It takes 6 parameters." }, { "instruction": "What does the from_endf() method do in the MultiLevelBreitWigner class?", "input": "OpenMC Python API MultiLevelBreitWigner.from_endf() method", "output": "The from_endf() method create mlbw data from an endf evaluation. It's used for multilevelbreitwigner operations." }, { "instruction": "How do you call the from_endf() method in the MultiLevelBreitWigner class?", "input": "OpenMC Python API MultiLevelBreitWigner.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, file_obj: Any, items: Any). It takes 4 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API MultiLevelBreitWigner.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API MultiLevelBreitWigner.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the second record of a resonance range subsection in mf=2, mt=151. It should be a file-like object value." }, { "instruction": "What does the items parameter do in the from_endf() method?", "input": "OpenMC Python API MultiLevelBreitWigner.from_endf() parameter items", "output": "The items parameter items from the cont record at the start of the resonance range subsection. It should be a list value." }, { "instruction": "How do you call the _prepare_resonances() method in the MultiLevelBreitWigner class?", "input": "OpenMC Python API MultiLevelBreitWigner._prepare_resonances() method signature", "output": "To call the _prepare_resonances() method, use: def _prepare_resonances(self: Any). It takes 1 parameters." }, { "instruction": "What is the SingleLevelBreitWigner class in OpenMC's Python API?", "input": "OpenMC Python API SingleLevelBreitWigner class", "output": "The SingleLevelBreitWigner class represents single-level breit-wigner resolved resonance formalism data. single-level breit-wigner resolved resonance data is is identified by lrf=1 in the endf-6 format. It provides 1 methods and 0 properties for working with singlelevelbreitwigner data in OpenMC." }, { "instruction": "What does the SingleLevelBreitWigner class do in OpenMC's Python API?", "input": "OpenMC Python API SingleLevelBreitWigner class description", "output": "The SingleLevelBreitWigner class single-level breit-wigner resolved resonance formalism data. single-level breit-wigner resolved resonance data is is identified by lrf=1 in the endf-6 format. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the target_spin parameter do when creating a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner constructor parameter target_spin", "output": "When creating a SingleLevelBreitWigner, the target_spin parameter specifies intrinsic spin, :math:`i`, of the target nuclide. It should be a float value." }, { "instruction": "What does the energy_min parameter do when creating a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner constructor parameter energy_min", "output": "When creating a SingleLevelBreitWigner, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner constructor parameter energy_max", "output": "When creating a SingleLevelBreitWigner, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the channel parameter do when creating a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner constructor parameter channel", "output": "When creating a SingleLevelBreitWigner, the channel parameter specifies dictionary whose keys are l-values and values are channel radii as a function of energy. It should be a dict value." }, { "instruction": "What does the scattering parameter do when creating a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner constructor parameter scattering", "output": "When creating a SingleLevelBreitWigner, the scattering parameter specifies dictionary whose keys are l-values and values are scattering radii as a function of energy. It should be a dict value." }, { "instruction": "What is the atomic_weight_ratio attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a SingleLevelBreitWigner contains atomic weight ratio of the target nuclide given as a function of l-value. note that this may be different than the value for the evaluation as a whole.. It's a float value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "What is the channel_radius attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute channel_radius", "output": "The channel_radius attribute of a SingleLevelBreitWigner contains dictionary whose keys are l-values and values are channel radii as a function of energy. It's a dict value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "What is the energy_max attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute energy_max", "output": "The energy_max attribute of a SingleLevelBreitWigner contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "What is the energy_min attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute energy_min", "output": "The energy_min attribute of a SingleLevelBreitWigner contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "What is the parameters attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute parameters", "output": "The parameters attribute of a SingleLevelBreitWigner contains energies, spins, and resonances widths for each resonance. It's a pandas.DataFrame value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "What is the q_value attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute q_value", "output": "The q_value attribute of a SingleLevelBreitWigner contains q-value to be added to incident particle's center-of-mass energy to determine the channel energy for use in the penetrability factor. the keys of the dictionary are l-values.. It's a dict value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "What is the scattering_radius attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute scattering_radius", "output": "The scattering_radius attribute of a SingleLevelBreitWigner contains dictionary whose keys are l-values and values are scattering radii as a function of energy. It's a dict value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "What is the target_spin attribute of a SingleLevelBreitWigner?", "input": "OpenMC Python API SingleLevelBreitWigner attribute target_spin", "output": "The target_spin attribute of a SingleLevelBreitWigner contains intrinsic spin, :math:`i`, of the target nuclide. It's a float value that you can access after creating a SingleLevelBreitWigner instance." }, { "instruction": "How do you call the __init__() method in the SingleLevelBreitWigner class?", "input": "OpenMC Python API SingleLevelBreitWigner.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, target_spin: Any, energy_min: Any, energy_max: Any, channel: Any, scattering: Any). It takes 6 parameters." }, { "instruction": "What is the ReichMoore class in OpenMC's Python API?", "input": "OpenMC Python API ReichMoore class", "output": "The ReichMoore class represents reich-moore resolved resonance formalism data. reich-moore resolved resonance data is identified by lrf=3 in the endf-6 format. It provides 3 methods and 0 properties for working with reichmoore data in OpenMC." }, { "instruction": "What does the ReichMoore class do in OpenMC's Python API?", "input": "OpenMC Python API ReichMoore class description", "output": "The ReichMoore class reich-moore resolved resonance formalism data. reich-moore resolved resonance data is identified by lrf=3 in the endf-6 format. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the target_spin parameter do when creating a ReichMoore?", "input": "OpenMC Python API ReichMoore constructor parameter target_spin", "output": "When creating a ReichMoore, the target_spin parameter specifies intrinsic spin, :math:`i`, of the target nuclide. It should be a float value." }, { "instruction": "What does the energy_min parameter do when creating a ReichMoore?", "input": "OpenMC Python API ReichMoore constructor parameter energy_min", "output": "When creating a ReichMoore, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a ReichMoore?", "input": "OpenMC Python API ReichMoore constructor parameter energy_max", "output": "When creating a ReichMoore, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the channel parameter do when creating a ReichMoore?", "input": "OpenMC Python API ReichMoore constructor parameter channel", "output": "When creating a ReichMoore, the channel parameter specifies dictionary whose keys are l-values and values are channel radii as a function of energy. It should be a dict value." }, { "instruction": "What does the scattering parameter do when creating a ReichMoore?", "input": "OpenMC Python API ReichMoore constructor parameter scattering", "output": "When creating a ReichMoore, the scattering parameter specifies dictionary whose keys are l-values and values are scattering radii as a function of energy. It should be a dict value." }, { "instruction": "What is the angle_distribution attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute angle_distribution", "output": "The angle_distribution attribute of a ReichMoore contains indicate whether parameters can be used to compute angular distributions. It's a bool value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the atomic_weight_ratio attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a ReichMoore contains atomic weight ratio of the target nuclide given as a function of l-value. note that this may be different than the value for the evaluation as a whole.. It's a float value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the channel_radius attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute channel_radius", "output": "The channel_radius attribute of a ReichMoore contains dictionary whose keys are l-values and values are channel radii as a function of energy. It's a dict value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the energy_max attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute energy_max", "output": "The energy_max attribute of a ReichMoore contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the energy_min attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute energy_min", "output": "The energy_min attribute of a ReichMoore contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the num_l_convergence attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute num_l_convergence", "output": "The num_l_convergence attribute of a ReichMoore contains number of l-values which must be used to converge the calculation. It's a int value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the scattering_radius attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute scattering_radius", "output": "The scattering_radius attribute of a ReichMoore contains dictionary whose keys are l-values and values are scattering radii as a function of energy. It's a dict value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the parameters attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute parameters", "output": "The parameters attribute of a ReichMoore contains energies, spins, and resonances widths for each resonance. It's a pandas.DataFrame value that you can access after creating a ReichMoore instance." }, { "instruction": "What is the target_spin attribute of a ReichMoore?", "input": "OpenMC Python API ReichMoore attribute target_spin", "output": "The target_spin attribute of a ReichMoore contains intrinsic spin, :math:`i`, of the target nuclide. It's a float value that you can access after creating a ReichMoore instance." }, { "instruction": "How do you call the __init__() method in the ReichMoore class?", "input": "OpenMC Python API ReichMoore.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, target_spin: Any, energy_min: Any, energy_max: Any, channel: Any, scattering: Any). It takes 6 parameters." }, { "instruction": "What does the from_endf() method do in the ReichMoore class?", "input": "OpenMC Python API ReichMoore.from_endf() method", "output": "The from_endf() method create reich-moore resonance data from an endf evaluation. It's used for reichmoore operations." }, { "instruction": "How do you call the from_endf() method in the ReichMoore class?", "input": "OpenMC Python API ReichMoore.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, file_obj: Any, items: Any). It takes 4 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API ReichMoore.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API ReichMoore.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the second record of a resonance range subsection in mf=2, mt=151. It should be a file-like object value." }, { "instruction": "What does the items parameter do in the from_endf() method?", "input": "OpenMC Python API ReichMoore.from_endf() parameter items", "output": "The items parameter items from the cont record at the start of the resonance range subsection. It should be a list value." }, { "instruction": "How do you call the _prepare_resonances() method in the ReichMoore class?", "input": "OpenMC Python API ReichMoore._prepare_resonances() method signature", "output": "To call the _prepare_resonances() method, use: def _prepare_resonances(self: Any). It takes 1 parameters." }, { "instruction": "What is the RMatrixLimited class in OpenMC's Python API?", "input": "OpenMC Python API RMatrixLimited class", "output": "The RMatrixLimited class represents r-matrix limited resolved resonance formalism data. r-matrix limited resolved resonance data is identified by lrf=7 in the endf-6 format. It provides 2 methods and 0 properties for working with rmatrixlimited data in OpenMC." }, { "instruction": "What does the RMatrixLimited class do in OpenMC's Python API?", "input": "OpenMC Python API RMatrixLimited class description", "output": "The RMatrixLimited class r-matrix limited resolved resonance formalism data. r-matrix limited resolved resonance data is identified by lrf=7 in the endf-6 format. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy_min parameter do when creating a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited constructor parameter energy_min", "output": "When creating a RMatrixLimited, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited constructor parameter energy_max", "output": "When creating a RMatrixLimited, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the particle_pairs parameter do when creating a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited constructor parameter particle_pairs", "output": "When creating a RMatrixLimited, the particle_pairs parameter specifies list of particle pairs. each particle pair is represented by a dictionary that contains the mass, atomic number, spin, and parity of each particle as well as other characteristics.. It should be a list of dict value." }, { "instruction": "What does the spin_groups parameter do when creating a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited constructor parameter spin_groups", "output": "When creating a RMatrixLimited, the spin_groups parameter specifies list of spin groups. each spin group is characterized by channels, resonance energies, and resonance widths.. It should be a list of dict value." }, { "instruction": "What is the reduced_width attribute of a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited attribute reduced_width", "output": "The reduced_width attribute of a RMatrixLimited contains flag indicating whether channel widths in ev or reduced-width amplitudes in ev^1/2 are given. It's a bool value that you can access after creating a RMatrixLimited instance." }, { "instruction": "What is the formalism attribute of a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited attribute formalism", "output": "The formalism attribute of a RMatrixLimited contains flag to specify which formulae for the r-matrix are to be used. It's a int value that you can access after creating a RMatrixLimited instance." }, { "instruction": "What is the particle_pairs attribute of a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited attribute particle_pairs", "output": "The particle_pairs attribute of a RMatrixLimited contains list of particle pairs. each particle pair is represented by a dictionary that contains the mass, atomic number, spin, and parity of each particle as well as other characteristics.. It's a list of dict value that you can access after creating a RMatrixLimited instance." }, { "instruction": "What is the spin_groups attribute of a RMatrixLimited?", "input": "OpenMC Python API RMatrixLimited attribute spin_groups", "output": "The spin_groups attribute of a RMatrixLimited contains list of spin groups. each spin group is characterized by channels, resonance energies, and resonance widths.. It's a list of dict value that you can access after creating a RMatrixLimited instance." }, { "instruction": "How do you call the __init__() method in the RMatrixLimited class?", "input": "OpenMC Python API RMatrixLimited.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy_min: Any, energy_max: Any, particle_pairs: Any, spin_groups: Any). It takes 5 parameters." }, { "instruction": "What does the from_endf() method do in the RMatrixLimited class?", "input": "OpenMC Python API RMatrixLimited.from_endf() method", "output": "The from_endf() method read r-matrix limited resonance data from an endf evaluation. It's used for rmatrixlimited operations." }, { "instruction": "How do you call the from_endf() method in the RMatrixLimited class?", "input": "OpenMC Python API RMatrixLimited.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, file_obj: Any, items: Any). It takes 4 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API RMatrixLimited.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API RMatrixLimited.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the second record of a resonance range subsection in mf=2, mt=151. It should be a file-like object value." }, { "instruction": "What does the items parameter do in the from_endf() method?", "input": "OpenMC Python API RMatrixLimited.from_endf() parameter items", "output": "The items parameter items from the cont record at the start of the resonance range subsection. It should be a list value." }, { "instruction": "How do you call the __init__() method in the ParticlePair class?", "input": "OpenMC Python API ParticlePair.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, first: Any, second: Any, q_value: Any, penetrability: Any, shift: Any, mt: Any). It takes 7 parameters." }, { "instruction": "What is the SpinGroup class in OpenMC's Python API?", "input": "OpenMC Python API SpinGroup class", "output": "The SpinGroup class represents resonance spin group. It provides 2 methods and 0 properties for working with spingroup data in OpenMC." }, { "instruction": "What does the SpinGroup class do in OpenMC's Python API?", "input": "OpenMC Python API SpinGroup class description", "output": "The SpinGroup class resonance spin group. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the spin attribute of a SpinGroup?", "input": "OpenMC Python API SpinGroup attribute spin", "output": "The spin attribute of a SpinGroup contains total angular momentum (nuclear spin). It's a float value that you can access after creating a SpinGroup instance." }, { "instruction": "What is the parity attribute of a SpinGroup?", "input": "OpenMC Python API SpinGroup attribute parity", "output": "The parity attribute of a SpinGroup contains even (+) or odd(-) parity. It's a {'+', '-'} value that you can access after creating a SpinGroup instance." }, { "instruction": "What is the channels attribute of a SpinGroup?", "input": "OpenMC Python API SpinGroup attribute channels", "output": "The channels attribute of a SpinGroup contains available channels. It's a list of openmc.data.Channel value that you can access after creating a SpinGroup instance." }, { "instruction": "What is the parameters attribute of a SpinGroup?", "input": "OpenMC Python API SpinGroup attribute parameters", "output": "The parameters attribute of a SpinGroup contains energies/widths for each resonance/channel. It's a pandas.DataFrame value that you can access after creating a SpinGroup instance." }, { "instruction": "How do you call the __init__() method in the SpinGroup class?", "input": "OpenMC Python API SpinGroup.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, spin: Any, parity: Any, channels: Any, parameters: Any). It takes 5 parameters." }, { "instruction": "How do you call the __repr__() method in the SpinGroup class?", "input": "OpenMC Python API SpinGroup.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What is the Unresolved class in OpenMC's Python API?", "input": "OpenMC Python API Unresolved class", "output": "The Unresolved class represents unresolved resonance parameters as identified by lru=2 in mf=2. It provides 2 methods and 0 properties for working with unresolved data in OpenMC." }, { "instruction": "What does the Unresolved class do in OpenMC's Python API?", "input": "OpenMC Python API Unresolved class description", "output": "The Unresolved class unresolved resonance parameters as identified by lru=2 in mf=2. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the target_spin parameter do when creating a Unresolved?", "input": "OpenMC Python API Unresolved constructor parameter target_spin", "output": "When creating a Unresolved, the target_spin parameter specifies intrinsic spin, :math:`i`, of the target nuclide. It should be a float value." }, { "instruction": "What does the energy_min parameter do when creating a Unresolved?", "input": "OpenMC Python API Unresolved constructor parameter energy_min", "output": "When creating a Unresolved, the energy_min parameter specifies minimum energy of the unresolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a Unresolved?", "input": "OpenMC Python API Unresolved constructor parameter energy_max", "output": "When creating a Unresolved, the energy_max parameter specifies maximum energy of the unresolved resonance range in ev. It should be a float value." }, { "instruction": "What does the channel parameter do when creating a Unresolved?", "input": "OpenMC Python API Unresolved constructor parameter channel", "output": "When creating a Unresolved, the channel parameter specifies channel radii as a function of energy. It should be a openmc.data.Function1D value." }, { "instruction": "What does the scattering parameter do when creating a Unresolved?", "input": "OpenMC Python API Unresolved constructor parameter scattering", "output": "When creating a Unresolved, the scattering parameter specifies scattering radii as a function of energy. It should be a openmc.data.Function1D value." }, { "instruction": "What is the add_to_background attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute add_to_background", "output": "The add_to_background attribute of a Unresolved contains if true, file 3 contains partial cross sections to be added to the average unresolved cross sections calculated from parameters.. It's a bool value that you can access after creating a Unresolved instance." }, { "instruction": "What is the atomic_weight_ratio attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a Unresolved contains atomic weight ratio of the target nuclide. It's a float value that you can access after creating a Unresolved instance." }, { "instruction": "What is the channel_radius attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute channel_radius", "output": "The channel_radius attribute of a Unresolved contains channel radii as a function of energy. It's a openmc.data.Function1D value that you can access after creating a Unresolved instance." }, { "instruction": "What is the energies attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute energies", "output": "The energies attribute of a Unresolved contains energies at which parameters are tabulated. It's a Iterable of float value that you can access after creating a Unresolved instance." }, { "instruction": "What is the energy_max attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute energy_max", "output": "The energy_max attribute of a Unresolved contains maximum energy of the unresolved resonance range in ev. It's a float value that you can access after creating a Unresolved instance." }, { "instruction": "What is the energy_min attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute energy_min", "output": "The energy_min attribute of a Unresolved contains minimum energy of the unresolved resonance range in ev. It's a float value that you can access after creating a Unresolved instance." }, { "instruction": "What is the parameters attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute parameters", "output": "The parameters attribute of a Unresolved contains average resonance parameters at each energy. It's a list of pandas.DataFrame value that you can access after creating a Unresolved instance." }, { "instruction": "What is the scattering_radius attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute scattering_radius", "output": "The scattering_radius attribute of a Unresolved contains scattering radii as a function of energy. It's a openmc.data.Function1D value that you can access after creating a Unresolved instance." }, { "instruction": "What is the target_spin attribute of a Unresolved?", "input": "OpenMC Python API Unresolved attribute target_spin", "output": "The target_spin attribute of a Unresolved contains intrinsic spin, :math:`i`, of the target nuclide. It's a float value that you can access after creating a Unresolved instance." }, { "instruction": "How do you call the __init__() method in the Unresolved class?", "input": "OpenMC Python API Unresolved.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, target_spin: Any, energy_min: Any, energy_max: Any, channel: Any, scattering: Any). It takes 6 parameters." }, { "instruction": "What does the from_endf() method do in the Unresolved class?", "input": "OpenMC Python API Unresolved.from_endf() method", "output": "The from_endf() method read unresolved resonance data from an endf evaluation. It's used for unresolved operations." }, { "instruction": "How do you call the from_endf() method in the Unresolved class?", "input": "OpenMC Python API Unresolved.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, file_obj: Any, items: Any, fission_widths: Any). It takes 4 parameters." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API Unresolved.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the second record of a resonance range subsection in mf=2, mt=151. It should be a file-like object value." }, { "instruction": "What does the items parameter do in the from_endf() method?", "input": "OpenMC Python API Unresolved.from_endf() parameter items", "output": "The items parameter items from the cont record at the start of the resonance range subsection. It should be a list value." }, { "instruction": "What does the fission_widths parameter do in the from_endf() method?", "input": "OpenMC Python API Unresolved.from_endf() parameter fission_widths", "output": "The fission_widths parameter whether fission widths are given. It should be a bool value." }, { "instruction": "What is the ResonanceCovariances class in OpenMC's Python API?", "input": "OpenMC Python API ResonanceCovariances class", "output": "The ResonanceCovariances class represents resolved resonance covariance data. It provides 3 methods and 0 properties for working with resonancecovariances data in OpenMC." }, { "instruction": "What does the ResonanceCovariances class do in OpenMC's Python API?", "input": "OpenMC Python API ResonanceCovariances class description", "output": "The ResonanceCovariances class resolved resonance covariance data. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the ranges parameter do when creating a ResonanceCovariances?", "input": "OpenMC Python API ResonanceCovariances constructor parameter ranges", "output": "When creating a ResonanceCovariances, the ranges parameter specifies distinct energy ranges for resonance data. It should be a list of openmc.data.ResonanceCovarianceRange value." }, { "instruction": "What is the ranges attribute of a ResonanceCovariances?", "input": "OpenMC Python API ResonanceCovariances attribute ranges", "output": "The ranges attribute of a ResonanceCovariances contains distinct energy ranges for resonance data. It's a list of openmc.data.ResonanceCovarianceRange value that you can access after creating a ResonanceCovariances instance." }, { "instruction": "How do you call the ranges() method in the ResonanceCovariances class?", "input": "OpenMC Python API ResonanceCovariances.ranges() method signature", "output": "To call the ranges() method, use: @property def ranges(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ranges() method in the ResonanceCovariances class?", "input": "OpenMC Python API ResonanceCovariances.ranges() method signature", "output": "To call the ranges() method, use: @ranges.setter def ranges(self: Any, ranges: Any). It takes 2 parameters." }, { "instruction": "What does the from_endf() method do in the ResonanceCovariances class?", "input": "OpenMC Python API ResonanceCovariances.from_endf() method", "output": "The from_endf() method generate resonance covariance data from an endf evaluation. It's used for resonancecovariances operations." }, { "instruction": "How do you call the from_endf() method in the ResonanceCovariances class?", "input": "OpenMC Python API ResonanceCovariances.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, resonances: Any). It takes 3 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API ResonanceCovariances.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the resonances parameter do in the from_endf() method?", "input": "OpenMC Python API ResonanceCovariances.from_endf() parameter resonances", "output": "The resonances parameter openmc.data.resonanance object generated from the same evaluation used to import values not contained in file 32. It should be a openmc.data.Resonance object value." }, { "instruction": "What is the ResonanceCovarianceRange class in OpenMC's Python API?", "input": "OpenMC Python API ResonanceCovarianceRange class", "output": "The ResonanceCovarianceRange class represents resonace covariance range. base class for different formalisms. It provides 3 methods and 0 properties for working with resonancecovariancerange data in OpenMC." }, { "instruction": "What does the ResonanceCovarianceRange class do in OpenMC's Python API?", "input": "OpenMC Python API ResonanceCovarianceRange class description", "output": "The ResonanceCovarianceRange class resonace covariance range. base class for different formalisms. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy_min parameter do when creating a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange constructor parameter energy_min", "output": "When creating a ResonanceCovarianceRange, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange constructor parameter energy_max", "output": "When creating a ResonanceCovarianceRange, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What is the energy_min attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute energy_min", "output": "The energy_min attribute of a ResonanceCovarianceRange contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "What is the energy_max attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute energy_max", "output": "The energy_max attribute of a ResonanceCovarianceRange contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "What is the parameters attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute parameters", "output": "The parameters attribute of a ResonanceCovarianceRange contains resonance parameters. It's a pandas.DataFrame value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "What is the covariance attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute covariance", "output": "The covariance attribute of a ResonanceCovarianceRange contains the covariance matrix contained within the endf evaluation. It's a numpy.array value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "What is the lcomp attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute lcomp", "output": "The lcomp attribute of a ResonanceCovarianceRange contains flag indicating format of the covariance matrix within the endf file. It's a int value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "What is the file2res attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute file2res", "output": "The file2res attribute of a ResonanceCovarianceRange contains corresponding resonance range with file 2 data.. It's a openmc.data.ResonanceRange object value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "What is the mpar attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute mpar", "output": "The mpar attribute of a ResonanceCovarianceRange contains number of parameters in covariance matrix for each individual resonance. It's a int value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "What is the formalism attribute of a ResonanceCovarianceRange?", "input": "OpenMC Python API ResonanceCovarianceRange attribute formalism", "output": "The formalism attribute of a ResonanceCovarianceRange contains string descriptor of formalism. It's a str value that you can access after creating a ResonanceCovarianceRange instance." }, { "instruction": "How do you call the __init__() method in the ResonanceCovarianceRange class?", "input": "OpenMC Python API ResonanceCovarianceRange.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy_min: Any, energy_max: Any). It takes 3 parameters." }, { "instruction": "What does the subset() method do in the ResonanceCovarianceRange class?", "input": "OpenMC Python API ResonanceCovarianceRange.subset() method", "output": "The subset() method produce a subset of resonance parameters and the corresponding covariance matrix to an incidentneutron object. It's used for resonancecovariancerange operations." }, { "instruction": "How do you call the subset() method in the ResonanceCovarianceRange class?", "input": "OpenMC Python API ResonanceCovarianceRange.subset() method signature", "output": "To call the subset() method, use: def subset(self: Any, parameter_str: Any, bounds: Any). It takes 3 parameters." }, { "instruction": "What does the parameter_str parameter do in the subset() method?", "input": "OpenMC Python API ResonanceCovarianceRange.subset() parameter parameter_str", "output": "The parameter_str parameter parameter to be discriminated (i.e. 'energy', 'capturewidth', 'fissionwidtha'...). It should be a str value." }, { "instruction": "What does the bounds parameter do in the subset() method?", "input": "OpenMC Python API ResonanceCovarianceRange.subset() parameter bounds", "output": "The bounds parameter [low numerical bound, high numerical bound]. It should be a np.array value." }, { "instruction": "What does the subset() method return in the ResonanceCovarianceRange class?", "input": "OpenMC Python API ResonanceCovarianceRange.subset() return value", "output": "The subset() method returns resonancecovariancerange object that contains a subset of the covariance matrix (upper triangular) as well as a subset parameters within self.file2params. The return type is openmc.data.ResonanceCovarianceRange." }, { "instruction": "What does the sample() method do in the ResonanceCovarianceRange class?", "input": "OpenMC Python API ResonanceCovarianceRange.sample() method", "output": "The sample() method sample resonance parameters based on the covariances provided within an endf evaluation. It's used for resonancecovariancerange operations." }, { "instruction": "How do you call the sample() method in the ResonanceCovarianceRange class?", "input": "OpenMC Python API ResonanceCovarianceRange.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any). It takes 2 parameters." }, { "instruction": "What does the n_samples parameter do in the sample() method?", "input": "OpenMC Python API ResonanceCovarianceRange.sample() parameter n_samples", "output": "The n_samples parameter the number of samples to produce. It should be a int value." }, { "instruction": "What does the sample() method return in the ResonanceCovarianceRange class?", "input": "OpenMC Python API ResonanceCovarianceRange.sample() return value", "output": "The sample() method returns list of samples size `n_samples`. The return type is list of openmc.data.ResonanceCovarianceRange objects." }, { "instruction": "What is the MultiLevelBreitWignerCovariance class in OpenMC's Python API?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance class", "output": "The MultiLevelBreitWignerCovariance class represents multi-level breit-wigner resolved resonance formalism covariance data. It provides 2 methods and 0 properties for working with multilevelbreitwignercovariance data in OpenMC." }, { "instruction": "What does the MultiLevelBreitWignerCovariance class do in OpenMC's Python API?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance class description", "output": "The MultiLevelBreitWignerCovariance class multi-level breit-wigner resolved resonance formalism covariance data. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy_min parameter do when creating a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance constructor parameter energy_min", "output": "When creating a MultiLevelBreitWignerCovariance, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance constructor parameter energy_max", "output": "When creating a MultiLevelBreitWignerCovariance, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What is the energy_min attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute energy_min", "output": "The energy_min attribute of a MultiLevelBreitWignerCovariance contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "What is the energy_max attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute energy_max", "output": "The energy_max attribute of a MultiLevelBreitWignerCovariance contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "What is the parameters attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute parameters", "output": "The parameters attribute of a MultiLevelBreitWignerCovariance contains resonance parameters. It's a pandas.DataFrame value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "What is the covariance attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute covariance", "output": "The covariance attribute of a MultiLevelBreitWignerCovariance contains the covariance matrix contained within the endf evaluation. It's a numpy.array value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "What is the mpar attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute mpar", "output": "The mpar attribute of a MultiLevelBreitWignerCovariance contains number of parameters in covariance matrix for each individual resonance. It's a int value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "What is the lcomp attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute lcomp", "output": "The lcomp attribute of a MultiLevelBreitWignerCovariance contains flag indicating format of the covariance matrix within the endf file. It's a int value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "What is the file2res attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute file2res", "output": "The file2res attribute of a MultiLevelBreitWignerCovariance contains corresponding resonance range with file 2 data.. It's a openmc.data.ResonanceRange object value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "What is the formalism attribute of a MultiLevelBreitWignerCovariance?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance attribute formalism", "output": "The formalism attribute of a MultiLevelBreitWignerCovariance contains string descriptor of formalism. It's a str value that you can access after creating a MultiLevelBreitWignerCovariance instance." }, { "instruction": "How do you call the __init__() method in the MultiLevelBreitWignerCovariance class?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy_min: Any, energy_max: Any, parameters: Any, covariance: Any, mpar: Any, lcomp: Any, file2res: Any). It takes 8 parameters." }, { "instruction": "What does the from_endf() method do in the MultiLevelBreitWignerCovariance class?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance.from_endf() method", "output": "The from_endf() method create mlbw covariance data from an endf evaluation. It's used for multilevelbreitwignercovariance operations." }, { "instruction": "How do you call the from_endf() method in the MultiLevelBreitWignerCovariance class?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, file_obj: Any, items: Any, resonance: Any). It takes 5 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the second record of a resonance range subsection in mf=32, mt=151. It should be a file-like object value." }, { "instruction": "What does the items parameter do in the from_endf() method?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance.from_endf() parameter items", "output": "The items parameter items from the cont record at the start of the resonance range subsection. It should be a list value." }, { "instruction": "What does the resonance parameter do in the from_endf() method?", "input": "OpenMC Python API MultiLevelBreitWignerCovariance.from_endf() parameter resonance", "output": "The resonance parameter corresponding resonance range with file 2 data.. It should be a openmc.data.ResonanceRange object value." }, { "instruction": "What is the SingleLevelBreitWignerCovariance class in OpenMC's Python API?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance class", "output": "The SingleLevelBreitWignerCovariance class represents single-level breit-wigner resolved resonance formalism covariance data. single-level breit-wigner resolved resonance data is is identified by lrf=1 in the endf-6 format. It provides 1 methods and 0 properties for working with singlelevelbreitwignercovariance data in OpenMC." }, { "instruction": "What does the SingleLevelBreitWignerCovariance class do in OpenMC's Python API?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance class description", "output": "The SingleLevelBreitWignerCovariance class single-level breit-wigner resolved resonance formalism covariance data. single-level breit-wigner resolved resonance data is is identified by lrf=1 in the endf-6 format. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy_min parameter do when creating a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance constructor parameter energy_min", "output": "When creating a SingleLevelBreitWignerCovariance, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance constructor parameter energy_max", "output": "When creating a SingleLevelBreitWignerCovariance, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What is the energy_min attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute energy_min", "output": "The energy_min attribute of a SingleLevelBreitWignerCovariance contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "What is the energy_max attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute energy_max", "output": "The energy_max attribute of a SingleLevelBreitWignerCovariance contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "What is the parameters attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute parameters", "output": "The parameters attribute of a SingleLevelBreitWignerCovariance contains resonance parameters. It's a pandas.DataFrame value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "What is the covariance attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute covariance", "output": "The covariance attribute of a SingleLevelBreitWignerCovariance contains the covariance matrix contained within the endf evaluation. It's a numpy.array value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "What is the mpar attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute mpar", "output": "The mpar attribute of a SingleLevelBreitWignerCovariance contains number of parameters in covariance matrix for each individual resonance. It's a int value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "What is the formalism attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute formalism", "output": "The formalism attribute of a SingleLevelBreitWignerCovariance contains string descriptor of formalism. It's a str value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "What is the lcomp attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute lcomp", "output": "The lcomp attribute of a SingleLevelBreitWignerCovariance contains flag indicating format of the covariance matrix within the endf file. It's a int value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "What is the file2res attribute of a SingleLevelBreitWignerCovariance?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance attribute file2res", "output": "The file2res attribute of a SingleLevelBreitWignerCovariance contains corresponding resonance range with file 2 data.. It's a openmc.data.ResonanceRange object value that you can access after creating a SingleLevelBreitWignerCovariance instance." }, { "instruction": "How do you call the __init__() method in the SingleLevelBreitWignerCovariance class?", "input": "OpenMC Python API SingleLevelBreitWignerCovariance.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy_min: Any, energy_max: Any, parameters: Any, covariance: Any, mpar: Any, lcomp: Any, file2res: Any). It takes 8 parameters." }, { "instruction": "What is the ReichMooreCovariance class in OpenMC's Python API?", "input": "OpenMC Python API ReichMooreCovariance class", "output": "The ReichMooreCovariance class represents reich-moore resolved resonance formalism covariance data. reich-moore resolved resonance data is identified by lrf=3 in the endf-6 format. It provides 2 methods and 0 properties for working with reichmoorecovariance data in OpenMC." }, { "instruction": "What does the ReichMooreCovariance class do in OpenMC's Python API?", "input": "OpenMC Python API ReichMooreCovariance class description", "output": "The ReichMooreCovariance class reich-moore resolved resonance formalism covariance data. reich-moore resolved resonance data is identified by lrf=3 in the endf-6 format. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy_min parameter do when creating a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance constructor parameter energy_min", "output": "When creating a ReichMooreCovariance, the energy_min parameter specifies minimum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What does the energy_max parameter do when creating a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance constructor parameter energy_max", "output": "When creating a ReichMooreCovariance, the energy_max parameter specifies maximum energy of the resolved resonance range in ev. It should be a float value." }, { "instruction": "What is the energy_min attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute energy_min", "output": "The energy_min attribute of a ReichMooreCovariance contains minimum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "What is the energy_max attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute energy_max", "output": "The energy_max attribute of a ReichMooreCovariance contains maximum energy of the resolved resonance range in ev. It's a float value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "What is the parameters attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute parameters", "output": "The parameters attribute of a ReichMooreCovariance contains resonance parameters. It's a pandas.DataFrame value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "What is the covariance attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute covariance", "output": "The covariance attribute of a ReichMooreCovariance contains the covariance matrix contained within the endf evaluation. It's a numpy.array value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "What is the lcomp attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute lcomp", "output": "The lcomp attribute of a ReichMooreCovariance contains flag indicating format of the covariance matrix within the endf file. It's a int value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "What is the mpar attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute mpar", "output": "The mpar attribute of a ReichMooreCovariance contains number of parameters in covariance matrix for each individual resonance. It's a int value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "What is the file2res attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute file2res", "output": "The file2res attribute of a ReichMooreCovariance contains corresponding resonance range with file 2 data.. It's a openmc.data.ResonanceRange object value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "What is the formalism attribute of a ReichMooreCovariance?", "input": "OpenMC Python API ReichMooreCovariance attribute formalism", "output": "The formalism attribute of a ReichMooreCovariance contains string descriptor of formalism. It's a str value that you can access after creating a ReichMooreCovariance instance." }, { "instruction": "How do you call the __init__() method in the ReichMooreCovariance class?", "input": "OpenMC Python API ReichMooreCovariance.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy_min: Any, energy_max: Any, parameters: Any, covariance: Any, mpar: Any, lcomp: Any, file2res: Any). It takes 8 parameters." }, { "instruction": "What does the from_endf() method do in the ReichMooreCovariance class?", "input": "OpenMC Python API ReichMooreCovariance.from_endf() method", "output": "The from_endf() method create reich-moore resonance covariance data from an endf evaluation. includes the resonance parameters contained separately in file 32. It's used for reichmoorecovariance operations." }, { "instruction": "How do you call the from_endf() method in the ReichMooreCovariance class?", "input": "OpenMC Python API ReichMooreCovariance.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, ev: Any, file_obj: Any, items: Any, resonance: Any). It takes 5 parameters." }, { "instruction": "What does the ev parameter do in the from_endf() method?", "input": "OpenMC Python API ReichMooreCovariance.from_endf() parameter ev", "output": "The ev parameter endf evaluation. It should be a openmc.data.endf.Evaluation value." }, { "instruction": "What does the file_obj parameter do in the from_endf() method?", "input": "OpenMC Python API ReichMooreCovariance.from_endf() parameter file_obj", "output": "The file_obj parameter endf file positioned at the second record of a resonance range subsection in mf=2, mt=151. It should be a file-like object value." }, { "instruction": "What does the items parameter do in the from_endf() method?", "input": "OpenMC Python API ReichMooreCovariance.from_endf() parameter items", "output": "The items parameter items from the cont record at the start of the resonance range subsection. It should be a list value." }, { "instruction": "What does the resonance parameter do in the from_endf() method?", "input": "OpenMC Python API ReichMooreCovariance.from_endf() parameter resonance", "output": "The resonance parameter openmc.data.resonanance object generated from the same evaluation used to import values not contained in file 32. It should be a openmc.data.Resonance object value." }, { "instruction": "What does the _add_file2_contributions() function do in OpenMC's Python API?", "input": "OpenMC Python API _add_file2_contributions() function", "output": "The _add_file2_contributions() function function for aiding in adding resonance parameters from file 2 that are not always present in file 32. uses already imported resonance data. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _add_file2_contributions() function in OpenMC's Python API?", "input": "OpenMC Python API _add_file2_contributions() function purpose", "output": "The _add_file2_contributions() function function for aiding in adding resonance parameters from file 2 that are not always present in file 32. uses already imported resonance data. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _add_file2_contributions() function in OpenMC's Python API?", "input": "OpenMC Python API _add_file2_contributions() function signature", "output": "To call the _add_file2_contributions() function, use: def _add_file2_contributions(file32params: Any, file2params: Any). It takes 2 parameters." }, { "instruction": "What does the _add_file2_contributions() function return in OpenMC's Python API?", "input": "OpenMC Python API _add_file2_contributions() return value", "output": "The _add_file2_contributions() function returns complete set of parameters ordered by l-values and then energy. The return type is pandas.Dataframe." }, { "instruction": "What is the CoherentElastic class in OpenMC's Python API?", "input": "OpenMC Python API CoherentElastic class", "output": "The CoherentElastic class represents coherent elastic scattering data from a crystalline material the integrated cross section for coherent elastic scattering from a powdered crystalline material may be represented as: .. math:: \\sigma(e,t) = \\frac{1}{e} \\sum\\limits_{i=1}^{e_i < e} s_i(t) where :math:`s_i(t)` is proportional the structure factor in [ev-b] at the moderator temperature :math:`t` in kelvin. It provides 9 methods and 0 properties for working with coherentelastic data in OpenMC." }, { "instruction": "What does the CoherentElastic class do in OpenMC's Python API?", "input": "OpenMC Python API CoherentElastic class description", "output": "The CoherentElastic class coherent elastic scattering data from a crystalline material the integrated cross section for coherent elastic scattering from a powdered crystalline material may be represented as: .. math:: \\sigma(e,t) = \\frac{1}{e} \\sum\\limits_{i=1}^{e_i < e} s_i(t) where :math:`s_i(t)` is proportional the structure factor in [ev-b] at the moderator temperature :math:`t` in kelvin. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bragg_edges parameter do when creating a CoherentElastic?", "input": "OpenMC Python API CoherentElastic constructor parameter bragg_edges", "output": "When creating a CoherentElastic, the bragg_edges parameter specifies bragg edge energies in ev. It should be a Iterable of float value." }, { "instruction": "What does the factors parameter do when creating a CoherentElastic?", "input": "OpenMC Python API CoherentElastic constructor parameter factors", "output": "When creating a CoherentElastic, the factors parameter specifies partial sum of structure factors, :math:`\\sum\\limits_{i=1}^{e_i 'c_h_in_h2o'. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_thermal_name() function in OpenMC's Python API?", "input": "OpenMC Python API get_thermal_name() function purpose", "output": "The get_thermal_name() function get proper s(a,b) table name, e.g. 'hh2o' -> 'c_h_in_h2o'. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_thermal_name() function in OpenMC's Python API?", "input": "OpenMC Python API get_thermal_name() function signature", "output": "To call the get_thermal_name() function, use: def get_thermal_name(name: Any). It takes 1 parameters." }, { "instruction": "What does the name parameter do in the get_thermal_name() function?", "input": "OpenMC Python API get_thermal_name() parameter name", "output": "The name parameter name of an ace thermal scattering table. It should be a str value." }, { "instruction": "How do you call the get_coherent_elastic() function in OpenMC's Python API?", "input": "OpenMC Python API get_coherent_elastic() function signature", "output": "To call the get_coherent_elastic() function, use: def get_coherent_elastic(file_obj: Any). It takes 1 parameters." }, { "instruction": "How do you call the get_incoherent_elastic() function in OpenMC's Python API?", "input": "OpenMC Python API get_incoherent_elastic() function signature", "output": "To call the get_incoherent_elastic() function, use: def get_incoherent_elastic(file_obj: Any, natom: Any). It takes 2 parameters." }, { "instruction": "What is the CoherentElasticAE class in OpenMC's Python API?", "input": "OpenMC Python API CoherentElasticAE class", "output": "The CoherentElasticAE class represents differential cross section for coherent elastic scattering the differential cross section for coherent elastic scattering from a powdered crystalline material may be represented as: .. math:: \\frac{d^2\\sigma}{de'd\\omega} (e\\rightarrow e',\\mu,t) = \\frac{1}{e} \\sum \\limits_{i=1}^{e_i < e} s_i(t) \\delta(\\mu - \\mu_i) \\delta (e - e') /(2\\pi) where :math:`e_i` are the energies of the bragg edges in [ev], :math:`s_i(t)` is the structure factor in [ev-b] at the moderator temperature :math:`t` in [k], and :math:`\\mu_i = 1 - 2e_i/e`. It provides 3 methods and 0 properties for working with coherentelasticae data in OpenMC." }, { "instruction": "What does the CoherentElasticAE class do in OpenMC's Python API?", "input": "OpenMC Python API CoherentElasticAE class description", "output": "The CoherentElasticAE class differential cross section for coherent elastic scattering the differential cross section for coherent elastic scattering from a powdered crystalline material may be represented as: .. math:: \\frac{d^2\\sigma}{de'd\\omega} (e\\rightarrow e',\\mu,t) = \\frac{1}{e} \\sum \\limits_{i=1}^{e_i < e} s_i(t) \\delta(\\mu - \\mu_i) \\delta (e - e') /(2\\pi) where :math:`e_i` are the energies of the bragg edges in [ev], :math:`s_i(t)` is the structure factor in [ev-b] at the moderator temperature :math:`t` in [k], and :math:`\\mu_i = 1 - 2e_i/e`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the coherent_xs parameter do when creating a CoherentElasticAE?", "input": "OpenMC Python API CoherentElasticAE constructor parameter coherent_xs", "output": "When creating a CoherentElasticAE, the coherent_xs parameter specifies coherent elastic scattering cross section. It should be a openmc.data.CoherentElastic value." }, { "instruction": "What is the coherent_xs attribute of a CoherentElasticAE?", "input": "OpenMC Python API CoherentElasticAE attribute coherent_xs", "output": "The coherent_xs attribute of a CoherentElasticAE contains coherent elastic scattering cross section. It's a openmc.data.CoherentElastic value that you can access after creating a CoherentElasticAE instance." }, { "instruction": "How do you call the __init__() method in the CoherentElasticAE class?", "input": "OpenMC Python API CoherentElasticAE.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, coherent_xs: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the CoherentElasticAE class?", "input": "OpenMC Python API CoherentElasticAE.to_hdf5() method", "output": "The to_hdf5() method write coherent elastic distribution to an hdf5 group. It's used for coherentelasticae operations." }, { "instruction": "How do you call the to_hdf5() method in the CoherentElasticAE class?", "input": "OpenMC Python API CoherentElasticAE.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API CoherentElasticAE.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the CoherentElasticAE class?", "input": "OpenMC Python API CoherentElasticAE.from_hdf5() method", "output": "The from_hdf5() method generate coherent elastic distribution from hdf5 data .. versionadded:: 0.13.1. It's used for coherentelasticae operations." }, { "instruction": "How do you call the from_hdf5() method in the CoherentElasticAE class?", "input": "OpenMC Python API CoherentElasticAE.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API CoherentElasticAE.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What is the IncoherentElasticAE class in OpenMC's Python API?", "input": "OpenMC Python API IncoherentElasticAE class", "output": "The IncoherentElasticAE class represents differential cross section for incoherent elastic scattering the differential cross section for incoherent elastic scattering may be represented as: .. math:: \\frac{d^2\\sigma}{de'd\\omega} (e\\rightarrow e',\\mu,t) = \\frac{\\sigma_b} {4\\pi} e^{-2ew'(t)(1-\\mu)} \\delta(e - e') where :math:`\\sigma_b` is the characteristic cross section in [b] and :math:`w'(t)` is the debye-waller integral divided by the atomic mass in [ev\\ :math:`^{-1}`]. It provides 3 methods and 0 properties for working with incoherentelasticae data in OpenMC." }, { "instruction": "What does the IncoherentElasticAE class do in OpenMC's Python API?", "input": "OpenMC Python API IncoherentElasticAE class description", "output": "The IncoherentElasticAE class differential cross section for incoherent elastic scattering the differential cross section for incoherent elastic scattering may be represented as: .. math:: \\frac{d^2\\sigma}{de'd\\omega} (e\\rightarrow e',\\mu,t) = \\frac{\\sigma_b} {4\\pi} e^{-2ew'(t)(1-\\mu)} \\delta(e - e') where :math:`\\sigma_b` is the characteristic cross section in [b] and :math:`w'(t)` is the debye-waller integral divided by the atomic mass in [ev\\ :math:`^{-1}`]. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the debye_waller parameter do when creating a IncoherentElasticAE?", "input": "OpenMC Python API IncoherentElasticAE constructor parameter debye_waller", "output": "When creating a IncoherentElasticAE, the debye_waller parameter specifies debye-waller integral in [ev\\ :math:`^{-1}`]. It should be a float value." }, { "instruction": "What is the debye_waller attribute of a IncoherentElasticAE?", "input": "OpenMC Python API IncoherentElasticAE attribute debye_waller", "output": "The debye_waller attribute of a IncoherentElasticAE contains debye-waller integral in [ev\\ :math:`^{-1}`]. It's a float value that you can access after creating a IncoherentElasticAE instance." }, { "instruction": "How do you call the __init__() method in the IncoherentElasticAE class?", "input": "OpenMC Python API IncoherentElasticAE.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, debye_waller: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the IncoherentElasticAE class?", "input": "OpenMC Python API IncoherentElasticAE.to_hdf5() method", "output": "The to_hdf5() method write incoherent elastic distribution to an hdf5 group. It's used for incoherentelasticae operations." }, { "instruction": "How do you call the to_hdf5() method in the IncoherentElasticAE class?", "input": "OpenMC Python API IncoherentElasticAE.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API IncoherentElasticAE.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the IncoherentElasticAE class?", "input": "OpenMC Python API IncoherentElasticAE.from_hdf5() method", "output": "The from_hdf5() method generate incoherent elastic distribution from hdf5 data. It's used for incoherentelasticae operations." }, { "instruction": "How do you call the from_hdf5() method in the IncoherentElasticAE class?", "input": "OpenMC Python API IncoherentElasticAE.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API IncoherentElasticAE.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What is the IncoherentElasticAEDiscrete class in OpenMC's Python API?", "input": "OpenMC Python API IncoherentElasticAEDiscrete class", "output": "The IncoherentElasticAEDiscrete class represents discrete angle representation of incoherent elastic scattering. It provides 3 methods and 0 properties for working with incoherentelasticaediscrete data in OpenMC." }, { "instruction": "What does the IncoherentElasticAEDiscrete class do in OpenMC's Python API?", "input": "OpenMC Python API IncoherentElasticAEDiscrete class description", "output": "The IncoherentElasticAEDiscrete class discrete angle representation of incoherent elastic scattering. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mu_out parameter do when creating a IncoherentElasticAEDiscrete?", "input": "OpenMC Python API IncoherentElasticAEDiscrete constructor parameter mu_out", "output": "When creating a IncoherentElasticAEDiscrete, the mu_out parameter specifies equi-probable discrete angles at each incoming energy. It should be a numpy.ndarray value." }, { "instruction": "How do you call the __init__() method in the IncoherentElasticAEDiscrete class?", "input": "OpenMC Python API IncoherentElasticAEDiscrete.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mu_out: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the IncoherentElasticAEDiscrete class?", "input": "OpenMC Python API IncoherentElasticAEDiscrete.to_hdf5() method", "output": "The to_hdf5() method write discrete incoherent elastic distribution to an hdf5 group. It's used for incoherentelasticaediscrete operations." }, { "instruction": "How do you call the to_hdf5() method in the IncoherentElasticAEDiscrete class?", "input": "OpenMC Python API IncoherentElasticAEDiscrete.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API IncoherentElasticAEDiscrete.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the IncoherentElasticAEDiscrete class?", "input": "OpenMC Python API IncoherentElasticAEDiscrete.from_hdf5() method", "output": "The from_hdf5() method generate discrete incoherent elastic distribution from hdf5 data. It's used for incoherentelasticaediscrete operations." }, { "instruction": "How do you call the from_hdf5() method in the IncoherentElasticAEDiscrete class?", "input": "OpenMC Python API IncoherentElasticAEDiscrete.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API IncoherentElasticAEDiscrete.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What is the IncoherentInelasticAEDiscrete class in OpenMC's Python API?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete class", "output": "The IncoherentInelasticAEDiscrete class represents discrete angle representation of incoherent inelastic scattering. It provides 3 methods and 0 properties for working with incoherentinelasticaediscrete data in OpenMC." }, { "instruction": "What does the IncoherentInelasticAEDiscrete class do in OpenMC's Python API?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete class description", "output": "The IncoherentInelasticAEDiscrete class discrete angle representation of incoherent inelastic scattering. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy_out parameter do when creating a IncoherentInelasticAEDiscrete?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete constructor parameter energy_out", "output": "When creating a IncoherentInelasticAEDiscrete, the energy_out parameter specifies outgoing energies for each incoming energy. It should be a numpy.ndarray value." }, { "instruction": "What does the mu_out parameter do when creating a IncoherentInelasticAEDiscrete?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete constructor parameter mu_out", "output": "When creating a IncoherentInelasticAEDiscrete, the mu_out parameter specifies discrete angles for each incoming/outgoing energy. It should be a numpy.ndarray value." }, { "instruction": "What does the skewed parameter do when creating a IncoherentInelasticAEDiscrete?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete constructor parameter skewed", "output": "When creating a IncoherentInelasticAEDiscrete, the skewed parameter specifies whether discrete angles are equi-probable or have a skewed distribution. It should be a bool value." }, { "instruction": "What is the energy_out attribute of a IncoherentInelasticAEDiscrete?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete attribute energy_out", "output": "The energy_out attribute of a IncoherentInelasticAEDiscrete contains outgoing energies for each incoming energy. It's a numpy.ndarray value that you can access after creating a IncoherentInelasticAEDiscrete instance." }, { "instruction": "What is the mu_out attribute of a IncoherentInelasticAEDiscrete?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete attribute mu_out", "output": "The mu_out attribute of a IncoherentInelasticAEDiscrete contains discrete angles for each incoming/outgoing energy. It's a numpy.ndarray value that you can access after creating a IncoherentInelasticAEDiscrete instance." }, { "instruction": "What is the skewed attribute of a IncoherentInelasticAEDiscrete?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete attribute skewed", "output": "The skewed attribute of a IncoherentInelasticAEDiscrete contains whether discrete angles are equi-probable or have a skewed distribution. It's a bool value that you can access after creating a IncoherentInelasticAEDiscrete instance." }, { "instruction": "How do you call the __init__() method in the IncoherentInelasticAEDiscrete class?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy_out: Any, mu_out: Any, skewed: Any). It takes 4 parameters." }, { "instruction": "What does the to_hdf5() method do in the IncoherentInelasticAEDiscrete class?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete.to_hdf5() method", "output": "The to_hdf5() method write discrete incoherent inelastic distribution to an hdf5 group. It's used for incoherentinelasticaediscrete operations." }, { "instruction": "How do you call the to_hdf5() method in the IncoherentInelasticAEDiscrete class?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the IncoherentInelasticAEDiscrete class?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete.from_hdf5() method", "output": "The from_hdf5() method generate discrete incoherent inelastic distribution from hdf5 data. It's used for incoherentinelasticaediscrete operations." }, { "instruction": "How do you call the from_hdf5() method in the IncoherentInelasticAEDiscrete class?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API IncoherentInelasticAEDiscrete.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What is the MixedElasticAE class in OpenMC's Python API?", "input": "OpenMC Python API MixedElasticAE class", "output": "The MixedElasticAE class represents secondary distribution for mixed coherent/incoherent thermal elastic .. versionadded:: 0.13.1. It provides 3 methods and 0 properties for working with mixedelasticae data in OpenMC." }, { "instruction": "What does the MixedElasticAE class do in OpenMC's Python API?", "input": "OpenMC Python API MixedElasticAE class description", "output": "The MixedElasticAE class secondary distribution for mixed coherent/incoherent thermal elastic .. versionadded:: 0.13.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the coherent parameter do when creating a MixedElasticAE?", "input": "OpenMC Python API MixedElasticAE constructor parameter coherent", "output": "When creating a MixedElasticAE, the coherent parameter specifies secondary distribution for coherent elastic scattering. It should be a AngleEnergy value." }, { "instruction": "What does the incoherent parameter do when creating a MixedElasticAE?", "input": "OpenMC Python API MixedElasticAE constructor parameter incoherent", "output": "When creating a MixedElasticAE, the incoherent parameter specifies secondary distribution for incoherent elastic scattering. It should be a AngleEnergy value." }, { "instruction": "What is the coherent attribute of a MixedElasticAE?", "input": "OpenMC Python API MixedElasticAE attribute coherent", "output": "The coherent attribute of a MixedElasticAE contains secondary distribution for coherent elastic scattering. It's a AngleEnergy value that you can access after creating a MixedElasticAE instance." }, { "instruction": "What is the incoherent attribute of a MixedElasticAE?", "input": "OpenMC Python API MixedElasticAE attribute incoherent", "output": "The incoherent attribute of a MixedElasticAE contains secondary distribution for incoherent elastic scattering. It's a AngleEnergy value that you can access after creating a MixedElasticAE instance." }, { "instruction": "How do you call the __init__() method in the MixedElasticAE class?", "input": "OpenMC Python API MixedElasticAE.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, coherent: Any, incoherent: Any). It takes 3 parameters." }, { "instruction": "What does the to_hdf5() method do in the MixedElasticAE class?", "input": "OpenMC Python API MixedElasticAE.to_hdf5() method", "output": "The to_hdf5() method write mixed elastic distribution to an hdf5 group. It's used for mixedelasticae operations." }, { "instruction": "How do you call the to_hdf5() method in the MixedElasticAE class?", "input": "OpenMC Python API MixedElasticAE.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API MixedElasticAE.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the MixedElasticAE class?", "input": "OpenMC Python API MixedElasticAE.from_hdf5() method", "output": "The from_hdf5() method generate mixed thermal elastic distribution from hdf5 data. It's used for mixedelasticae operations." }, { "instruction": "How do you call the from_hdf5() method in the MixedElasticAE class?", "input": "OpenMC Python API MixedElasticAE.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API MixedElasticAE.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What is the UncorrelatedAngleEnergy class in OpenMC's Python API?", "input": "OpenMC Python API UncorrelatedAngleEnergy class", "output": "The UncorrelatedAngleEnergy class represents uncorrelated angle-energy distribution. It provides 7 methods and 0 properties for working with uncorrelatedangleenergy data in OpenMC." }, { "instruction": "What does the UncorrelatedAngleEnergy class do in OpenMC's Python API?", "input": "OpenMC Python API UncorrelatedAngleEnergy class description", "output": "The UncorrelatedAngleEnergy class uncorrelated angle-energy distribution. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the angle parameter do when creating a UncorrelatedAngleEnergy?", "input": "OpenMC Python API UncorrelatedAngleEnergy constructor parameter angle", "output": "When creating a UncorrelatedAngleEnergy, the angle parameter specifies distribution of outgoing angles represented as scattering cosines. It should be a openmc.data.AngleDistribution value." }, { "instruction": "What does the energy parameter do when creating a UncorrelatedAngleEnergy?", "input": "OpenMC Python API UncorrelatedAngleEnergy constructor parameter energy", "output": "When creating a UncorrelatedAngleEnergy, the energy parameter specifies distribution of outgoing energies. It should be a openmc.data.EnergyDistribution value." }, { "instruction": "What is the angle attribute of a UncorrelatedAngleEnergy?", "input": "OpenMC Python API UncorrelatedAngleEnergy attribute angle", "output": "The angle attribute of a UncorrelatedAngleEnergy contains distribution of outgoing angles represented as scattering cosines. It's a openmc.data.AngleDistribution value that you can access after creating a UncorrelatedAngleEnergy instance." }, { "instruction": "What is the energy attribute of a UncorrelatedAngleEnergy?", "input": "OpenMC Python API UncorrelatedAngleEnergy attribute energy", "output": "The energy attribute of a UncorrelatedAngleEnergy contains distribution of outgoing energies. It's a openmc.data.EnergyDistribution value that you can access after creating a UncorrelatedAngleEnergy instance." }, { "instruction": "How do you call the __init__() method in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, angle: Any, energy: Any). It takes 3 parameters." }, { "instruction": "How do you call the angle() method in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.angle() method signature", "output": "To call the angle() method, use: @property def angle(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the angle() method in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.angle() method signature", "output": "To call the angle() method, use: @angle.setter def angle(self: Any, angle: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.to_hdf5() method", "output": "The to_hdf5() method write distribution to an hdf5 group. It's used for uncorrelatedangleenergy operations." }, { "instruction": "How do you call the to_hdf5() method in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API UncorrelatedAngleEnergy.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.from_hdf5() method", "output": "The from_hdf5() method generate uncorrelated angle-energy distribution from hdf5 data. It's used for uncorrelatedangleenergy operations." }, { "instruction": "How do you call the from_hdf5() method in the UncorrelatedAngleEnergy class?", "input": "OpenMC Python API UncorrelatedAngleEnergy.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API UncorrelatedAngleEnergy.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What is the ProbabilityTables class in OpenMC's Python API?", "input": "OpenMC Python API ProbabilityTables class", "output": "The ProbabilityTables class represents unresolved resonance region probability tables. It provides 16 methods and 0 properties for working with probabilitytables data in OpenMC." }, { "instruction": "What does the ProbabilityTables class do in OpenMC's Python API?", "input": "OpenMC Python API ProbabilityTables class description", "output": "The ProbabilityTables class unresolved resonance region probability tables. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy parameter do when creating a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables constructor parameter energy", "output": "When creating a ProbabilityTables, the energy parameter specifies energies in ev at which probability tables exist. It should be a Iterable of float value." }, { "instruction": "What does the table parameter do when creating a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables constructor parameter table", "output": "When creating a ProbabilityTables, the table parameter specifies probability tables for each energy. this array is of shape (n, 6, m) where n is the number of energies and m is the number of bands. the second dimension indicates whether the value is for the cumulative probability (0), total (1), elastic (2), fission (3), :math:`(n,\\gamma)` (4), or heating number (5).. It should be a numpy.ndarray value." }, { "instruction": "What does the interpolation parameter do when creating a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables constructor parameter interpolation", "output": "When creating a ProbabilityTables, the interpolation parameter specifies interpolation scheme between tables. It should be a {2, 5} value." }, { "instruction": "What does the inelastic_flag parameter do when creating a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables constructor parameter inelastic_flag", "output": "When creating a ProbabilityTables, the inelastic_flag parameter specifies a value less than zero indicates that the inelastic cross section is zero within the unresolved energy range. a value greater than zero indicates the mt number for a reaction whose cross section is to be used in the unresolved range.. It should be a int value." }, { "instruction": "What does the absorption_flag parameter do when creating a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables constructor parameter absorption_flag", "output": "When creating a ProbabilityTables, the absorption_flag parameter specifies a value less than zero indicates that the \"other absorption\" cross section is zero within the unresolved energy range. a value greater than zero indicates the mt number for a reaction whose cross section is to be used in the unresolved range.. It should be a int value." }, { "instruction": "What does the multiply_smooth parameter do when creating a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables constructor parameter multiply_smooth", "output": "When creating a ProbabilityTables, the multiply_smooth parameter specifies indicate whether probability table values are cross sections (false) or whether they must be multiply by the corresponding \"smooth\" cross sections (true).. It should be a bool value." }, { "instruction": "What is the energy attribute of a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables attribute energy", "output": "The energy attribute of a ProbabilityTables contains energies in ev at which probability tables exist. It's a Iterable of float value that you can access after creating a ProbabilityTables instance." }, { "instruction": "What is the table attribute of a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables attribute table", "output": "The table attribute of a ProbabilityTables contains probability tables for each energy. this array is of shape (n, 6, m) where n is the number of energies and m is the number of bands. the second dimension indicates whether the value is for the cumulative probability (0), total (1), elastic (2), fission (3), :math:`(n,\\gamma)` (4), or heating number (5).. It's a numpy.ndarray value that you can access after creating a ProbabilityTables instance." }, { "instruction": "What is the interpolation attribute of a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables attribute interpolation", "output": "The interpolation attribute of a ProbabilityTables contains interpolation scheme between tables. It's a {2, 5} value that you can access after creating a ProbabilityTables instance." }, { "instruction": "What is the inelastic_flag attribute of a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables attribute inelastic_flag", "output": "The inelastic_flag attribute of a ProbabilityTables contains a value less than zero indicates that the inelastic cross section is zero within the unresolved energy range. a value greater than zero indicates the mt number for a reaction whose cross section is to be used in the unresolved range.. It's a int value that you can access after creating a ProbabilityTables instance." }, { "instruction": "What is the absorption_flag attribute of a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables attribute absorption_flag", "output": "The absorption_flag attribute of a ProbabilityTables contains a value less than zero indicates that the \"other absorption\" cross section is zero within the unresolved energy range. a value greater than zero indicates the mt number for a reaction whose cross section is to be used in the unresolved range.. It's a int value that you can access after creating a ProbabilityTables instance." }, { "instruction": "What is the multiply_smooth attribute of a ProbabilityTables?", "input": "OpenMC Python API ProbabilityTables attribute multiply_smooth", "output": "The multiply_smooth attribute of a ProbabilityTables contains indicate whether probability table values are cross sections (false) or whether they must be multiply by the corresponding \"smooth\" cross sections (true).. It's a bool value that you can access after creating a ProbabilityTables instance." }, { "instruction": "How do you call the __init__() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy: Any, table: Any, interpolation: Any, inelastic_flag: Any, absorption_flag: Any, multiply_smooth: Any). It takes 7 parameters." }, { "instruction": "How do you call the absorption_flag() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.absorption_flag() method signature", "output": "To call the absorption_flag() method, use: @property def absorption_flag(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the absorption_flag() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.absorption_flag() method signature", "output": "To call the absorption_flag() method, use: @absorption_flag.setter def absorption_flag(self: Any, absorption_flag: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the inelastic_flag() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.inelastic_flag() method signature", "output": "To call the inelastic_flag() method, use: @property def inelastic_flag(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the inelastic_flag() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.inelastic_flag() method signature", "output": "To call the inelastic_flag() method, use: @inelastic_flag.setter def inelastic_flag(self: Any, inelastic_flag: Any). It takes 2 parameters." }, { "instruction": "How do you call the interpolation() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interpolation: Any). It takes 2 parameters." }, { "instruction": "How do you call the multiply_smooth() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.multiply_smooth() method signature", "output": "To call the multiply_smooth() method, use: @property def multiply_smooth(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the multiply_smooth() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.multiply_smooth() method signature", "output": "To call the multiply_smooth() method, use: @multiply_smooth.setter def multiply_smooth(self: Any, multiply_smooth: Any). It takes 2 parameters." }, { "instruction": "How do you call the table() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.table() method signature", "output": "To call the table() method, use: @property def table(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the table() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.table() method signature", "output": "To call the table() method, use: @table.setter def table(self: Any, table: Any). It takes 2 parameters." }, { "instruction": "What does the to_hdf5() method do in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.to_hdf5() method", "output": "The to_hdf5() method write probability tables to an hdf5 group. It's used for probabilitytables operations." }, { "instruction": "How do you call the to_hdf5() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the to_hdf5() method?", "input": "OpenMC Python API ProbabilityTables.to_hdf5() parameter group", "output": "The group parameter hdf5 group to write to. It should be a h5py.Group value." }, { "instruction": "What does the from_hdf5() method do in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.from_hdf5() method", "output": "The from_hdf5() method generate probability tables from hdf5 data. It's used for probabilitytables operations." }, { "instruction": "How do you call the from_hdf5() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API ProbabilityTables.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the from_ace() method do in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.from_ace() method", "output": "The from_ace() method generate probability tables from an ace table. It's used for probabilitytables operations." }, { "instruction": "How do you call the from_ace() method in the ProbabilityTables class?", "input": "OpenMC Python API ProbabilityTables.from_ace() method signature", "output": "To call the from_ace() method, use: @classmethod def from_ace(cls: Any, ace: Any). It takes 2 parameters." }, { "instruction": "What does the ace parameter do in the from_ace() method?", "input": "OpenMC Python API ProbabilityTables.from_ace() parameter ace", "output": "The ace parameter ace table to read from. It should be a openmc.data.ace.Table value." }, { "instruction": "How do you call the celi_f1() function in OpenMC's Python API?", "input": "OpenMC Python API celi_f1() function signature", "output": "To call the celi_f1() function, use: def celi_f1(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the celi_f2() function in OpenMC's Python API?", "input": "OpenMC Python API celi_f2() function signature", "output": "To call the celi_f2() function, use: def celi_f2(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the cf4_f1() function in OpenMC's Python API?", "input": "OpenMC Python API cf4_f1() function signature", "output": "To call the cf4_f1() function, use: def cf4_f1(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the cf4_f2() function in OpenMC's Python API?", "input": "OpenMC Python API cf4_f2() function signature", "output": "To call the cf4_f2() function, use: def cf4_f2(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the cf4_f3() function in OpenMC's Python API?", "input": "OpenMC Python API cf4_f3() function signature", "output": "To call the cf4_f3() function, use: def cf4_f3(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the cf4_f4() function in OpenMC's Python API?", "input": "OpenMC Python API cf4_f4() function signature", "output": "To call the cf4_f4() function, use: def cf4_f4(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the rk4_f1() function in OpenMC's Python API?", "input": "OpenMC Python API rk4_f1() function signature", "output": "To call the rk4_f1() function, use: def rk4_f1(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the rk4_f4() function in OpenMC's Python API?", "input": "OpenMC Python API rk4_f4() function signature", "output": "To call the rk4_f4() function, use: def rk4_f4(chain: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the leqi_f1() function in OpenMC's Python API?", "input": "OpenMC Python API leqi_f1() function signature", "output": "To call the leqi_f1() function, use: def leqi_f1(chain: Any, inputs: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the leqi_f2() function in OpenMC's Python API?", "input": "OpenMC Python API leqi_f2() function signature", "output": "To call the leqi_f2() function, use: def leqi_f2(chain: Any, inputs: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the leqi_f3() function in OpenMC's Python API?", "input": "OpenMC Python API leqi_f3() function signature", "output": "To call the leqi_f3() function, use: def leqi_f3(chain: Any, inputs: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the leqi_f4() function in OpenMC's Python API?", "input": "OpenMC Python API leqi_f4() function signature", "output": "To call the leqi_f4() function, use: def leqi_f4(chain: Any, inputs: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "What is the TransportOperator class in OpenMC's Python API?", "input": "OpenMC Python API TransportOperator class", "output": "The TransportOperator class represents abstract class defining a transport operator each depletion integrator is written to work with a generic transport operator that takes a vector of material compositions and returns an eigenvalue and reaction rates. this abstract class sets the requirements for such a transport operator. users should instantiate :class:`openmc.deplete.coupledoperator` or :class:`openmc.deplete.independentoperator` rather than this class. It provides 8 methods and 0 properties for working with transportoperator data in OpenMC." }, { "instruction": "What does the TransportOperator class do in OpenMC's Python API?", "input": "OpenMC Python API TransportOperator class description", "output": "The TransportOperator class abstract class defining a transport operator each depletion integrator is written to work with a generic transport operator that takes a vector of material compositions and returns an eigenvalue and reaction rates. this abstract class sets the requirements for such a transport operator. users should instantiate :class:`openmc.deplete.coupledoperator` or :class:`openmc.deplete.independentoperator` rather than this class. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the chain_file parameter do when creating a TransportOperator?", "input": "OpenMC Python API TransportOperator constructor parameter chain_file", "output": "When creating a TransportOperator, the chain_file parameter specifies path to the depletion chain xml file. It should be a str value." }, { "instruction": "What does the fission_q parameter do when creating a TransportOperator?", "input": "OpenMC Python API TransportOperator constructor parameter fission_q", "output": "When creating a TransportOperator, the fission_q parameter specifies dictionary of nuclides and their fission q values [ev]. if not given, values will be pulled from the ``chain_file``.. It should be a dict, optional value." }, { "instruction": "What does the prev_results parameter do when creating a TransportOperator?", "input": "OpenMC Python API TransportOperator constructor parameter prev_results", "output": "When creating a TransportOperator, the prev_results parameter specifies results from a previous depletion calculation.. It should be a Results, optional value." }, { "instruction": "What is the output_dir attribute of a TransportOperator?", "input": "OpenMC Python API TransportOperator attribute output_dir", "output": "The output_dir attribute of a TransportOperator contains path to output directory to save results.. It's a pathlib.Path value that you can access after creating a TransportOperator instance." }, { "instruction": "What is the prev_res attribute of a TransportOperator?", "input": "OpenMC Python API TransportOperator attribute prev_res", "output": "The prev_res attribute of a TransportOperator contains results from a previous depletion calculation. ``none`` if no results are to be used.. It's a Results or None value that you can access after creating a TransportOperator instance." }, { "instruction": "What is the chain attribute of a TransportOperator?", "input": "OpenMC Python API TransportOperator attribute chain", "output": "The chain attribute of a TransportOperator contains the depletion chain information necessary to form matrices and tallies.. It's a openmc.deplete.Chain value that you can access after creating a TransportOperator instance." }, { "instruction": "How do you call the __init__() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, chain_file: Any, fission_q: Any, prev_results: Any). It takes 4 parameters." }, { "instruction": "What does the __call__() method do in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.__call__() method", "output": "The __call__() method runs a simulation. It's used for transportoperator operations." }, { "instruction": "How do you call the __call__() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.__call__() method signature", "output": "To call the __call__() method, use: @abstractmethod def __call__(self: Any, vec: Any, source_rate: Any). It takes 3 parameters." }, { "instruction": "What does the vec parameter do in the __call__() method?", "input": "OpenMC Python API TransportOperator.__call__() parameter vec", "output": "The vec parameter total atoms to be used in function.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API TransportOperator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "How do you call the output_dir() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.output_dir() method signature", "output": "To call the output_dir() method, use: @property def output_dir(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the output_dir() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.output_dir() method signature", "output": "To call the output_dir() method, use: @output_dir.setter def output_dir(self: Any, output_dir: Any). It takes 2 parameters." }, { "instruction": "What does the initial_condition() method do in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.initial_condition() method", "output": "The initial_condition() method performs final setup and returns initial condition. It's used for transportoperator operations." }, { "instruction": "How do you call the initial_condition() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.initial_condition() method signature", "output": "To call the initial_condition() method, use: @abstractmethod def initial_condition(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_results_info() method do in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.get_results_info() method", "output": "The get_results_info() method returns volume list, cell lists, and nuc lists. It's used for transportoperator operations." }, { "instruction": "How do you call the get_results_info() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.get_results_info() method signature", "output": "To call the get_results_info() method, use: @abstractmethod def get_results_info(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_results_info() method return in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.get_results_info() return value", "output": "The get_results_info() method returns volumes corresponding to materials in burn_list. The return type is dict of str to float." }, { "instruction": "What does the get_results_info() method return in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.get_results_info() return value", "output": "The get_results_info() method returns a list of all nuclide names. used for sorting the simulation.. The return type is list of str." }, { "instruction": "What does the get_results_info() method return in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.get_results_info() return value", "output": "The get_results_info() method returns a list of all cell ids to be burned. used for sorting the simulation.. The return type is list of int." }, { "instruction": "What does the get_results_info() method return in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.get_results_info() return value", "output": "The get_results_info() method returns all burnable materials in the geometry.. The return type is list of int." }, { "instruction": "How do you call the finalize() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.finalize() method signature", "output": "To call the finalize() method, use: def finalize(self: Any). It takes 1 parameters." }, { "instruction": "What does the write_bos_data() method do in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.write_bos_data() method", "output": "The write_bos_data() method document beginning of step data for a given step called at the beginning of a depletion step and at the final point in the simulation. It's used for transportoperator operations." }, { "instruction": "How do you call the write_bos_data() method in the TransportOperator class?", "input": "OpenMC Python API TransportOperator.write_bos_data() method signature", "output": "To call the write_bos_data() method, use: @abstractmethod def write_bos_data(self: Any, step: int). It takes 2 parameters." }, { "instruction": "What does the step parameter do in the write_bos_data() method?", "input": "OpenMC Python API TransportOperator.write_bos_data() parameter step", "output": "The step parameter current depletion step including restarts. It should be a int value." }, { "instruction": "What is the ReactionRateHelper class in OpenMC's Python API?", "input": "OpenMC Python API ReactionRateHelper class", "output": "The ReactionRateHelper class represents abstract class for generating reaction rates for operators responsible for generating reaction rate tallies for burnable materials, given nuclides and scores from the operator. reaction rates are passed back to the operator to be used by an :class:`openmc.deplete.operatorresult` instance. It provides 6 methods and 0 properties for working with reactionratehelper data in OpenMC." }, { "instruction": "What does the ReactionRateHelper class do in OpenMC's Python API?", "input": "OpenMC Python API ReactionRateHelper class description", "output": "The ReactionRateHelper class abstract class for generating reaction rates for operators responsible for generating reaction rate tallies for burnable materials, given nuclides and scores from the operator. reaction rates are passed back to the operator to be used by an :class:`openmc.deplete.operatorresult` instance. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the n_nucs parameter do when creating a ReactionRateHelper?", "input": "OpenMC Python API ReactionRateHelper constructor parameter n_nucs", "output": "When creating a ReactionRateHelper, the n_nucs parameter specifies number of burnable nuclides tracked by :class:`openmc.deplete.abc.transportoperator`. It should be a int value." }, { "instruction": "What does the n_react parameter do when creating a ReactionRateHelper?", "input": "OpenMC Python API ReactionRateHelper constructor parameter n_react", "output": "When creating a ReactionRateHelper, the n_react parameter specifies number of reactions tracked by :class:`openmc.deplete.abc.transportoperator`. It should be a int value." }, { "instruction": "What is the nuclides attribute of a ReactionRateHelper?", "input": "OpenMC Python API ReactionRateHelper attribute nuclides", "output": "The nuclides attribute of a ReactionRateHelper contains all nuclides with desired reaction rates.. It's a list of str value that you can access after creating a ReactionRateHelper instance." }, { "instruction": "How do you call the __init__() method in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, n_nucs: Any, n_react: Any). It takes 3 parameters." }, { "instruction": "What does the generate_tallies() method do in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.generate_tallies() method", "output": "The generate_tallies() method use the c api to build tallies needed for reaction rates. It's used for reactionratehelper operations." }, { "instruction": "How do you call the generate_tallies() method in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: @abstractmethod def generate_tallies(self: Any, materials: Any, scores: Any). It takes 3 parameters." }, { "instruction": "What does the nuclides() method do in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.nuclides() method", "output": "The nuclides() method list of nuclides with requested reaction rates. It's used for reactionratehelper operations." }, { "instruction": "How do you call the nuclides() method in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.nuclides() method signature", "output": "To call the nuclides() method, use: @nuclides.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the get_material_rates() method do in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.get_material_rates() method", "output": "The get_material_rates() method return 2d array of [nuclide, reaction] reaction rates. It's used for reactionratehelper operations." }, { "instruction": "How do you call the get_material_rates() method in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.get_material_rates() method signature", "output": "To call the get_material_rates() method, use: @abstractmethod def get_material_rates(self: Any, mat_id: int, nuc_index: Any, react_index: Any). It takes 4 parameters." }, { "instruction": "What does the mat_id parameter do in the get_material_rates() method?", "input": "OpenMC Python API ReactionRateHelper.get_material_rates() parameter mat_id", "output": "The mat_id parameter unique id for the requested material. It should be a int value." }, { "instruction": "What does the nuc_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API ReactionRateHelper.get_material_rates() parameter nuc_index", "output": "The nuc_index parameter ordering of desired nuclides. It should be a list of str value." }, { "instruction": "What does the react_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API ReactionRateHelper.get_material_rates() parameter react_index", "output": "The react_index parameter ordering of reactions. It should be a list of str value." }, { "instruction": "What does the divide_by_atoms() method do in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.divide_by_atoms() method", "output": "The divide_by_atoms() method normalize reaction rates by number of atoms acts on the current material examined by :meth:`get_material_rates`. It's used for reactionratehelper operations." }, { "instruction": "How do you call the divide_by_atoms() method in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.divide_by_atoms() method signature", "output": "To call the divide_by_atoms() method, use: def divide_by_atoms(self: Any, number: Any). It takes 2 parameters." }, { "instruction": "What does the number parameter do in the divide_by_atoms() method?", "input": "OpenMC Python API ReactionRateHelper.divide_by_atoms() parameter number", "output": "The number parameter number of each nuclide in [atom] tracked in the calculation.. It should be a iterable of float value." }, { "instruction": "What does the divide_by_atoms() method return in the ReactionRateHelper class?", "input": "OpenMC Python API ReactionRateHelper.divide_by_atoms() return value", "output": "The divide_by_atoms() method returns array of reactions rates of shape ``(n_nuclides, n_rxns)`` normalized by the number of nuclides. The return type is numpy.ndarray." }, { "instruction": "What is the NormalizationHelper class in OpenMC's Python API?", "input": "OpenMC Python API NormalizationHelper class", "output": "The NormalizationHelper class represents abstract class for obtaining normalization factor on tallies this helper class determines how reaction rates calculated by an instance of :class:`openmc.deplete.abc.transportoperator` should be normalized for the purpose of constructing a burnup matrix. based on the method chosen, the power or source rate provided by the user, and reaction rates from a :class:`reactionratehelper`, this class will scale reaction rates to the correct values. It provides 7 methods and 0 properties for working with normalizationhelper data in OpenMC." }, { "instruction": "What does the NormalizationHelper class do in OpenMC's Python API?", "input": "OpenMC Python API NormalizationHelper class description", "output": "The NormalizationHelper class abstract class for obtaining normalization factor on tallies this helper class determines how reaction rates calculated by an instance of :class:`openmc.deplete.abc.transportoperator` should be normalized for the purpose of constructing a burnup matrix. based on the method chosen, the power or source rate provided by the user, and reaction rates from a :class:`reactionratehelper`, this class will scale reaction rates to the correct values. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the nuclides attribute of a NormalizationHelper?", "input": "OpenMC Python API NormalizationHelper attribute nuclides", "output": "The nuclides attribute of a NormalizationHelper contains all nuclides with desired reaction rates. ordered to be consistent with :class:`openmc.deplete.abc.transportoperator`. It's a list of str value that you can access after creating a NormalizationHelper instance." }, { "instruction": "How do you call the __init__() method in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "What does the reset() method do in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.reset() method", "output": "The reset() method reset state for normalization. It's used for normalizationhelper operations." }, { "instruction": "How do you call the reset() method in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.reset() method signature", "output": "To call the reset() method, use: def reset(self: Any). It takes 1 parameters." }, { "instruction": "What does the prepare() method do in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.prepare() method", "output": "The prepare() method perform work needed to obtain energy produced this method is called prior to calculating the reaction rates in :meth:`openmc.deplete.abc.transportoperator.initial_condition`. only used for energy-based normalization. It's used for normalizationhelper operations." }, { "instruction": "How do you call the prepare() method in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.prepare() method signature", "output": "To call the prepare() method, use: @abstractmethod def prepare(self: Any, chain_nucs: Any, rate_index: dict). It takes 3 parameters." }, { "instruction": "What does the chain_nucs parameter do in the prepare() method?", "input": "OpenMC Python API NormalizationHelper.prepare() parameter chain_nucs", "output": "The chain_nucs parameter all nuclides to be tracked in this problem. It should be a list of str value." }, { "instruction": "What does the rate_index parameter do in the prepare() method?", "input": "OpenMC Python API NormalizationHelper.prepare() parameter rate_index", "output": "The rate_index parameter mapping from nuclide name to index in the `fission_rates` for :meth:`update`.. It should be a dict of str to int value." }, { "instruction": "What does the update() method do in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.update() method", "output": "The update() method update the normalization based on fission rates (only used for energy-based normalization). It's used for normalizationhelper operations." }, { "instruction": "How do you call the update() method in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.update() method signature", "output": "To call the update() method, use: def update(self: Any, fission_rates: Any). It takes 2 parameters." }, { "instruction": "What does the fission_rates parameter do in the update() method?", "input": "OpenMC Python API NormalizationHelper.update() parameter fission_rates", "output": "The fission_rates parameter fission reaction rate for each isotope in the specified material. should be ordered corresponding to initial ``rate_index`` used in :meth:`prepare`. It should be a numpy.ndarray value." }, { "instruction": "What does the nuclides() method do in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.nuclides() method", "output": "The nuclides() method list of nuclides with requested reaction rates. It's used for normalizationhelper operations." }, { "instruction": "How do you call the nuclides() method in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.nuclides() method signature", "output": "To call the nuclides() method, use: @nuclides.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the factor() method do in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.factor() method", "output": "The factor() method return normalization factor. It's used for normalizationhelper operations." }, { "instruction": "How do you call the factor() method in the NormalizationHelper class?", "input": "OpenMC Python API NormalizationHelper.factor() method signature", "output": "To call the factor() method, use: @abstractmethod def factor(self: Any, source_rate: float). It takes 2 parameters." }, { "instruction": "What does the source_rate parameter do in the factor() method?", "input": "OpenMC Python API NormalizationHelper.factor() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What is the FissionYieldHelper class in OpenMC's Python API?", "input": "OpenMC Python API FissionYieldHelper class", "output": "The FissionYieldHelper class represents abstract class for processing energy dependent fission yields. It provides 7 methods and 0 properties for working with fissionyieldhelper data in OpenMC." }, { "instruction": "What does the FissionYieldHelper class do in OpenMC's Python API?", "input": "OpenMC Python API FissionYieldHelper class description", "output": "The FissionYieldHelper class abstract class for processing energy dependent fission yields. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the chain_nuclides parameter do when creating a FissionYieldHelper?", "input": "OpenMC Python API FissionYieldHelper constructor parameter chain_nuclides", "output": "When creating a FissionYieldHelper, the chain_nuclides parameter specifies nuclides tracked in the depletion chain. all nuclides are not required to have fission yield data.. It should be a iterable of openmc.deplete.Nuclide value." }, { "instruction": "What is the constant_yields attribute of a FissionYieldHelper?", "input": "OpenMC Python API FissionYieldHelper attribute constant_yields", "output": "The constant_yields attribute of a FissionYieldHelper contains fission yields for all nuclides that only have one set of fission yield data. dictionary of form ``{str: {str: float}}`` representing yields for ``{parent: {product: yield}}``. default return object is an empty dictionary. It's a collections.defaultdict value that you can access after creating a FissionYieldHelper instance." }, { "instruction": "How do you call the __init__() method in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, chain_nuclides: Any). It takes 2 parameters." }, { "instruction": "How do you call the constant_yields() method in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.constant_yields() method signature", "output": "To call the constant_yields() method, use: @property def constant_yields(self: Any). It takes 1 parameters." }, { "instruction": "What does the weighted_yields() method do in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.weighted_yields() method", "output": "The weighted_yields() method return fission yields for a specific material. It's used for fissionyieldhelper operations." }, { "instruction": "How do you call the weighted_yields() method in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.weighted_yields() method signature", "output": "To call the weighted_yields() method, use: @abstractmethod def weighted_yields(self: Any, local_mat_index: Any). It takes 2 parameters." }, { "instruction": "What does the local_mat_index parameter do in the weighted_yields() method?", "input": "OpenMC Python API FissionYieldHelper.weighted_yields() parameter local_mat_index", "output": "The local_mat_index parameter index for the material with requested fission yields. should correspond to the material represented in ``mat_indexes[local_mat_index]`` during :meth:`generate_tallies`.. It should be a int value." }, { "instruction": "What does the weighted_yields() method return in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.weighted_yields() return value", "output": "The weighted_yields() method returns dictionary-like object mapping ``{str: {str: float}``. this reflects fission yields for ``{parent: {product: fyield}}``.. The return type is collections.abc.Mapping." }, { "instruction": "What does the unpack() method do in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.unpack() method", "output": "The unpack() method unpack tally data prior to compute fission yields.\n\n called after a :meth:`openmc.deplete.abc.transportoperator.__call__`\n routine during the normalization of reaction rates.\n\n not necessary for all subclasses to implement, unless tallies\n are used.. It's used for fissionyieldhelper operations." }, { "instruction": "How do you call the unpack() method in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.unpack() method signature", "output": "To call the unpack() method, use: @staticmethod def unpack(). It takes 0 parameters." }, { "instruction": "What does the generate_tallies() method do in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.generate_tallies() method", "output": "The generate_tallies() method construct tallies necessary for computing fission yields called during the operator set up phase prior to depleting. not necessary for subclasses to implement. It's used for fissionyieldhelper operations." }, { "instruction": "How do you call the generate_tallies() method in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: @staticmethod def generate_tallies(materials: Any, mat_indexes: Any). It takes 2 parameters." }, { "instruction": "What does the materials parameter do in the generate_tallies() method?", "input": "OpenMC Python API FissionYieldHelper.generate_tallies() parameter materials", "output": "The materials parameter materials to be used in :class:`openmc.lib.materialfilter`. It should be a iterable of C-API materials value." }, { "instruction": "What does the mat_indexes parameter do in the generate_tallies() method?", "input": "OpenMC Python API FissionYieldHelper.generate_tallies() parameter mat_indexes", "output": "The mat_indexes parameter indices of tallied materials that will have their fission yields computed by this helper. necessary as the :class:`openmc.deplete.coupledoperator` that uses this helper may only burn a subset of all materials when running in parallel mode.. It should be a iterable of int value." }, { "instruction": "What does the update_tally_nuclides() method do in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.update_tally_nuclides() method", "output": "The update_tally_nuclides() method return nuclides with non-zero densities and yield data. It's used for fissionyieldhelper operations." }, { "instruction": "How do you call the update_tally_nuclides() method in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.update_tally_nuclides() method signature", "output": "To call the update_tally_nuclides() method, use: def update_tally_nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides parameter do in the update_tally_nuclides() method?", "input": "OpenMC Python API FissionYieldHelper.update_tally_nuclides() parameter nuclides", "output": "The nuclides parameter nuclides with non-zero densities from the :class:`openmc.deplete.abc.transportoperator`. It should be a iterable of str value." }, { "instruction": "What does the update_tally_nuclides() method return in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.update_tally_nuclides() return value", "output": "The update_tally_nuclides() method returns union of nuclides that the :class:`openmc.deplete.abc.transportoperator` says have non-zero densities at this stage and those that have yield data. sorted by nuclide name. The return type is list of str." }, { "instruction": "What does the from_operator() method do in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.from_operator() method", "output": "The from_operator() method create a new instance by pulling data from the operator all keyword arguments should be identical to their counterpart in the main ``__init__`` method. It's used for fissionyieldhelper operations." }, { "instruction": "How do you call the from_operator() method in the FissionYieldHelper class?", "input": "OpenMC Python API FissionYieldHelper.from_operator() method signature", "output": "To call the from_operator() method, use: @classmethod def from_operator(cls: Any, operator: Any). It takes 2 parameters." }, { "instruction": "What does the operator parameter do in the from_operator() method?", "input": "OpenMC Python API FissionYieldHelper.from_operator() parameter operator", "output": "The operator parameter operator with a depletion chain. It should be a openmc.deplete.abc.TransportOperator value." }, { "instruction": "What does the kwargs parameter do in the from_operator() method?", "input": "OpenMC Python API FissionYieldHelper.from_operator() parameter kwargs", "output": "The kwargs parameter additional keyword arguments to be used in constuction. It should be a optional value." }, { "instruction": "What is the Integrator class in OpenMC's Python API?", "input": "OpenMC Python API Integrator class", "output": "The Integrator class represents abstract class for solving the time-integration for depletion. It provides 13 methods and 0 properties for working with integrator data in OpenMC." }, { "instruction": "What does the Integrator class do in OpenMC's Python API?", "input": "OpenMC Python API Integrator class description", "output": "The Integrator class abstract class for solving the time-integration for depletion. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the Integrator class?", "input": "OpenMC Python API Integrator.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, operator: TransportOperator, timesteps: Any, power: Any, power_density: Any, source_rates: Any, timestep_units: str, solver: str, continue_timesteps: bool). It takes 9 parameters." }, { "instruction": "How do you call the solver() method in the Integrator class?", "input": "OpenMC Python API Integrator.solver() method signature", "output": "To call the solver() method, use: @property def solver(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the solver() method in the Integrator class?", "input": "OpenMC Python API Integrator.solver() method signature", "output": "To call the solver() method, use: @solver.setter def solver(self: Any, func: Any). It takes 2 parameters." }, { "instruction": "How do you call the _timed_deplete() method in the Integrator class?", "input": "OpenMC Python API Integrator._timed_deplete() method signature", "output": "To call the _timed_deplete() method, use: def _timed_deplete(self: Any, n: Any, rates: Any, dt: Any, matrix_func: Any). It takes 5 parameters." }, { "instruction": "What does the __call__() method do in the Integrator class?", "input": "OpenMC Python API Integrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for integrator operations." }, { "instruction": "How do you call the __call__() method in the Integrator class?", "input": "OpenMC Python API Integrator.__call__() method signature", "output": "To call the __call__() method, use: @abstractmethod def __call__(self: Any, n: Any, rates: ReactionRates, dt: float, source_rate: float, i: int). It takes 6 parameters." }, { "instruction": "What does the n parameter do in the __call__() method?", "input": "OpenMC Python API Integrator.__call__() parameter n", "output": "The n parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the rates parameter do in the __call__() method?", "input": "OpenMC Python API Integrator.__call__() parameter rates", "output": "The rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API Integrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API Integrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the i parameter do in the __call__() method?", "input": "OpenMC Python API Integrator.__call__() parameter i", "output": "The i parameter current depletion step index. It should be a int value." }, { "instruction": "What does the __call__() method return in the Integrator class?", "input": "OpenMC Python API Integrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the Integrator class?", "input": "OpenMC Python API Integrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the Integrator class?", "input": "OpenMC Python API Integrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from intermediate transport simulations. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What does the _num_stages() method do in the Integrator class?", "input": "OpenMC Python API Integrator._num_stages() method", "output": "The _num_stages() method number of intermediate transport solutions\n\n needed to ensure schemes are consistent with restarts. It's used for integrator operations." }, { "instruction": "How do you call the _num_stages() method in the Integrator class?", "input": "OpenMC Python API Integrator._num_stages() method signature", "output": "To call the _num_stages() method, use: @property, @abstractmethod def _num_stages(self: Any). It takes 1 parameters." }, { "instruction": "What does the __iter__() method do in the Integrator class?", "input": "OpenMC Python API Integrator.__iter__() method", "output": "The __iter__() method return pair of time step in [s] and source rate in [w] or [neutron/sec]. It's used for integrator operations." }, { "instruction": "How do you call the __iter__() method in the Integrator class?", "input": "OpenMC Python API Integrator.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "What does the __len__() method do in the Integrator class?", "input": "OpenMC Python API Integrator.__len__() method", "output": "The __len__() method return integer number of depletion intervals. It's used for integrator operations." }, { "instruction": "How do you call the __len__() method in the Integrator class?", "input": "OpenMC Python API Integrator.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "What does the _get_bos_data_from_operator() method do in the Integrator class?", "input": "OpenMC Python API Integrator._get_bos_data_from_operator() method", "output": "The _get_bos_data_from_operator() method get beginning of step concentrations, reaction rates from operator. It's used for integrator operations." }, { "instruction": "How do you call the _get_bos_data_from_operator() method in the Integrator class?", "input": "OpenMC Python API Integrator._get_bos_data_from_operator() method signature", "output": "To call the _get_bos_data_from_operator() method, use: def _get_bos_data_from_operator(self: Any, step_index: Any, source_rate: Any, bos_conc: Any). It takes 4 parameters." }, { "instruction": "What does the _get_bos_data_from_restart() method do in the Integrator class?", "input": "OpenMC Python API Integrator._get_bos_data_from_restart() method", "output": "The _get_bos_data_from_restart() method get beginning of step concentrations, reaction rates from restart. It's used for integrator operations." }, { "instruction": "How do you call the _get_bos_data_from_restart() method in the Integrator class?", "input": "OpenMC Python API Integrator._get_bos_data_from_restart() method signature", "output": "To call the _get_bos_data_from_restart() method, use: def _get_bos_data_from_restart(self: Any, source_rate: Any, bos_conc: Any). It takes 3 parameters." }, { "instruction": "How do you call the _get_start_data() method in the Integrator class?", "input": "OpenMC Python API Integrator._get_start_data() method signature", "output": "To call the _get_start_data() method, use: def _get_start_data(self: Any). It takes 1 parameters." }, { "instruction": "What does the integrate() method do in the Integrator class?", "input": "OpenMC Python API Integrator.integrate() method", "output": "The integrate() method perform the entire depletion process across all steps. It's used for integrator operations." }, { "instruction": "How do you call the integrate() method in the Integrator class?", "input": "OpenMC Python API Integrator.integrate() method signature", "output": "To call the integrate() method, use: def integrate(self: Any, final_step: bool, output: bool, path: PathLike). It takes 4 parameters." }, { "instruction": "What does the final_step parameter do in the integrate() method?", "input": "OpenMC Python API Integrator.integrate() parameter final_step", "output": "The final_step parameter indicate whether or not a transport solve should be run at the end of the last timestep. .. versionadded:: 0.12.1. It should be a bool, optional value." }, { "instruction": "What does the output parameter do in the integrate() method?", "input": "OpenMC Python API Integrator.integrate() parameter output", "output": "The output parameter indicate whether to display information about progress .. versionadded:: 0.13.1. It should be a bool, optional value." }, { "instruction": "What does the path parameter do in the integrate() method?", "input": "OpenMC Python API Integrator.integrate() parameter path", "output": "The path parameter path to file to write. defaults to 'depletion_results.h5'. .. versionadded:: 0.15.0. It should be a PathLike value." }, { "instruction": "What does the add_transfer_rate() method do in the Integrator class?", "input": "OpenMC Python API Integrator.add_transfer_rate() method", "output": "The add_transfer_rate() method add transfer rates to depletable material. It's used for integrator operations." }, { "instruction": "How do you call the add_transfer_rate() method in the Integrator class?", "input": "OpenMC Python API Integrator.add_transfer_rate() method signature", "output": "To call the add_transfer_rate() method, use: def add_transfer_rate(self: Any, material: Any, components: Any, transfer_rate: float, transfer_rate_units: str, destination_material: Any). It takes 6 parameters." }, { "instruction": "What does the material parameter do in the add_transfer_rate() method?", "input": "OpenMC Python API Integrator.add_transfer_rate() parameter material", "output": "The material parameter depletable material. It should be a openmc.Material or str or int value." }, { "instruction": "What does the components parameter do in the add_transfer_rate() method?", "input": "OpenMC Python API Integrator.add_transfer_rate() parameter components", "output": "The components parameter list of strings of elements and/or nuclides that share transfer rate. a transfer rate for a nuclide cannot be added to a material alongside a transfer rate for its element and vice versa.. It should be a list of str value." }, { "instruction": "What does the transfer_rate parameter do in the add_transfer_rate() method?", "input": "OpenMC Python API Integrator.add_transfer_rate() parameter transfer_rate", "output": "The transfer_rate parameter rate at which elements are transferred. a positive or negative values set removal of feed rates, respectively.. It should be a float value." }, { "instruction": "What does the destination_material parameter do in the add_transfer_rate() method?", "input": "OpenMC Python API Integrator.add_transfer_rate() parameter destination_material", "output": "The destination_material parameter destination material to where nuclides get fed.. It should be a openmc.Material or str or int, Optional value." }, { "instruction": "What does the transfer_rate_units parameter do in the add_transfer_rate() method?", "input": "OpenMC Python API Integrator.add_transfer_rate() parameter transfer_rate_units", "output": "The transfer_rate_units parameter units for values specified in the transfer_rate argument. 's' means seconds, 'min' means minutes, 'h' means hours, 'a' means julian years.. It should be a {'1/s', '1/min', '1/h', '1/d', '1/a'} value." }, { "instruction": "What is the SIIntegrator class in OpenMC's Python API?", "input": "OpenMC Python API SIIntegrator class", "output": "The SIIntegrator class represents abstract class for the stochastic implicit euler integrators\n\n does not provide a ``__call__`` method, but scales and resets\n the number of particles used in initial transport calculation. It provides 3 methods and 0 properties for working with siintegrator data in OpenMC." }, { "instruction": "What does the SIIntegrator class do in OpenMC's Python API?", "input": "OpenMC Python API SIIntegrator class description", "output": "The SIIntegrator class abstract class for the stochastic implicit euler integrators\n\n does not provide a ``__call__`` method, but scales and resets\n the number of particles used in initial transport calculation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the SIIntegrator class?", "input": "OpenMC Python API SIIntegrator.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, operator: TransportOperator, timesteps: Any, power: Any, power_density: Any, source_rates: Any, timestep_units: str, n_steps: int, solver: str, continue_timesteps: bool). It takes 10 parameters." }, { "instruction": "How do you call the _get_bos_data_from_operator() method in the SIIntegrator class?", "input": "OpenMC Python API SIIntegrator._get_bos_data_from_operator() method signature", "output": "To call the _get_bos_data_from_operator() method, use: def _get_bos_data_from_operator(self: Any, step_index: Any, step_power: Any, n_bos: Any). It takes 4 parameters." }, { "instruction": "What does the integrate() method do in the SIIntegrator class?", "input": "OpenMC Python API SIIntegrator.integrate() method", "output": "The integrate() method perform the entire depletion process across all steps. It's used for siintegrator operations." }, { "instruction": "How do you call the integrate() method in the SIIntegrator class?", "input": "OpenMC Python API SIIntegrator.integrate() method signature", "output": "To call the integrate() method, use: def integrate(self: Any, output: bool, path: PathLike). It takes 3 parameters." }, { "instruction": "What does the output parameter do in the integrate() method?", "input": "OpenMC Python API SIIntegrator.integrate() parameter output", "output": "The output parameter indicate whether to display information about progress. It should be a bool, optional value." }, { "instruction": "What does the path parameter do in the integrate() method?", "input": "OpenMC Python API SIIntegrator.integrate() parameter path", "output": "The path parameter path to file to write. defaults to 'depletion_results.h5'. .. versionadded:: 0.15.0. It should be a PathLike value." }, { "instruction": "What is the DepSystemSolver class in OpenMC's Python API?", "input": "OpenMC Python API DepSystemSolver class", "output": "The DepSystemSolver class represents abstract class for solving depletion equations\n\n responsible for solving\n\n .. math::\n\n \\frac{\\partial \\vec{n}}{\\partial t} = \\bar{a}\\vec{n}(t),\n\n for :math:`0< t\\leq t +\\delta t`, given :math:`\\vec{n}(0) = \\vec{n}_0`. It provides 1 methods and 0 properties for working with depsystemsolver data in OpenMC." }, { "instruction": "What does the DepSystemSolver class do in OpenMC's Python API?", "input": "OpenMC Python API DepSystemSolver class description", "output": "The DepSystemSolver class abstract class for solving depletion equations\n\n responsible for solving\n\n .. math::\n\n \\frac{\\partial \\vec{n}}{\\partial t} = \\bar{a}\\vec{n}(t),\n\n for :math:`0< t\\leq t +\\delta t`, given :math:`\\vec{n}(0) = \\vec{n}_0`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the DepSystemSolver class?", "input": "OpenMC Python API DepSystemSolver.__call__() method", "output": "The __call__() method solve the linear system of equations for depletion. It's used for depsystemsolver operations." }, { "instruction": "How do you call the __call__() method in the DepSystemSolver class?", "input": "OpenMC Python API DepSystemSolver.__call__() method signature", "output": "To call the __call__() method, use: @abstractmethod def __call__(self: Any, A: Any, n0: Any, dt: Any). It takes 4 parameters." }, { "instruction": "What does the A parameter do in the __call__() method?", "input": "OpenMC Python API DepSystemSolver.__call__() parameter A", "output": "The A parameter sparse transmutation matrix ``a[j, i]`` describing rates at which isotope ``i`` transmutes to isotope ``j``. It should be a scipy.sparse.csc_matrix value." }, { "instruction": "What does the n0 parameter do in the __call__() method?", "input": "OpenMC Python API DepSystemSolver.__call__() parameter n0", "output": "The n0 parameter initial compositions, typically given in number of atoms in some material or an atom density. It should be a numpy.ndarray value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API DepSystemSolver.__call__() parameter dt", "output": "The dt parameter time [s] of the specific interval to be solved. It should be a float value." }, { "instruction": "How do you call the _normalize_timesteps() function in OpenMC's Python API?", "input": "OpenMC Python API _normalize_timesteps() function signature", "output": "To call the _normalize_timesteps() function, use: def _normalize_timesteps(timesteps: Any, source_rates: Any, timestep_units: str, operator: Any). It takes 4 parameters." }, { "instruction": "How do you call the add_params() function in OpenMC's Python API?", "input": "OpenMC Python API add_params() function signature", "output": "To call the add_params() function, use: def add_params(cls: Any). It takes 1 parameters." }, { "instruction": "What is the AtomNumber class in OpenMC's Python API?", "input": "OpenMC Python API AtomNumber class", "output": "The AtomNumber class represents stores local material compositions (atoms of each nuclide). It provides 15 methods and 0 properties for working with atomnumber data in OpenMC." }, { "instruction": "What does the AtomNumber class do in OpenMC's Python API?", "input": "OpenMC Python API AtomNumber class description", "output": "The AtomNumber class stores local material compositions (atoms of each nuclide). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the local_mats parameter do when creating a AtomNumber?", "input": "OpenMC Python API AtomNumber constructor parameter local_mats", "output": "When creating a AtomNumber, the local_mats parameter specifies material ids. It should be a list of str value." }, { "instruction": "What does the nuclides parameter do when creating a AtomNumber?", "input": "OpenMC Python API AtomNumber constructor parameter nuclides", "output": "When creating a AtomNumber, the nuclides parameter specifies nuclides to be tracked. It should be a list of str value." }, { "instruction": "What does the volume parameter do when creating a AtomNumber?", "input": "OpenMC Python API AtomNumber constructor parameter volume", "output": "When creating a AtomNumber, the volume parameter specifies volume of each material in [cm^3]. It should be a dict value." }, { "instruction": "What does the n_nuc_burn parameter do when creating a AtomNumber?", "input": "OpenMC Python API AtomNumber constructor parameter n_nuc_burn", "output": "When creating a AtomNumber, the n_nuc_burn parameter specifies number of nuclides to be burned.. It should be a int value." }, { "instruction": "What is the index_mat attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute index_mat", "output": "The index_mat attribute of a AtomNumber contains a dictionary mapping material id as string to index.. It's a dict value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the index_nuc attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute index_nuc", "output": "The index_nuc attribute of a AtomNumber contains a dictionary mapping nuclide name to index.. It's a dict value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the volume attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute volume", "output": "The volume attribute of a AtomNumber contains volume of each material in [cm^3]. if a volume is not found, it defaults to 1 so that reading density still works correctly.. It's a numpy.ndarray value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the number attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute number", "output": "The number attribute of a AtomNumber contains array storing total atoms for each material/nuclide. It's a numpy.ndarray value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the materials attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute materials", "output": "The materials attribute of a AtomNumber contains material ids as strings. It's a list of str value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the nuclides attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute nuclides", "output": "The nuclides attribute of a AtomNumber contains all nuclide names. It's a list of str value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the burnable_nuclides attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute burnable_nuclides", "output": "The burnable_nuclides attribute of a AtomNumber contains burnable nuclides names. used for sorting the simulation.. It's a list of str value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the n_nuc_burn attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute n_nuc_burn", "output": "The n_nuc_burn attribute of a AtomNumber contains number of burnable nuclides.. It's a int value that you can access after creating a AtomNumber instance." }, { "instruction": "What is the n_nuc attribute of a AtomNumber?", "input": "OpenMC Python API AtomNumber attribute n_nuc", "output": "The n_nuc attribute of a AtomNumber contains number of nuclides.. It's a int value that you can access after creating a AtomNumber instance." }, { "instruction": "How do you call the __init__() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, local_mats: Any, nuclides: Any, volume: Any, n_nuc_burn: Any). It takes 5 parameters." }, { "instruction": "What does the _get_mat_index() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber._get_mat_index() method", "output": "The _get_mat_index() method helper method for getting material index. It's used for atomnumber operations." }, { "instruction": "How do you call the _get_mat_index() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber._get_mat_index() method signature", "output": "To call the _get_mat_index() method, use: def _get_mat_index(self: Any, mat: Any). It takes 2 parameters." }, { "instruction": "What does the __getitem__() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.__getitem__() method", "output": "The __getitem__() method retrieves total atom number from atomnumber. It's used for atomnumber operations." }, { "instruction": "How do you call the __getitem__() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, pos: Any). It takes 2 parameters." }, { "instruction": "What does the pos parameter do in the __getitem__() method?", "input": "OpenMC Python API AtomNumber.__getitem__() parameter pos", "output": "The pos parameter a two-length tuple containing a material index and a nuc index. these indexes can be strings (which get converted to integers via the dictionaries), integers used directly, or slices.. It should be a tuple value." }, { "instruction": "What does the __setitem__() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.__setitem__() method", "output": "The __setitem__() method sets total atom number into atomnumber. It's used for atomnumber operations." }, { "instruction": "How do you call the __setitem__() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.__setitem__() method signature", "output": "To call the __setitem__() method, use: def __setitem__(self: Any, pos: Any, val: Any). It takes 3 parameters." }, { "instruction": "What does the pos parameter do in the __setitem__() method?", "input": "OpenMC Python API AtomNumber.__setitem__() parameter pos", "output": "The pos parameter a two-length tuple containing a material index and a nuc index. these indexes can be strings (which get converted to integers via the dictionaries), integers used directly, or slices.. It should be a tuple value." }, { "instruction": "What does the val parameter do in the __setitem__() method?", "input": "OpenMC Python API AtomNumber.__setitem__() parameter val", "output": "The val parameter the value [atom] to set the array to.. It should be a float value." }, { "instruction": "How do you call the materials() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.materials() method signature", "output": "To call the materials() method, use: @property def materials(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_nuc() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.n_nuc() method signature", "output": "To call the n_nuc() method, use: @property def n_nuc(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the burnable_nuclides() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.burnable_nuclides() method signature", "output": "To call the burnable_nuclides() method, use: @property def burnable_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_mat_volume() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_mat_volume() method", "output": "The get_mat_volume() method return material volume. It's used for atomnumber operations." }, { "instruction": "How do you call the get_mat_volume() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_mat_volume() method signature", "output": "To call the get_mat_volume() method, use: def get_mat_volume(self: Any, mat: Any). It takes 2 parameters." }, { "instruction": "What does the mat parameter do in the get_mat_volume() method?", "input": "OpenMC Python API AtomNumber.get_mat_volume() parameter mat", "output": "The mat parameter material index.. It should be a str, int, openmc.Material, or slice value." }, { "instruction": "What does the get_atom_density() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_atom_density() method", "output": "The get_atom_density() method return atom density of given material and nuclide. It's used for atomnumber operations." }, { "instruction": "How do you call the get_atom_density() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_atom_density() method signature", "output": "To call the get_atom_density() method, use: def get_atom_density(self: Any, mat: Any, nuc: Any). It takes 3 parameters." }, { "instruction": "What does the mat parameter do in the get_atom_density() method?", "input": "OpenMC Python API AtomNumber.get_atom_density() parameter mat", "output": "The mat parameter material index.. It should be a str, int, openmc.Material or slice value." }, { "instruction": "What does the nuc parameter do in the get_atom_density() method?", "input": "OpenMC Python API AtomNumber.get_atom_density() parameter nuc", "output": "The nuc parameter nuclide index.. It should be a str, int or slice value." }, { "instruction": "What does the get_atom_densities() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_atom_densities() method", "output": "The get_atom_densities() method return atom densities for a given material. It's used for atomnumber operations." }, { "instruction": "How do you call the get_atom_densities() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_atom_densities() method signature", "output": "To call the get_atom_densities() method, use: def get_atom_densities(self: Any, mat: Any, units: Any). It takes 3 parameters." }, { "instruction": "What does the mat parameter do in the get_atom_densities() method?", "input": "OpenMC Python API AtomNumber.get_atom_densities() parameter mat", "output": "The mat parameter material index.. It should be a str, int, openmc.Material or slice value." }, { "instruction": "What does the units parameter do in the get_atom_densities() method?", "input": "OpenMC Python API AtomNumber.get_atom_densities() parameter units", "output": "The units parameter units for the returned concentration. default is ``\"atom/b-cm\"`` .. versionadded:: 0.13.1. It should be a {\"atom/b-cm\", \"atom/cm3\"}, optional value." }, { "instruction": "What does the set_atom_density() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.set_atom_density() method", "output": "The set_atom_density() method sets atom density instead of total number. It's used for atomnumber operations." }, { "instruction": "How do you call the set_atom_density() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.set_atom_density() method signature", "output": "To call the set_atom_density() method, use: def set_atom_density(self: Any, mat: Any, nuc: Any, val: Any). It takes 4 parameters." }, { "instruction": "What does the mat parameter do in the set_atom_density() method?", "input": "OpenMC Python API AtomNumber.set_atom_density() parameter mat", "output": "The mat parameter material index.. It should be a str, int, openmc.Material or slice value." }, { "instruction": "What does the nuc parameter do in the set_atom_density() method?", "input": "OpenMC Python API AtomNumber.set_atom_density() parameter nuc", "output": "The nuc parameter nuclide index.. It should be a str, int or slice value." }, { "instruction": "What does the val parameter do in the set_atom_density() method?", "input": "OpenMC Python API AtomNumber.set_atom_density() parameter val", "output": "The val parameter array of densities to set in [atom/cm^3]. It should be a numpy.ndarray value." }, { "instruction": "What does the get_mat_slice() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_mat_slice() method", "output": "The get_mat_slice() method gets atom quantity indexed by mats for all burned nuclides. It's used for atomnumber operations." }, { "instruction": "How do you call the get_mat_slice() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.get_mat_slice() method signature", "output": "To call the get_mat_slice() method, use: def get_mat_slice(self: Any, mat: Any). It takes 2 parameters." }, { "instruction": "What does the mat parameter do in the get_mat_slice() method?", "input": "OpenMC Python API AtomNumber.get_mat_slice() parameter mat", "output": "The mat parameter material index.. It should be a str, int, openmc.Material or slice value." }, { "instruction": "What does the set_mat_slice() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.set_mat_slice() method", "output": "The set_mat_slice() method sets atom quantity indexed by mats for all burned nuclides. It's used for atomnumber operations." }, { "instruction": "How do you call the set_mat_slice() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.set_mat_slice() method signature", "output": "To call the set_mat_slice() method, use: def set_mat_slice(self: Any, mat: Any, val: Any). It takes 3 parameters." }, { "instruction": "What does the mat parameter do in the set_mat_slice() method?", "input": "OpenMC Python API AtomNumber.set_mat_slice() parameter mat", "output": "The mat parameter material index.. It should be a str, int, openmc.Material, or slice value." }, { "instruction": "What does the val parameter do in the set_mat_slice() method?", "input": "OpenMC Python API AtomNumber.set_mat_slice() parameter val", "output": "The val parameter the slice to set in [atom]. It should be a numpy.ndarray value." }, { "instruction": "What does the set_density() method do in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.set_density() method", "output": "The set_density() method sets density. sets the density in the exact same order as total_density_list outputs, allowing for internal consistency. It's used for atomnumber operations." }, { "instruction": "How do you call the set_density() method in the AtomNumber class?", "input": "OpenMC Python API AtomNumber.set_density() method signature", "output": "To call the set_density() method, use: def set_density(self: Any, total_density: Any). It takes 2 parameters." }, { "instruction": "What does the total_density parameter do in the set_density() method?", "input": "OpenMC Python API AtomNumber.set_density() parameter total_density", "output": "The total_density parameter total atoms.. It should be a list of numpy.ndarray value." }, { "instruction": "What is the Chain class in OpenMC's Python API?", "input": "OpenMC Python API Chain class", "output": "The Chain class represents full representation of a depletion chain. a depletion chain can be created by using the :meth:`from_endf` method which requires a list of endf incident neutron, decay, and neutron fission product yield sublibrary files. the depletion chain used during a depletion simulation is indicated by either an argument to :class:`openmc.deplete.coupledoperator` or :class:`openmc.deplete.independentoperator`, or through openmc.config['chain_file']. It provides 20 methods and 0 properties for working with chain data in OpenMC." }, { "instruction": "What does the Chain class do in OpenMC's Python API?", "input": "OpenMC Python API Chain class description", "output": "The Chain class full representation of a depletion chain. a depletion chain can be created by using the :meth:`from_endf` method which requires a list of endf incident neutron, decay, and neutron fission product yield sublibrary files. the depletion chain used during a depletion simulation is indicated by either an argument to :class:`openmc.deplete.coupledoperator` or :class:`openmc.deplete.independentoperator`, or through openmc.config['chain_file']. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the nuclides attribute of a Chain?", "input": "OpenMC Python API Chain attribute nuclides", "output": "The nuclides attribute of a Chain contains nuclides present in the chain.. It's a list of openmc.deplete.Nuclide value that you can access after creating a Chain instance." }, { "instruction": "What is the reactions attribute of a Chain?", "input": "OpenMC Python API Chain attribute reactions", "output": "The reactions attribute of a Chain contains reactions that are tracked in the depletion chain. It's a list of str value that you can access after creating a Chain instance." }, { "instruction": "What is the nuclide_dict attribute of a Chain?", "input": "OpenMC Python API Chain attribute nuclide_dict", "output": "The nuclide_dict attribute of a Chain contains maps a nuclide name to an index in nuclides.. It's a dict of str to int value that you can access after creating a Chain instance." }, { "instruction": "What is the stable_nuclides attribute of a Chain?", "input": "OpenMC Python API Chain attribute stable_nuclides", "output": "The stable_nuclides attribute of a Chain contains list of stable nuclides available in the chain.. It's a list of openmc.deplete.Nuclide value that you can access after creating a Chain instance." }, { "instruction": "What is the unstable_nuclides attribute of a Chain?", "input": "OpenMC Python API Chain attribute unstable_nuclides", "output": "The unstable_nuclides attribute of a Chain contains list of unstable nuclides available in the chain.. It's a list of openmc.deplete.Nuclide value that you can access after creating a Chain instance." }, { "instruction": "What is the fission_yields attribute of a Chain?", "input": "OpenMC Python API Chain attribute fission_yields", "output": "The fission_yields attribute of a Chain contains list of effective fission yields for materials. each dictionary should be of the form ``{parent: {product: yield}}`` with types ``{str: {str: float}}``, where ``yield`` is the fission product yield for isotope ``parent`` producing isotope ``product``. a single entry indicates yields are constant across all materials. otherwise, an entry can be added for each material to be burned. ordering should be identical to how the operator orders reaction rates for burnable materials.. It's a None or iterable of dict value that you can access after creating a Chain instance." }, { "instruction": "How do you call the __init__() method in the Chain class?", "input": "OpenMC Python API Chain.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __contains__() method in the Chain class?", "input": "OpenMC Python API Chain.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, nuclide: Any). It takes 2 parameters." }, { "instruction": "What does the __getitem__() method do in the Chain class?", "input": "OpenMC Python API Chain.__getitem__() method", "output": "The __getitem__() method get a nuclide by name.. It's used for chain operations." }, { "instruction": "How do you call the __getitem__() method in the Chain class?", "input": "OpenMC Python API Chain.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "What does the __len__() method do in the Chain class?", "input": "OpenMC Python API Chain.__len__() method", "output": "The __len__() method number of nuclides in chain.. It's used for chain operations." }, { "instruction": "How do you call the __len__() method in the Chain class?", "input": "OpenMC Python API Chain.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "What does the stable_nuclides() method do in the Chain class?", "input": "OpenMC Python API Chain.stable_nuclides() method", "output": "The stable_nuclides() method list of stable nuclides available in the chain. It's used for chain operations." }, { "instruction": "How do you call the stable_nuclides() method in the Chain class?", "input": "OpenMC Python API Chain.stable_nuclides() method signature", "output": "To call the stable_nuclides() method, use: @property def stable_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the unstable_nuclides() method do in the Chain class?", "input": "OpenMC Python API Chain.unstable_nuclides() method", "output": "The unstable_nuclides() method list of unstable nuclides available in the chain. It's used for chain operations." }, { "instruction": "How do you call the unstable_nuclides() method in the Chain class?", "input": "OpenMC Python API Chain.unstable_nuclides() method signature", "output": "To call the unstable_nuclides() method, use: @property def unstable_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_nuclide() method do in the Chain class?", "input": "OpenMC Python API Chain.add_nuclide() method", "output": "The add_nuclide() method add a nuclide to the depletion chain. It's used for chain operations." }, { "instruction": "How do you call the add_nuclide() method in the Chain class?", "input": "OpenMC Python API Chain.add_nuclide() method signature", "output": "To call the add_nuclide() method, use: def add_nuclide(self: Any, nuclide: Nuclide). It takes 2 parameters." }, { "instruction": "What does the nuclide parameter do in the add_nuclide() method?", "input": "OpenMC Python API Chain.add_nuclide() parameter nuclide", "output": "The nuclide parameter nuclide to add. It should be a openmc.deplete.Nuclide value." }, { "instruction": "What does the from_endf() method do in the Chain class?", "input": "OpenMC Python API Chain.from_endf() method", "output": "The from_endf() method create a depletion chain from endf files. string arguments in ``decay_files``, ``fpy_files``, and ``neutron_files`` will be treated as file names to be read. alternatively, :class:`openmc.data.endf.evaluation` instances can be included in these arguments. It's used for chain operations." }, { "instruction": "How do you call the from_endf() method in the Chain class?", "input": "OpenMC Python API Chain.from_endf() method signature", "output": "To call the from_endf() method, use: @classmethod def from_endf(cls: Any, decay_files: Any, fpy_files: Any, neutron_files: Any, reactions: Any, progress: Any). It takes 6 parameters." }, { "instruction": "What does the decay_files parameter do in the from_endf() method?", "input": "OpenMC Python API Chain.from_endf() parameter decay_files", "output": "The decay_files parameter list of endf decay sub-library files. It should be a list of str or openmc.data.endf.Evaluation value." }, { "instruction": "What does the fpy_files parameter do in the from_endf() method?", "input": "OpenMC Python API Chain.from_endf() parameter fpy_files", "output": "The fpy_files parameter list of endf neutron-induced fission product yield sub-library files. It should be a list of str or openmc.data.endf.Evaluation value." }, { "instruction": "What does the neutron_files parameter do in the from_endf() method?", "input": "OpenMC Python API Chain.from_endf() parameter neutron_files", "output": "The neutron_files parameter list of endf neutron reaction sub-library files. It should be a list of str or openmc.data.endf.Evaluation value." }, { "instruction": "What does the reactions parameter do in the from_endf() method?", "input": "OpenMC Python API Chain.from_endf() parameter reactions", "output": "The reactions parameter transmutation reactions to include in the depletion chain, e.g., `[\"(n,2n)\", \"(n,gamma)\"]`. note that fission is always included if it is present. a complete listing of transmutation reactions can be found in :data:`openmc.deplete.chain.reactions`. .. versionadded:: 0.12.1. It should be a iterable of str, optional value." }, { "instruction": "What does the progress parameter do in the from_endf() method?", "input": "OpenMC Python API Chain.from_endf() parameter progress", "output": "The progress parameter flag to print status messages during processing. does not effect warning messages. It should be a bool, optional value." }, { "instruction": "What does the from_xml() method do in the Chain class?", "input": "OpenMC Python API Chain.from_xml() method", "output": "The from_xml() method reads a depletion chain xml file. It's used for chain operations." }, { "instruction": "How do you call the from_xml() method in the Chain class?", "input": "OpenMC Python API Chain.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, filename: Any, fission_q: Any). It takes 3 parameters." }, { "instruction": "What does the filename parameter do in the from_xml() method?", "input": "OpenMC Python API Chain.from_xml() parameter filename", "output": "The filename parameter the path to the depletion chain xml file.. It should be a str value." }, { "instruction": "What does the fission_q parameter do in the from_xml() method?", "input": "OpenMC Python API Chain.from_xml() parameter fission_q", "output": "The fission_q parameter dictionary of nuclides and their fission q values [ev]. if not given, values will be pulled from ``filename``. It should be a dict, optional value." }, { "instruction": "What does the export_to_xml() method do in the Chain class?", "input": "OpenMC Python API Chain.export_to_xml() method", "output": "The export_to_xml() method writes a depletion chain xml file. It's used for chain operations." }, { "instruction": "How do you call the export_to_xml() method in the Chain class?", "input": "OpenMC Python API Chain.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the export_to_xml() method?", "input": "OpenMC Python API Chain.export_to_xml() parameter filename", "output": "The filename parameter the path to the depletion chain xml file.. It should be a str value." }, { "instruction": "What does the get_default_fission_yields() method do in the Chain class?", "input": "OpenMC Python API Chain.get_default_fission_yields() method", "output": "The get_default_fission_yields() method return fission yields at lowest incident neutron energy used as the default set of fission yields for :meth:`form_matrix` if ``fission_yields`` are not provided. It's used for chain operations." }, { "instruction": "How do you call the get_default_fission_yields() method in the Chain class?", "input": "OpenMC Python API Chain.get_default_fission_yields() method signature", "output": "To call the get_default_fission_yields() method, use: def get_default_fission_yields(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_default_fission_yields() method return in the Chain class?", "input": "OpenMC Python API Chain.get_default_fission_yields() return value", "output": "The get_default_fission_yields() method returns dictionary of ``{parent: {product: f_yield}}`` where ``parent`` and ``product`` are both string names of nuclides with yield data and ``f_yield`` is a float for the fission yield.. The return type is dict." }, { "instruction": "What does the form_matrix() method do in the Chain class?", "input": "OpenMC Python API Chain.form_matrix() method", "output": "The form_matrix() method forms depletion matrix. It's used for chain operations." }, { "instruction": "How do you call the form_matrix() method in the Chain class?", "input": "OpenMC Python API Chain.form_matrix() method signature", "output": "To call the form_matrix() method, use: def form_matrix(self: Any, rates: Any, fission_yields: Any). It takes 3 parameters." }, { "instruction": "What does the rates parameter do in the form_matrix() method?", "input": "OpenMC Python API Chain.form_matrix() parameter rates", "output": "The rates parameter 2d array indexed by (nuclide, reaction). It should be a numpy.ndarray value." }, { "instruction": "What does the fission_yields parameter do in the form_matrix() method?", "input": "OpenMC Python API Chain.form_matrix() parameter fission_yields", "output": "The fission_yields parameter option to use a custom set of fission yields. expected to be of the form ``{parent : {product : f_yield}}`` with string nuclide names for ``parent`` and ``product``, and ``f_yield`` as the respective fission yield. It should be a dict, optional value." }, { "instruction": "What does the form_rr_term() method do in the Chain class?", "input": "OpenMC Python API Chain.form_rr_term() method", "output": "The form_rr_term() method function to form the transfer rate term matrices. .. versionadded:: 0.14.0. It's used for chain operations." }, { "instruction": "How do you call the form_rr_term() method in the Chain class?", "input": "OpenMC Python API Chain.form_rr_term() method signature", "output": "To call the form_rr_term() method, use: def form_rr_term(self: Any, tr_rates: Any, mats: Any). It takes 3 parameters." }, { "instruction": "What does the tr_rates parameter do in the form_rr_term() method?", "input": "OpenMC Python API Chain.form_rr_term() parameter tr_rates", "output": "The tr_rates parameter instance of openmc.deplete.transferrates. It should be a openmc.deplete.TransferRates value." }, { "instruction": "What does the mats parameter do in the form_rr_term() method?", "input": "OpenMC Python API Chain.form_rr_term() parameter mats", "output": "The mats parameter two cases are possible: 1) material id as string: nuclide transfer only. in this case the transfer rate terms will be subtracted from the respective depletion matrix 2) two-tuple of material ids as strings: nuclide transfer from one material into another. the pair is assumed to be ``(destination_material, source_material)``, where ``destination_material`` and ``source_material`` are the nuclide receiving and losing materials, respectively. the transfer rate terms get placed in the final matrix with indexing position corresponding to the id of the materials set.. It should be a string or two-tuple of strings value." }, { "instruction": "What does the get_branch_ratios() method do in the Chain class?", "input": "OpenMC Python API Chain.get_branch_ratios() method", "output": "The get_branch_ratios() method return a dictionary with reaction branching ratios. It's used for chain operations." }, { "instruction": "How do you call the get_branch_ratios() method in the Chain class?", "input": "OpenMC Python API Chain.get_branch_ratios() method signature", "output": "To call the get_branch_ratios() method, use: def get_branch_ratios(self: Any, reaction: Any). It takes 2 parameters." }, { "instruction": "What does the reaction parameter do in the get_branch_ratios() method?", "input": "OpenMC Python API Chain.get_branch_ratios() parameter reaction", "output": "The reaction parameter reaction name like ``\"(n,gamma)\"`` [default], or ``\"(n,alpha)\"``.. It should be a str, optional value." }, { "instruction": "What does the get_branch_ratios() method return in the Chain class?", "input": "OpenMC Python API Chain.get_branch_ratios() return value", "output": "The get_branch_ratios() method returns nested dict of parent nuclide keys with reaction targets and branching ratios. consider the capture, ``\"(n,gamma)\"``, reaction for am241:: {\"am241\": {\"am242\": 0.91, \"am242_m1\": 0.09}} see also -------- :meth:`set_branch_ratios`. The return type is dict." }, { "instruction": "What does the set_branch_ratios() method do in the Chain class?", "input": "OpenMC Python API Chain.set_branch_ratios() method", "output": "The set_branch_ratios() method set the branching ratios for a given reactions. It's used for chain operations." }, { "instruction": "How do you call the set_branch_ratios() method in the Chain class?", "input": "OpenMC Python API Chain.set_branch_ratios() method signature", "output": "To call the set_branch_ratios() method, use: def set_branch_ratios(self: Any, branch_ratios: Any, reaction: Any, strict: Any, tolerance: Any). It takes 5 parameters." }, { "instruction": "What does the branch_ratios parameter do in the set_branch_ratios() method?", "input": "OpenMC Python API Chain.set_branch_ratios() parameter branch_ratios", "output": "The branch_ratios parameter capture branching ratios to be inserted. first layer keys are names of parent nuclides, e.g. ``\"am241\"``. the branching ratios for these parents will be modified. corresponding values are dictionaries of ``{target: branching_ratio}``. It should be a dict of {str: {str: float}} value." }, { "instruction": "What does the reaction parameter do in the set_branch_ratios() method?", "input": "OpenMC Python API Chain.set_branch_ratios() parameter reaction", "output": "The reaction parameter reaction name like ``\"(n,gamma)\"`` [default], or ``\"(n, alpha)\"``.. It should be a str, optional value." }, { "instruction": "What does the strict parameter do in the set_branch_ratios() method?", "input": "OpenMC Python API Chain.set_branch_ratios() parameter strict", "output": "The strict parameter error control. if this evalutes to ``true``, then errors will be raised if inconsistencies are found. otherwise, warnings will be raised for most issues.. It should be a bool, optional value." }, { "instruction": "What does the tolerance parameter do in the set_branch_ratios() method?", "input": "OpenMC Python API Chain.set_branch_ratios() parameter tolerance", "output": "The tolerance parameter tolerance on the sum of all branching ratios for a single parent. will be checked with:: 1 - tol < sum_br < 1 + tol. It should be a float, optional value." }, { "instruction": "How do you call the fission_yields() method in the Chain class?", "input": "OpenMC Python API Chain.fission_yields() method signature", "output": "To call the fission_yields() method, use: @property def fission_yields(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fission_yields() method in the Chain class?", "input": "OpenMC Python API Chain.fission_yields() method signature", "output": "To call the fission_yields() method, use: @fission_yields.setter def fission_yields(self: Any, yields: Any). It takes 2 parameters." }, { "instruction": "What does the validate() method do in the Chain class?", "input": "OpenMC Python API Chain.validate() method", "output": "The validate() method search for possible inconsistencies the following checks are performed for all nuclides present: 1) for all non-fission reactions, does the sum of branching ratios equal about one? 2) for fission reactions, does the sum of fission yield fractions equal about two?. It's used for chain operations." }, { "instruction": "How do you call the validate() method in the Chain class?", "input": "OpenMC Python API Chain.validate() method signature", "output": "To call the validate() method, use: def validate(self: Any, strict: Any, quiet: Any, tolerance: Any). It takes 4 parameters." }, { "instruction": "What does the strict parameter do in the validate() method?", "input": "OpenMC Python API Chain.validate() parameter strict", "output": "The strict parameter raise exceptions at the first inconsistency if true. otherwise mark a warning. It should be a bool, optional value." }, { "instruction": "What does the quiet parameter do in the validate() method?", "input": "OpenMC Python API Chain.validate() parameter quiet", "output": "The quiet parameter flag to suppress warnings and return immediately at the first inconsistency. used only if ``strict`` does not evaluate to ``true``.. It should be a bool, optional value." }, { "instruction": "What does the tolerance parameter do in the validate() method?", "input": "OpenMC Python API Chain.validate() parameter tolerance", "output": "The tolerance parameter absolute tolerance for comparisons. used to compare computed value ``x`` to intended value ``y`` as:: valid = (y - tolerance <= x <= y + tolerance). It should be a float, optional value." }, { "instruction": "What does the validate() method return in the Chain class?", "input": "OpenMC Python API Chain.validate() return value", "output": "The validate() method returns true if no inconsistencies were found. The return type is bool." }, { "instruction": "What does the reduce() method do in the Chain class?", "input": "OpenMC Python API Chain.reduce() method", "output": "The reduce() method reduce the size of the chain by following transmutation paths as an example, consider a simple chain with the following isotopes and transmutation paths:: u235 (n,gamma) u236 (n,fission) (xe135, i135, cs135) i135 (beta decay) xe135 (beta decay) cs135 xe135 (n,gamma) xe136 calling ``chain.reduce([\"i135\"])`` will produce a depletion chain that contains only isotopes that would originate from i135: i135, xe135, cs135, and xe136. u235 and u236 will not be included, but multiple isotopes can be used to start the search. the ``level`` value controls the depth of the search. ``chain.reduce([\"u235\"], level=1)`` would return a chain with all isotopes except xe136, since it is two transmutations removed from u235 in this case. while targets will not be included in the new chain, the total destruction rate and decay rate of included isotopes will be preserved. It's used for chain operations." }, { "instruction": "How do you call the reduce() method in the Chain class?", "input": "OpenMC Python API Chain.reduce() method signature", "output": "To call the reduce() method, use: def reduce(self: Any, initial_isotopes: Any, level: Any). It takes 3 parameters." }, { "instruction": "What does the initial_isotopes parameter do in the reduce() method?", "input": "OpenMC Python API Chain.reduce() parameter initial_isotopes", "output": "The initial_isotopes parameter start the search based on the contents of these isotopes. It should be a iterable of str value." }, { "instruction": "What does the level parameter do in the reduce() method?", "input": "OpenMC Python API Chain.reduce() parameter level", "output": "The level parameter depth of transmuation path to follow. must be greater than or equal to zero. a value of zero returns a chain with ``initial_isotopes``. the default value of none implies that all isotopes that appear in the transmutation paths of the initial isotopes and their progeny should be explored. It should be a int, optional value." }, { "instruction": "What does the _follow() method do in the Chain class?", "input": "OpenMC Python API Chain._follow() method", "output": "The _follow() method return all isotopes present up to depth level. It's used for chain operations." }, { "instruction": "How do you call the _follow() method in the Chain class?", "input": "OpenMC Python API Chain._follow() method signature", "output": "To call the _follow() method, use: def _follow(self: Any, isotopes: Any, level: Any). It takes 3 parameters." }, { "instruction": "What does the replace_missing() function do in OpenMC's Python API?", "input": "OpenMC Python API replace_missing() function", "output": "The replace_missing() function replace missing product with suitable decay daughter. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the replace_missing() function in OpenMC's Python API?", "input": "OpenMC Python API replace_missing() function purpose", "output": "The replace_missing() function replace missing product with suitable decay daughter. It's part of OpenMC's Python API." }, { "instruction": "How do you call the replace_missing() function in OpenMC's Python API?", "input": "OpenMC Python API replace_missing() function signature", "output": "To call the replace_missing() function, use: def replace_missing(product: Any, decay_data: Any). It takes 2 parameters." }, { "instruction": "What does the product parameter do in the replace_missing() function?", "input": "OpenMC Python API replace_missing() parameter product", "output": "The product parameter name of product in gnds format, e.g. 'y86_m1'.. It should be a str value." }, { "instruction": "What does the decay_data parameter do in the replace_missing() function?", "input": "OpenMC Python API replace_missing() parameter decay_data", "output": "The decay_data parameter dictionary of decay data. It should be a dict value." }, { "instruction": "What does the replace_missing() function return in OpenMC's Python API?", "input": "OpenMC Python API replace_missing() return value", "output": "The replace_missing() function returns replacement for missing product in gnds format.. The return type is str." }, { "instruction": "What does the replace_missing_fpy() function do in OpenMC's Python API?", "input": "OpenMC Python API replace_missing_fpy() function", "output": "The replace_missing_fpy() function replace missing fission product yields. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the replace_missing_fpy() function in OpenMC's Python API?", "input": "OpenMC Python API replace_missing_fpy() function purpose", "output": "The replace_missing_fpy() function replace missing fission product yields. It's part of OpenMC's Python API." }, { "instruction": "How do you call the replace_missing_fpy() function in OpenMC's Python API?", "input": "OpenMC Python API replace_missing_fpy() function signature", "output": "To call the replace_missing_fpy() function, use: def replace_missing_fpy(actinide: Any, fpy_data: Any, decay_data: Any). It takes 3 parameters." }, { "instruction": "What does the actinide parameter do in the replace_missing_fpy() function?", "input": "OpenMC Python API replace_missing_fpy() parameter actinide", "output": "The actinide parameter name of actinide missing fpy data. It should be a str value." }, { "instruction": "What does the fpy_data parameter do in the replace_missing_fpy() function?", "input": "OpenMC Python API replace_missing_fpy() parameter fpy_data", "output": "The fpy_data parameter dictionary of fpy data. It should be a dict value." }, { "instruction": "What does the decay_data parameter do in the replace_missing_fpy() function?", "input": "OpenMC Python API replace_missing_fpy() parameter decay_data", "output": "The decay_data parameter dictionary of decay data. It should be a dict value." }, { "instruction": "What is the CoupledOperator class in OpenMC's Python API?", "input": "OpenMC Python API CoupledOperator class", "output": "The CoupledOperator class represents transport-coupled transport operator. instances of this class can be used to perform transport-coupled depletion using openmc's transport solver. normally, a user needn't call methods of this class directly. instead, an instance of this class is passed to an integrator class, such as :class:`openmc.deplete.cecmintegrator`. .. versionchanged:: 0.13.0 the geometry and settings parameters have been replaced with a model parameter that takes a :class:`~openmc.model.model` object .. versionchanged:: 0.13.1 name changed from ``operator`` to ``coupledoperator``. It provides 15 methods and 0 properties for working with coupledoperator data in OpenMC." }, { "instruction": "What does the CoupledOperator class do in OpenMC's Python API?", "input": "OpenMC Python API CoupledOperator class description", "output": "The CoupledOperator class transport-coupled transport operator. instances of this class can be used to perform transport-coupled depletion using openmc's transport solver. normally, a user needn't call methods of this class directly. instead, an instance of this class is passed to an integrator class, such as :class:`openmc.deplete.cecmintegrator`. .. versionchanged:: 0.13.0 the geometry and settings parameters have been replaced with a model parameter that takes a :class:`~openmc.model.model` object .. versionchanged:: 0.13.1 name changed from ``operator`` to ``coupledoperator``. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the model parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter model", "output": "When creating a CoupledOperator, the model parameter specifies openmc model object. It should be a openmc.model.Model value." }, { "instruction": "What does the chain_file parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter chain_file", "output": "When creating a CoupledOperator, the chain_file parameter specifies path to the depletion chain xml file. defaults to ``openmc.config['chain_file']``.. It should be a str, optional value." }, { "instruction": "What does the prev_results parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter prev_results", "output": "When creating a CoupledOperator, the prev_results parameter specifies results from a previous depletion calculation. if this argument is specified, the depletion calculation will start from the latest state in the previous results.. It should be a Results, optional value." }, { "instruction": "What does the diff_burnable_mats parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter diff_burnable_mats", "output": "When creating a CoupledOperator, the diff_burnable_mats parameter specifies whether to differentiate burnable materials with multiple instances. volumes are divided equally from the original material volume.. It should be a bool, optional value." }, { "instruction": "What does the normalization_mode parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter normalization_mode", "output": "When creating a CoupledOperator, the normalization_mode parameter specifies indicate how tally results should be normalized. ``\"energy-deposition\"`` computes the total energy deposited in the system and uses the ratio of the power to the energy produced as a normalization factor. ``\"fission-q\"`` uses the fission q values from the depletion chain to compute the total energy deposited. ``\"source-rate\"`` normalizes tallies based on the source rate (for fixed source calculations).. It should be a {\"energy-deposition\", \"fission-q\", \"source-rate\"} value." }, { "instruction": "What does the fission_q parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter fission_q", "output": "When creating a CoupledOperator, the fission_q parameter specifies dictionary of nuclides and their fission q values [ev]. if not given, values will be pulled from the ``chain_file``. only applicable if ``\"normalization_mode\" == \"fission-q\"``. It should be a dict, optional value." }, { "instruction": "What does the fission_yield_mode parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter fission_yield_mode", "output": "When creating a CoupledOperator, the fission_yield_mode parameter specifies key indicating what fission product yield scheme to use. the key determines what fission energy helper is used: * \"constant\": :class:`~openmc.deplete.helpers.constantfissionyieldhelper` * \"cutoff\": :class:`~openmc.deplete.helpers.fissionyieldcutoffhelper` * \"average\": :class:`~openmc.deplete.helpers.averagedfissionyieldhelper` the documentation on these classes describe their methodology and differences. default: ``\"constant\"``. It should be a {\"constant\", \"cutoff\", \"average\"} value." }, { "instruction": "What does the fission_yield_opts parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter fission_yield_opts", "output": "When creating a CoupledOperator, the fission_yield_opts parameter specifies optional arguments to pass to the helper determined by ``fission_yield_mode``. will be passed directly on to the helper. passing a value of none will use the defaults for the associated helper.. It should be a dict of str to option, optional value." }, { "instruction": "What does the reaction_rate_mode parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter reaction_rate_mode", "output": "When creating a CoupledOperator, the reaction_rate_mode parameter specifies indicate how one-group reaction rates should be calculated. the \"direct\" method tallies transmutation reaction rates directly. the \"flux\" method tallies a multigroup flux spectrum and then collapses one-group reaction rates after a transport solve (with an option to tally some reaction rates directly). .. versionadded:: 0.12.1. It should be a {\"direct\", \"flux\"}, optional value." }, { "instruction": "What does the reaction_rate_opts parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter reaction_rate_opts", "output": "When creating a CoupledOperator, the reaction_rate_opts parameter specifies keyword arguments that are passed to the reaction rate helper class. when ``reaction_rate_mode`` is set to \"flux\", energy group boundaries can be set using the \"energies\" key. see the :class:`~openmc.deplete.helpers.fluxcollapsehelper` class for all options. .. versionadded:: 0.12.1. It should be a dict, optional value." }, { "instruction": "What does the reduce_chain_level parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter reduce_chain_level", "output": "When creating a CoupledOperator, the reduce_chain_level parameter specifies depth of the search when reducing the depletion chain. the default value of ``none`` implies no limit on the depth. .. versionadded:: 0.12. It should be a int, optional value." }, { "instruction": "What does the diff_volume_method parameter do when creating a CoupledOperator?", "input": "OpenMC Python API CoupledOperator constructor parameter diff_volume_method", "output": "When creating a CoupledOperator, the diff_volume_method parameter specifies specifies how the volumes of the new materials should be found. default is to 'divide equally' which divides the original material volume equally between the new materials, 'match cell' sets the volume of the material to volume of the cell they fill. .. versionadded:: 0.14.0. It should be a str value." }, { "instruction": "What is the model attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute model", "output": "The model attribute of a CoupledOperator contains openmc model object. It's a openmc.model.Model value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the output_dir attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute output_dir", "output": "The output_dir attribute of a CoupledOperator contains path to output directory to save results.. It's a pathlib.Path value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the round_number attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute round_number", "output": "The round_number attribute of a CoupledOperator contains whether or not to round output to openmc to 8 digits. useful in testing, as openmc is incredibly sensitive to exact values.. It's a bool value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the number attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute number", "output": "The number attribute of a CoupledOperator contains total number of atoms in simulation.. It's a openmc.deplete.AtomNumber value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the nuclides_with_data attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute nuclides_with_data", "output": "The nuclides_with_data attribute of a CoupledOperator contains a set listing all unique nuclides available from cross_sections.xml.. It's a set of str value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the chain attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute chain", "output": "The chain attribute of a CoupledOperator contains the depletion chain information necessary to form matrices and tallies.. It's a openmc.deplete.Chain value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the reaction_rates attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute reaction_rates", "output": "The reaction_rates attribute of a CoupledOperator contains reaction rates from the last operator step.. It's a openmc.deplete.ReactionRates value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the burnable_mats attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute burnable_mats", "output": "The burnable_mats attribute of a CoupledOperator contains all burnable material ids. It's a list of str value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the heavy_metal attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute heavy_metal", "output": "The heavy_metal attribute of a CoupledOperator contains initial heavy metal inventory [g]. It's a float value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the local_mats attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute local_mats", "output": "The local_mats attribute of a CoupledOperator contains all burnable material ids being managed by a single process. It's a list of str value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the prev_res attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute prev_res", "output": "The prev_res attribute of a CoupledOperator contains results from a previous depletion calculation. ``none`` if no results are to be used.. It's a Results or None value that you can access after creating a CoupledOperator instance." }, { "instruction": "What is the cleanup_when_done attribute of a CoupledOperator?", "input": "OpenMC Python API CoupledOperator attribute cleanup_when_done", "output": "The cleanup_when_done attribute of a CoupledOperator contains whether to finalize and clear the shared library memory when the depletion operation is complete. defaults to clearing the library.. It's a bool value that you can access after creating a CoupledOperator instance." }, { "instruction": "How do you call the __init__() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, model: Any, chain_file: Any, prev_results: Any, diff_burnable_mats: Any, diff_volume_method: Any, normalization_mode: Any, fission_q: Any, fission_yield_mode: Any, fission_yield_opts: Any, reaction_rate_mode: Any, reaction_rate_opts: Any, reduce_chain_level: Any). It takes 13 parameters." }, { "instruction": "What does the _differentiate_burnable_mats() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._differentiate_burnable_mats() method", "output": "The _differentiate_burnable_mats() method assign distribmats for each burnable material. It's used for coupledoperator operations." }, { "instruction": "How do you call the _differentiate_burnable_mats() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._differentiate_burnable_mats() method signature", "output": "To call the _differentiate_burnable_mats() method, use: def _differentiate_burnable_mats(self: Any). It takes 1 parameters." }, { "instruction": "What does the _load_previous_results() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._load_previous_results() method", "output": "The _load_previous_results() method load results from a previous depletion simulation. It's used for coupledoperator operations." }, { "instruction": "How do you call the _load_previous_results() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._load_previous_results() method signature", "output": "To call the _load_previous_results() method, use: def _load_previous_results(self: Any). It takes 1 parameters." }, { "instruction": "What does the _get_nuclides_with_data() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._get_nuclides_with_data() method", "output": "The _get_nuclides_with_data() method loads cross_sections.xml file to find nuclides with neutron data. It's used for coupledoperator operations." }, { "instruction": "How do you call the _get_nuclides_with_data() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._get_nuclides_with_data() method signature", "output": "To call the _get_nuclides_with_data() method, use: def _get_nuclides_with_data(self: Any, cross_sections: Any). It takes 2 parameters." }, { "instruction": "What does the cross_sections parameter do in the _get_nuclides_with_data() method?", "input": "OpenMC Python API CoupledOperator._get_nuclides_with_data() parameter cross_sections", "output": "The cross_sections parameter path to cross_sections.xml file. It should be a str value." }, { "instruction": "What does the _get_nuclides_with_data() method return in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._get_nuclides_with_data() return value", "output": "The _get_nuclides_with_data() method returns set of nuclide names that have cross secton data. The return type is set of str." }, { "instruction": "What does the _get_helper_classes() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._get_helper_classes() method", "output": "The _get_helper_classes() method create the ``_rate_helper``, ``_normalization_helper``, and ``_yield_helper`` objects. It's used for coupledoperator operations." }, { "instruction": "How do you call the _get_helper_classes() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._get_helper_classes() method signature", "output": "To call the _get_helper_classes() method, use: def _get_helper_classes(self: Any, helper_kwargs: Any). It takes 2 parameters." }, { "instruction": "What does the helper_kwargs parameter do in the _get_helper_classes() method?", "input": "OpenMC Python API CoupledOperator._get_helper_classes() parameter helper_kwargs", "output": "The helper_kwargs parameter keyword arguments for helper classes. It should be a dict value." }, { "instruction": "What does the initial_condition() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.initial_condition() method", "output": "The initial_condition() method performs final setup and returns initial condition. It's used for coupledoperator operations." }, { "instruction": "How do you call the initial_condition() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.initial_condition() method signature", "output": "To call the initial_condition() method, use: def initial_condition(self: Any). It takes 1 parameters." }, { "instruction": "What does the _generate_materials_xml() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._generate_materials_xml() method", "output": "The _generate_materials_xml() method creates materials.xml from self.number.\n\n due to uncertainty with how mpi interacts with openmc api, this\n constructs the xml manually. the long term goal is to do this\n through direct memory writing.. It's used for coupledoperator operations." }, { "instruction": "How do you call the _generate_materials_xml() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._generate_materials_xml() method signature", "output": "To call the _generate_materials_xml() method, use: def _generate_materials_xml(self: Any). It takes 1 parameters." }, { "instruction": "What does the __call__() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.__call__() method", "output": "The __call__() method runs a simulation. simulation will abort under the following circumstances: 1) no energy is computed using openmc tallies. It's used for coupledoperator operations." }, { "instruction": "How do you call the __call__() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, vec: Any, source_rate: Any). It takes 3 parameters." }, { "instruction": "What does the vec parameter do in the __call__() method?", "input": "OpenMC Python API CoupledOperator.__call__() parameter vec", "output": "The vec parameter total atoms to be used in function.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API CoupledOperator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _update_materials() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._update_materials() method", "output": "The _update_materials() method updates material compositions in openmc on all processes.. It's used for coupledoperator operations." }, { "instruction": "How do you call the _update_materials() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator._update_materials() method signature", "output": "To call the _update_materials() method, use: def _update_materials(self: Any). It takes 1 parameters." }, { "instruction": "What does the write_bos_data() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.write_bos_data() method", "output": "The write_bos_data() method write a state-point file with beginning of step data. It's used for coupledoperator operations." }, { "instruction": "How do you call the write_bos_data() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.write_bos_data() method signature", "output": "To call the write_bos_data() method, use: @staticmethod def write_bos_data(step: Any). It takes 1 parameters." }, { "instruction": "What does the step parameter do in the write_bos_data() method?", "input": "OpenMC Python API CoupledOperator.write_bos_data() parameter step", "output": "The step parameter current depletion step including restarts. It should be a int value." }, { "instruction": "What does the finalize() method do in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.finalize() method", "output": "The finalize() method finalize a depletion simulation and release resources.. It's used for coupledoperator operations." }, { "instruction": "How do you call the finalize() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.finalize() method signature", "output": "To call the finalize() method, use: def finalize(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the settings() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.settings() method signature", "output": "To call the settings() method, use: @property def settings(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the settings() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.settings() method signature", "output": "To call the settings() method, use: @settings.setter def settings(self: Any, new_settings: Any). It takes 2 parameters." }, { "instruction": "How do you call the geometry() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.geometry() method signature", "output": "To call the geometry() method, use: @property def geometry(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the geometry() method in the CoupledOperator class?", "input": "OpenMC Python API CoupledOperator.geometry() method signature", "output": "To call the geometry() method, use: @geometry.setter def geometry(self: Any, new_geometry: Any). It takes 2 parameters." }, { "instruction": "What does the _find_cross_sections() function do in OpenMC's Python API?", "input": "OpenMC Python API _find_cross_sections() function", "output": "The _find_cross_sections() function determine cross sections to use for depletion. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _find_cross_sections() function in OpenMC's Python API?", "input": "OpenMC Python API _find_cross_sections() function purpose", "output": "The _find_cross_sections() function determine cross sections to use for depletion. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _find_cross_sections() function in OpenMC's Python API?", "input": "OpenMC Python API _find_cross_sections() function signature", "output": "To call the _find_cross_sections() function, use: def _find_cross_sections(model: Any). It takes 1 parameters." }, { "instruction": "What does the model parameter do in the _find_cross_sections() function?", "input": "OpenMC Python API _find_cross_sections() parameter model", "output": "The model parameter reactor model. It should be a openmc.model.Model, optional value." }, { "instruction": "How do you call the Operator() function in OpenMC's Python API?", "input": "OpenMC Python API Operator() function signature", "output": "To call the Operator() function, use: def Operator(). It takes 0 parameters." }, { "instruction": "What is the IPFCramSolver class in OpenMC's Python API?", "input": "OpenMC Python API IPFCramSolver class", "output": "The IPFCramSolver class represents cram depletion solver that uses incomplete partial factorization provides a :meth:`__call__` that utilizes an incomplete partial factorization (ipf) for the chebyshev rational approximation method (cram), as described in the following paper: m. pusa, \"`higher-order chebyshev rational approximation method and application to burnup equations `_,\" nucl. sci. eng., 182:3, 297-318. It provides 2 methods and 0 properties for working with ipfcramsolver data in OpenMC." }, { "instruction": "What does the IPFCramSolver class do in OpenMC's Python API?", "input": "OpenMC Python API IPFCramSolver class description", "output": "The IPFCramSolver class cram depletion solver that uses incomplete partial factorization provides a :meth:`__call__` that utilizes an incomplete partial factorization (ipf) for the chebyshev rational approximation method (cram), as described in the following paper: m. pusa, \"`higher-order chebyshev rational approximation method and application to burnup equations `_,\" nucl. sci. eng., 182:3, 297-318. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the alpha parameter do when creating a IPFCramSolver?", "input": "OpenMC Python API IPFCramSolver constructor parameter alpha", "output": "When creating a IPFCramSolver, the alpha parameter specifies complex residues of poles used in the factorization. must be a vector with even number of items.. It should be a numpy.ndarray value." }, { "instruction": "What does the theta parameter do when creating a IPFCramSolver?", "input": "OpenMC Python API IPFCramSolver constructor parameter theta", "output": "When creating a IPFCramSolver, the theta parameter specifies complex poles. must have an equal size as ``alpha``.. It should be a numpy.ndarray value." }, { "instruction": "What does the alpha0 parameter do when creating a IPFCramSolver?", "input": "OpenMC Python API IPFCramSolver constructor parameter alpha0", "output": "When creating a IPFCramSolver, the alpha0 parameter specifies limit of the approximation at infinity. It should be a float value." }, { "instruction": "What is the alpha attribute of a IPFCramSolver?", "input": "OpenMC Python API IPFCramSolver attribute alpha", "output": "The alpha attribute of a IPFCramSolver contains complex residues of poles :attr:`theta` in the incomplete partial factorization. denoted as :math:`\\tilde{\\alpha}`. It's a numpy.ndarray value that you can access after creating a IPFCramSolver instance." }, { "instruction": "What is the theta attribute of a IPFCramSolver?", "input": "OpenMC Python API IPFCramSolver attribute theta", "output": "The theta attribute of a IPFCramSolver contains complex poles :math:`\\theta` of the rational approximation. It's a numpy.ndarray value that you can access after creating a IPFCramSolver instance." }, { "instruction": "What is the alpha0 attribute of a IPFCramSolver?", "input": "OpenMC Python API IPFCramSolver attribute alpha0", "output": "The alpha0 attribute of a IPFCramSolver contains limit of the approximation at infinity. It's a float value that you can access after creating a IPFCramSolver instance." }, { "instruction": "How do you call the __init__() method in the IPFCramSolver class?", "input": "OpenMC Python API IPFCramSolver.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, alpha: Any, theta: Any, alpha0: Any). It takes 4 parameters." }, { "instruction": "What does the __call__() method do in the IPFCramSolver class?", "input": "OpenMC Python API IPFCramSolver.__call__() method", "output": "The __call__() method solve depletion equations using ipf cram. It's used for ipfcramsolver operations." }, { "instruction": "How do you call the __call__() method in the IPFCramSolver class?", "input": "OpenMC Python API IPFCramSolver.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, A: Any, n0: Any, dt: Any). It takes 4 parameters." }, { "instruction": "What does the A parameter do in the __call__() method?", "input": "OpenMC Python API IPFCramSolver.__call__() parameter A", "output": "The A parameter sparse transmutation matrix ``a[j, i]`` desribing rates at which isotope ``i`` transmutes to isotope ``j``. It should be a scipy.sparse.csr_matrix value." }, { "instruction": "What does the n0 parameter do in the __call__() method?", "input": "OpenMC Python API IPFCramSolver.__call__() parameter n0", "output": "The n0 parameter initial compositions, typically given in number of atoms in some material or an atom density. It should be a numpy.ndarray value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API IPFCramSolver.__call__() parameter dt", "output": "The dt parameter time [s] of the specific interval to be solved. It should be a float value." }, { "instruction": "What does the get_radionuclides() function do in OpenMC's Python API?", "input": "OpenMC Python API get_radionuclides() function", "output": "The get_radionuclides() function determine all radionuclides that can be produced during d1s. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_radionuclides() function in OpenMC's Python API?", "input": "OpenMC Python API get_radionuclides() function purpose", "output": "The get_radionuclides() function determine all radionuclides that can be produced during d1s. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_radionuclides() function in OpenMC's Python API?", "input": "OpenMC Python API get_radionuclides() function signature", "output": "To call the get_radionuclides() function, use: def get_radionuclides(model: openmc.Model, chain_file: Any). It takes 2 parameters." }, { "instruction": "What does the model parameter do in the get_radionuclides() function?", "input": "OpenMC Python API get_radionuclides() parameter model", "output": "The model parameter model that should be used for determining what nuclides are present. It should be a openmc.Model value." }, { "instruction": "What does the chain_file parameter do in the get_radionuclides() function?", "input": "OpenMC Python API get_radionuclides() parameter chain_file", "output": "The chain_file parameter which chain file to use for inspecting decay data. if none is passed, defaults to ``openmc.config['chain_file']``. It should be a str, optional value." }, { "instruction": "What does the time_correction_factors() function do in OpenMC's Python API?", "input": "OpenMC Python API time_correction_factors() function", "output": "The time_correction_factors() function calculate time correction factors for the d1s method. this function determines the time correction factor that should be applied to photon tallies as part of the d1s method. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the time_correction_factors() function in OpenMC's Python API?", "input": "OpenMC Python API time_correction_factors() function purpose", "output": "The time_correction_factors() function calculate time correction factors for the d1s method. this function determines the time correction factor that should be applied to photon tallies as part of the d1s method. It's part of OpenMC's Python API." }, { "instruction": "How do you call the time_correction_factors() function in OpenMC's Python API?", "input": "OpenMC Python API time_correction_factors() function signature", "output": "To call the time_correction_factors() function, use: def time_correction_factors(nuclides: Any, timesteps: Any, source_rates: Any, timestep_units: str). It takes 4 parameters." }, { "instruction": "What does the nuclides parameter do in the time_correction_factors() function?", "input": "OpenMC Python API time_correction_factors() parameter nuclides", "output": "The nuclides parameter the name of the nuclide to find the time correction for, e.g., 'ni65'. It should be a list of str value." }, { "instruction": "What does the timesteps parameter do in the time_correction_factors() function?", "input": "OpenMC Python API time_correction_factors() parameter timesteps", "output": "The timesteps parameter array of timesteps. note that values are not cumulative. the units are specified by the `timestep_units` argument when `timesteps` is an iterable of float. alternatively, units can be specified for each step by passing a sequence of (value, unit) tuples.. It should be a iterable of float or iterable of tuple value." }, { "instruction": "What does the source_rates parameter do in the time_correction_factors() function?", "input": "OpenMC Python API time_correction_factors() parameter source_rates", "output": "The source_rates parameter source rate in [neutron/sec] for each interval in `timesteps`. It should be a float or iterable of float value." }, { "instruction": "What does the timestep_units parameter do in the time_correction_factors() function?", "input": "OpenMC Python API time_correction_factors() parameter timestep_units", "output": "The timestep_units parameter units for values specified in the `timesteps` argument. 's' means seconds, 'min' means minutes, 'h' means hours, and 'a' means julian years.. It should be a {'s', 'min', 'h', 'd', 'a'}, optional value." }, { "instruction": "What does the apply_time_correction() function do in OpenMC's Python API?", "input": "OpenMC Python API apply_time_correction() function", "output": "The apply_time_correction() function apply time correction factors to a tally. this function applies the time correction factors at the given index to a tally that contains a :class:`~openmc.parentnuclidefilter`. when `sum_nuclides` is true, values over all parent nuclides will be summed, leaving a single value for each filter combination. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the apply_time_correction() function in OpenMC's Python API?", "input": "OpenMC Python API apply_time_correction() function purpose", "output": "The apply_time_correction() function apply time correction factors to a tally. this function applies the time correction factors at the given index to a tally that contains a :class:`~openmc.parentnuclidefilter`. when `sum_nuclides` is true, values over all parent nuclides will be summed, leaving a single value for each filter combination. It's part of OpenMC's Python API." }, { "instruction": "How do you call the apply_time_correction() function in OpenMC's Python API?", "input": "OpenMC Python API apply_time_correction() function signature", "output": "To call the apply_time_correction() function, use: def apply_time_correction(tally: openmc.Tally, time_correction_factors: Any, index: int, sum_nuclides: bool). It takes 4 parameters." }, { "instruction": "What does the tally parameter do in the apply_time_correction() function?", "input": "OpenMC Python API apply_time_correction() parameter tally", "output": "The tally parameter tally to apply the time correction factors to. It should be a openmc.Tally value." }, { "instruction": "What does the time_correction_factors parameter do in the apply_time_correction() function?", "input": "OpenMC Python API apply_time_correction() parameter time_correction_factors", "output": "The time_correction_factors parameter time correction factors as returned by :func:`time_correction_factors`. It should be a dict value." }, { "instruction": "What does the index parameter do in the apply_time_correction() function?", "input": "OpenMC Python API apply_time_correction() parameter index", "output": "The index parameter index to use for the correction factors. It should be a int, optional value." }, { "instruction": "What does the sum_nuclides parameter do in the apply_time_correction() function?", "input": "OpenMC Python API apply_time_correction() parameter sum_nuclides", "output": "The sum_nuclides parameter whether to sum over the parent nuclides. It should be a bool value." }, { "instruction": "What does the prepare_tallies() function do in OpenMC's Python API?", "input": "OpenMC Python API prepare_tallies() function", "output": "The prepare_tallies() function prepare tallies for the d1s method. this function adds a :class:`~openmc.parentnuclidefilter` to any tally that has a particle filter with a single 'photon' bin. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the prepare_tallies() function in OpenMC's Python API?", "input": "OpenMC Python API prepare_tallies() function purpose", "output": "The prepare_tallies() function prepare tallies for the d1s method. this function adds a :class:`~openmc.parentnuclidefilter` to any tally that has a particle filter with a single 'photon' bin. It's part of OpenMC's Python API." }, { "instruction": "How do you call the prepare_tallies() function in OpenMC's Python API?", "input": "OpenMC Python API prepare_tallies() function signature", "output": "To call the prepare_tallies() function, use: def prepare_tallies(model: openmc.Model, nuclides: Any, chain_file: Any). It takes 3 parameters." }, { "instruction": "What does the model parameter do in the prepare_tallies() function?", "input": "OpenMC Python API prepare_tallies() parameter model", "output": "The model parameter model to prepare tallies for. It should be a openmc.Model value." }, { "instruction": "What does the nuclides parameter do in the prepare_tallies() function?", "input": "OpenMC Python API prepare_tallies() parameter nuclides", "output": "The nuclides parameter nuclides to use for the parent nuclide filter. if none, radionuclides are determined from :func:`get_radionuclides`.. It should be a list of str, optional value." }, { "instruction": "What does the chain_file parameter do in the prepare_tallies() function?", "input": "OpenMC Python API prepare_tallies() parameter chain_file", "output": "The chain_file parameter chain file to use for inspecting decay data. if none, defaults to ``openmc.config['chain_file']``. It should be a str, optional value." }, { "instruction": "What is the TalliedFissionYieldHelper class in OpenMC's Python API?", "input": "OpenMC Python API TalliedFissionYieldHelper class", "output": "The TalliedFissionYieldHelper class represents abstract class for computing fission yields with tallies generates a basic fission rate tally in all burnable materials with :meth:`generate_tallies`, and set nuclides to be tallied with :meth:`update_tally_nuclides`. subclasses will need to implement :meth:`unpack` and :meth:`weighted_yields`. It provides 4 methods and 0 properties for working with talliedfissionyieldhelper data in OpenMC." }, { "instruction": "What does the TalliedFissionYieldHelper class do in OpenMC's Python API?", "input": "OpenMC Python API TalliedFissionYieldHelper class description", "output": "The TalliedFissionYieldHelper class abstract class for computing fission yields with tallies generates a basic fission rate tally in all burnable materials with :meth:`generate_tallies`, and set nuclides to be tallied with :meth:`update_tally_nuclides`. subclasses will need to implement :meth:`unpack` and :meth:`weighted_yields`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the chain_nuclides parameter do when creating a TalliedFissionYieldHelper?", "input": "OpenMC Python API TalliedFissionYieldHelper constructor parameter chain_nuclides", "output": "When creating a TalliedFissionYieldHelper, the chain_nuclides parameter specifies nuclides tracked in the depletion chain. not necessary that all have yield data.. It should be a iterable of openmc.deplete.Nuclide value." }, { "instruction": "What is the constant_yields attribute of a TalliedFissionYieldHelper?", "input": "OpenMC Python API TalliedFissionYieldHelper attribute constant_yields", "output": "The constant_yields attribute of a TalliedFissionYieldHelper contains fission yields for all nuclides that only have one set of fission yield data. can be accessed as ``{parent: {product: yield}}``. It's a dict of str to :class:`openmc.deplete.FissionYield` value that you can access after creating a TalliedFissionYieldHelper instance." }, { "instruction": "What is the results attribute of a TalliedFissionYieldHelper?", "input": "OpenMC Python API TalliedFissionYieldHelper attribute results", "output": "The results attribute of a TalliedFissionYieldHelper contains tally results shaped in a manner useful to this helper.. It's a None or numpy.ndarray value that you can access after creating a TalliedFissionYieldHelper instance." }, { "instruction": "How do you call the __init__() method in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, chain_nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the generate_tallies() method do in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.generate_tallies() method", "output": "The generate_tallies() method construct the fission rate tally. It's used for talliedfissionyieldhelper operations." }, { "instruction": "How do you call the generate_tallies() method in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: def generate_tallies(self: Any, materials: Any, mat_indexes: Any). It takes 3 parameters." }, { "instruction": "What does the materials parameter do in the generate_tallies() method?", "input": "OpenMC Python API TalliedFissionYieldHelper.generate_tallies() parameter materials", "output": "The materials parameter materials to be used in :class:`openmc.lib.materialfilter`. It should be a iterable of :class:`openmc.lib.Material` value." }, { "instruction": "What does the mat_indexes parameter do in the generate_tallies() method?", "input": "OpenMC Python API TalliedFissionYieldHelper.generate_tallies() parameter mat_indexes", "output": "The mat_indexes parameter indices of tallied materials that will have their fission yields computed by this helper. necessary as the :class:`openmc.deplete.coupledoperator` that uses this helper may only burn a subset of all materials when running in parallel mode.. It should be a iterable of int value." }, { "instruction": "What does the update_tally_nuclides() method do in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.update_tally_nuclides() method", "output": "The update_tally_nuclides() method tally nuclides with non-zero density and multiple yields must be run after :meth:`generate_tallies`. It's used for talliedfissionyieldhelper operations." }, { "instruction": "How do you call the update_tally_nuclides() method in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.update_tally_nuclides() method signature", "output": "To call the update_tally_nuclides() method, use: def update_tally_nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides parameter do in the update_tally_nuclides() method?", "input": "OpenMC Python API TalliedFissionYieldHelper.update_tally_nuclides() parameter nuclides", "output": "The nuclides parameter potential nuclides to be tallied, such as those with non-zero density at this stage.. It should be a iterable of str value." }, { "instruction": "What does the update_tally_nuclides() method return in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.update_tally_nuclides() return value", "output": "The update_tally_nuclides() method returns union of input nuclides and those that have multiple sets of yield data. sorted by nuclide name. The return type is list of str." }, { "instruction": "What does the unpack() method do in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.unpack() method", "output": "The unpack() method unpack tallies after a transport run.\n\n abstract because each subclass will need to arrange its\n tally data.. It's used for talliedfissionyieldhelper operations." }, { "instruction": "How do you call the unpack() method in the TalliedFissionYieldHelper class?", "input": "OpenMC Python API TalliedFissionYieldHelper.unpack() method signature", "output": "To call the unpack() method, use: @abstractmethod def unpack(self: Any). It takes 1 parameters." }, { "instruction": "What is the DirectReactionRateHelper class in OpenMC's Python API?", "input": "OpenMC Python API DirectReactionRateHelper class", "output": "The DirectReactionRateHelper class represents class for generating one-group reaction rates with direct tallies this class generates reaction rate tallies for each nuclide and transmutation reaction relevant for a depletion calculation. It provides 6 methods and 0 properties for working with directreactionratehelper data in OpenMC." }, { "instruction": "What does the DirectReactionRateHelper class do in OpenMC's Python API?", "input": "OpenMC Python API DirectReactionRateHelper class description", "output": "The DirectReactionRateHelper class class for generating one-group reaction rates with direct tallies this class generates reaction rate tallies for each nuclide and transmutation reaction relevant for a depletion calculation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the n_nucs parameter do when creating a DirectReactionRateHelper?", "input": "OpenMC Python API DirectReactionRateHelper constructor parameter n_nucs", "output": "When creating a DirectReactionRateHelper, the n_nucs parameter specifies number of burnable nuclides tracked by :class:`openmc.deplete.coupledoperator`. It should be a int value." }, { "instruction": "What does the n_react parameter do when creating a DirectReactionRateHelper?", "input": "OpenMC Python API DirectReactionRateHelper constructor parameter n_react", "output": "When creating a DirectReactionRateHelper, the n_react parameter specifies number of reactions tracked by an instance of :class:`openmc.deplete.coupledoperator`. It should be a int value." }, { "instruction": "What is the nuclides attribute of a DirectReactionRateHelper?", "input": "OpenMC Python API DirectReactionRateHelper attribute nuclides", "output": "The nuclides attribute of a DirectReactionRateHelper contains all nuclides with desired reaction rates.. It's a list of str value that you can access after creating a DirectReactionRateHelper instance." }, { "instruction": "How do you call the __init__() method in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, n_nuc: Any, n_react: Any). It takes 3 parameters." }, { "instruction": "How do you call the nuclides() method in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.nuclides() method signature", "output": "To call the nuclides() method, use: @.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the generate_tallies() method do in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.generate_tallies() method", "output": "The generate_tallies() method produce one-group reaction rate tally uses the :mod:`openmc.lib` to generate a tally of relevant reactions across all burnable materials. It's used for directreactionratehelper operations." }, { "instruction": "How do you call the generate_tallies() method in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: def generate_tallies(self: Any, materials: Any, scores: Any). It takes 3 parameters." }, { "instruction": "What does the materials parameter do in the generate_tallies() method?", "input": "OpenMC Python API DirectReactionRateHelper.generate_tallies() parameter materials", "output": "The materials parameter burnable materials in the problem. used to construct a :class:`openmc.lib.materialfilter`. It should be a iterable of :class:`openmc.lib.Material` value." }, { "instruction": "What does the scores parameter do in the generate_tallies() method?", "input": "OpenMC Python API DirectReactionRateHelper.generate_tallies() parameter scores", "output": "The scores parameter reaction identifiers, e.g. ``\"(n, fission)\"``, ``\"(n, gamma)\"``, needed for the reaction rate tally.. It should be a iterable of str value." }, { "instruction": "What does the rate_tally_means() method do in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.rate_tally_means() method", "output": "The rate_tally_means() method the mean results of the tally of every material's reaction rates for this cycle. It's used for directreactionratehelper operations." }, { "instruction": "How do you call the rate_tally_means() method in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.rate_tally_means() method signature", "output": "To call the rate_tally_means() method, use: @property def rate_tally_means(self: Any). It takes 1 parameters." }, { "instruction": "What does the reset_tally_means() method do in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.reset_tally_means() method", "output": "The reset_tally_means() method reset the cached mean rate tallies.\n .. note::\n\n this step must be performed after each transport cycle. It's used for directreactionratehelper operations." }, { "instruction": "How do you call the reset_tally_means() method in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.reset_tally_means() method signature", "output": "To call the reset_tally_means() method, use: def reset_tally_means(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_material_rates() method do in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.get_material_rates() method", "output": "The get_material_rates() method return an array of reaction rates for a material. It's used for directreactionratehelper operations." }, { "instruction": "How do you call the get_material_rates() method in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.get_material_rates() method signature", "output": "To call the get_material_rates() method, use: def get_material_rates(self: Any, mat_index: Any, nuc_index: Any, rx_index: Any). It takes 4 parameters." }, { "instruction": "What does the mat_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API DirectReactionRateHelper.get_material_rates() parameter mat_index", "output": "The mat_index parameter index for the material. It should be a int value." }, { "instruction": "What does the nuc_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API DirectReactionRateHelper.get_material_rates() parameter nuc_index", "output": "The nuc_index parameter index for each nuclide in :attr:`nuclides` in the desired reaction rate matrix. It should be a iterable of int value." }, { "instruction": "What does the rx_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API DirectReactionRateHelper.get_material_rates() parameter rx_index", "output": "The rx_index parameter index for each reaction scored in the tally. It should be a iterable of int value." }, { "instruction": "What does the get_material_rates() method return in the DirectReactionRateHelper class?", "input": "OpenMC Python API DirectReactionRateHelper.get_material_rates() return value", "output": "The get_material_rates() method returns array with shape ``(n_nuclides, n_rxns)`` with the reaction rates in this material. The return type is numpy.ndarray." }, { "instruction": "What is the FluxCollapseHelper class in OpenMC's Python API?", "input": "OpenMC Python API FluxCollapseHelper class", "output": "The FluxCollapseHelper class represents class that generates one-group reaction rates using multigroup flux this class generates a multigroup flux tally that is used afterward to calculate a one-group reaction rate by collapsing it with continuous-energy cross section data. additionally, select nuclides/reactions can be treated with a direct reaction rate tally when using a multigroup flux spectrum would not be sufficiently accurate. this is often the case for (n,gamma) and fission reactions. .. versionadded:: 0.12.1. It provides 7 methods and 0 properties for working with fluxcollapsehelper data in OpenMC." }, { "instruction": "What does the FluxCollapseHelper class do in OpenMC's Python API?", "input": "OpenMC Python API FluxCollapseHelper class description", "output": "The FluxCollapseHelper class class that generates one-group reaction rates using multigroup flux this class generates a multigroup flux tally that is used afterward to calculate a one-group reaction rate by collapsing it with continuous-energy cross section data. additionally, select nuclides/reactions can be treated with a direct reaction rate tally when using a multigroup flux spectrum would not be sufficiently accurate. this is often the case for (n,gamma) and fission reactions. .. versionadded:: 0.12.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the n_nucs parameter do when creating a FluxCollapseHelper?", "input": "OpenMC Python API FluxCollapseHelper constructor parameter n_nucs", "output": "When creating a FluxCollapseHelper, the n_nucs parameter specifies number of burnable nuclides tracked by :class:`openmc.deplete.coupledoperator`. It should be a int value." }, { "instruction": "What does the n_react parameter do when creating a FluxCollapseHelper?", "input": "OpenMC Python API FluxCollapseHelper constructor parameter n_react", "output": "When creating a FluxCollapseHelper, the n_react parameter specifies number of reactions tracked by :class:`openmc.deplete.coupledoperator`. It should be a int value." }, { "instruction": "What does the energies parameter do when creating a FluxCollapseHelper?", "input": "OpenMC Python API FluxCollapseHelper constructor parameter energies", "output": "When creating a FluxCollapseHelper, the energies parameter specifies energy group boundaries for flux spectrum in [ev]. It should be a iterable of float value." }, { "instruction": "What does the reactions parameter do when creating a FluxCollapseHelper?", "input": "OpenMC Python API FluxCollapseHelper constructor parameter reactions", "output": "When creating a FluxCollapseHelper, the reactions parameter specifies reactions for which rates should be directly tallied. It should be a iterable of str value." }, { "instruction": "What does the nuclides parameter do when creating a FluxCollapseHelper?", "input": "OpenMC Python API FluxCollapseHelper constructor parameter nuclides", "output": "When creating a FluxCollapseHelper, the nuclides parameter specifies nuclides for which some reaction rates should be directly tallied. if none, then ``reactions`` will be used for all nuclides.. It should be a iterable of str value." }, { "instruction": "What is the nuclides attribute of a FluxCollapseHelper?", "input": "OpenMC Python API FluxCollapseHelper attribute nuclides", "output": "The nuclides attribute of a FluxCollapseHelper contains all nuclides with desired reaction rates.. It's a list of str value that you can access after creating a FluxCollapseHelper instance." }, { "instruction": "How do you call the __init__() method in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, n_nucs: Any, n_reacts: Any, energies: Any, reactions: Any, nuclides: Any). It takes 6 parameters." }, { "instruction": "How do you call the nuclides() method in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.nuclides() method signature", "output": "To call the nuclides() method, use: @.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the generate_tallies() method do in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.generate_tallies() method", "output": "The generate_tallies() method produce multigroup flux spectrum tally uses the :mod:`openmc.lib` module to generate a multigroup flux tally for each burnable material. It's used for fluxcollapsehelper operations." }, { "instruction": "How do you call the generate_tallies() method in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: def generate_tallies(self: Any, materials: Any, scores: Any). It takes 3 parameters." }, { "instruction": "What does the materials parameter do in the generate_tallies() method?", "input": "OpenMC Python API FluxCollapseHelper.generate_tallies() parameter materials", "output": "The materials parameter burnable materials in the problem. used to construct a :class:`openmc.materialfilter`. It should be a iterable of :class:`openmc.Material` value." }, { "instruction": "What does the scores parameter do in the generate_tallies() method?", "input": "OpenMC Python API FluxCollapseHelper.generate_tallies() parameter scores", "output": "The scores parameter reaction identifiers, e.g. ``\"(n, fission)\"``, ``\"(n, gamma)\"``, needed for the reaction rate tally.. It should be a iterable of str value." }, { "instruction": "What does the rate_tally_means() method do in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.rate_tally_means() method", "output": "The rate_tally_means() method the mean results of the tally of every material's reaction rates for this cycle. It's used for fluxcollapsehelper operations." }, { "instruction": "How do you call the rate_tally_means() method in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.rate_tally_means() method signature", "output": "To call the rate_tally_means() method, use: @property def rate_tally_means(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the flux_tally_means() method in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.flux_tally_means() method signature", "output": "To call the flux_tally_means() method, use: @property def flux_tally_means(self: Any). It takes 1 parameters." }, { "instruction": "What does the reset_tally_means() method do in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.reset_tally_means() method", "output": "The reset_tally_means() method reset the cached mean rate and flux tallies.\n .. note::\n\n this step must be performed after each transport cycle. It's used for fluxcollapsehelper operations." }, { "instruction": "How do you call the reset_tally_means() method in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.reset_tally_means() method signature", "output": "To call the reset_tally_means() method, use: def reset_tally_means(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_material_rates() method do in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.get_material_rates() method", "output": "The get_material_rates() method return an array of reaction rates for a material. It's used for fluxcollapsehelper operations." }, { "instruction": "How do you call the get_material_rates() method in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.get_material_rates() method signature", "output": "To call the get_material_rates() method, use: def get_material_rates(self: Any, mat_index: Any, nuc_index: Any, react_index: Any). It takes 4 parameters." }, { "instruction": "What does the mat_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API FluxCollapseHelper.get_material_rates() parameter mat_index", "output": "The mat_index parameter index for material. It should be a int value." }, { "instruction": "What does the nuc_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API FluxCollapseHelper.get_material_rates() parameter nuc_index", "output": "The nuc_index parameter index for each nuclide in :attr:`nuclides` in the desired reaction rate matrix. It should be a iterable of int value." }, { "instruction": "What does the react_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API FluxCollapseHelper.get_material_rates() parameter react_index", "output": "The react_index parameter index for each reaction scored in the tally. It should be a iterable of int value." }, { "instruction": "What does the get_material_rates() method return in the FluxCollapseHelper class?", "input": "OpenMC Python API FluxCollapseHelper.get_material_rates() return value", "output": "The get_material_rates() method returns array with shape ``(n_nuclides, n_rxns)`` with the reaction rates in this material. The return type is numpy.ndarray." }, { "instruction": "What is the EnergyNormalizationHelper class in OpenMC's Python API?", "input": "OpenMC Python API EnergyNormalizationHelper class", "output": "The EnergyNormalizationHelper class represents compute energy-based normalization.. It provides 2 methods and 0 properties for working with energynormalizationhelper data in OpenMC." }, { "instruction": "What does the EnergyNormalizationHelper class do in OpenMC's Python API?", "input": "OpenMC Python API EnergyNormalizationHelper class description", "output": "The EnergyNormalizationHelper class compute energy-based normalization.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the reset() method do in the EnergyNormalizationHelper class?", "input": "OpenMC Python API EnergyNormalizationHelper.reset() method", "output": "The reset() method reset energy produced prior to unpacking tallies. It's used for energynormalizationhelper operations." }, { "instruction": "How do you call the reset() method in the EnergyNormalizationHelper class?", "input": "OpenMC Python API EnergyNormalizationHelper.reset() method signature", "output": "To call the reset() method, use: def reset(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the factor() method in the EnergyNormalizationHelper class?", "input": "OpenMC Python API EnergyNormalizationHelper.factor() method signature", "output": "To call the factor() method, use: def factor(self: Any, source_rate: Any). It takes 2 parameters." }, { "instruction": "What is the ChainFissionHelper class in OpenMC's Python API?", "input": "OpenMC Python API ChainFissionHelper class", "output": "The ChainFissionHelper class represents computes normalization using fission q values from depletion chain. It provides 3 methods and 0 properties for working with chainfissionhelper data in OpenMC." }, { "instruction": "What does the ChainFissionHelper class do in OpenMC's Python API?", "input": "OpenMC Python API ChainFissionHelper class description", "output": "The ChainFissionHelper class computes normalization using fission q values from depletion chain. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the nuclides attribute of a ChainFissionHelper?", "input": "OpenMC Python API ChainFissionHelper attribute nuclides", "output": "The nuclides attribute of a ChainFissionHelper contains all nuclides with desired reaction rates. ordered to be consistent with :class:`openmc.deplete.coupledoperator`. It's a list of str value that you can access after creating a ChainFissionHelper instance." }, { "instruction": "What is the energy attribute of a ChainFissionHelper?", "input": "OpenMC Python API ChainFissionHelper attribute energy", "output": "The energy attribute of a ChainFissionHelper contains total energy [j/s/source neutron] produced in a transport simulation. updated in the material iteration with :meth:`update`.. It's a float value that you can access after creating a ChainFissionHelper instance." }, { "instruction": "How do you call the __init__() method in the ChainFissionHelper class?", "input": "OpenMC Python API ChainFissionHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "What does the prepare() method do in the ChainFissionHelper class?", "input": "OpenMC Python API ChainFissionHelper.prepare() method", "output": "The prepare() method populate the fission q value vector from a chain. It's used for chainfissionhelper operations." }, { "instruction": "How do you call the prepare() method in the ChainFissionHelper class?", "input": "OpenMC Python API ChainFissionHelper.prepare() method signature", "output": "To call the prepare() method, use: def prepare(self: Any, chain_nucs: Any, rate_index: Any). It takes 3 parameters." }, { "instruction": "What does the chain_nucs parameter do in the prepare() method?", "input": "OpenMC Python API ChainFissionHelper.prepare() parameter chain_nucs", "output": "The chain_nucs parameter nuclides used in this depletion chain. do not need to be ordered. It should be a iterable of :class:`openmc.deplete.Nuclide` value." }, { "instruction": "What does the rate_index parameter do in the prepare() method?", "input": "OpenMC Python API ChainFissionHelper.prepare() parameter rate_index", "output": "The rate_index parameter dictionary mapping names of nuclides, e.g. ``\"u235\"``, to a corresponding index in the desired fission q vector.. It should be a dict of str to int value." }, { "instruction": "What does the update() method do in the ChainFissionHelper class?", "input": "OpenMC Python API ChainFissionHelper.update() method", "output": "The update() method update energy produced with fission rates in a material. It's used for chainfissionhelper operations." }, { "instruction": "How do you call the update() method in the ChainFissionHelper class?", "input": "OpenMC Python API ChainFissionHelper.update() method signature", "output": "To call the update() method, use: def update(self: Any, fission_rates: Any). It takes 2 parameters." }, { "instruction": "What does the fission_rates parameter do in the update() method?", "input": "OpenMC Python API ChainFissionHelper.update() parameter fission_rates", "output": "The fission_rates parameter fission reaction rate for each isotope in the specified material. should be ordered corresponding to initial ``rate_index`` used in :meth:`prepare`. It should be a numpy.ndarray value." }, { "instruction": "What is the EnergyScoreHelper class in OpenMC's Python API?", "input": "OpenMC Python API EnergyScoreHelper class", "output": "The EnergyScoreHelper class represents class responsible for obtaining system energy via a tally score. It provides 3 methods and 0 properties for working with energyscorehelper data in OpenMC." }, { "instruction": "What does the EnergyScoreHelper class do in OpenMC's Python API?", "input": "OpenMC Python API EnergyScoreHelper class description", "output": "The EnergyScoreHelper class class responsible for obtaining system energy via a tally score. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the score parameter do when creating a EnergyScoreHelper?", "input": "OpenMC Python API EnergyScoreHelper constructor parameter score", "output": "When creating a EnergyScoreHelper, the score parameter specifies valid score to use when obtaining system energy from openmc. defaults to \"heating-local\". It should be a string value." }, { "instruction": "What is the nuclides attribute of a EnergyScoreHelper?", "input": "OpenMC Python API EnergyScoreHelper attribute nuclides", "output": "The nuclides attribute of a EnergyScoreHelper contains list of nuclides with reaction rates. not needed, but provided for a consistent api across other :class:`normalizationhelper`. It's a list of str value that you can access after creating a EnergyScoreHelper instance." }, { "instruction": "What is the energy attribute of a EnergyScoreHelper?", "input": "OpenMC Python API EnergyScoreHelper attribute energy", "output": "The energy attribute of a EnergyScoreHelper contains system energy [ev] computed from the tally. will be zero for all mpi processes that are not the \"master\" process to avoid artificially increasing the tallied energy.. It's a float value that you can access after creating a EnergyScoreHelper instance." }, { "instruction": "What is the score attribute of a EnergyScoreHelper?", "input": "OpenMC Python API EnergyScoreHelper attribute score", "output": "The score attribute of a EnergyScoreHelper contains score used to obtain system energy. It's a str value that you can access after creating a EnergyScoreHelper instance." }, { "instruction": "How do you call the __init__() method in the EnergyScoreHelper class?", "input": "OpenMC Python API EnergyScoreHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, score: Any). It takes 2 parameters." }, { "instruction": "What does the prepare() method do in the EnergyScoreHelper class?", "input": "OpenMC Python API EnergyScoreHelper.prepare() method", "output": "The prepare() method create a tally for system energy production\n\n input arguments are not used, as the only information needed\n is :attr:`score`. It's used for energyscorehelper operations." }, { "instruction": "How do you call the prepare() method in the EnergyScoreHelper class?", "input": "OpenMC Python API EnergyScoreHelper.prepare() method signature", "output": "To call the prepare() method, use: def prepare(self: Any). It takes 1 parameters." }, { "instruction": "What does the reset() method do in the EnergyScoreHelper class?", "input": "OpenMC Python API EnergyScoreHelper.reset() method", "output": "The reset() method obtain system energy from tally\n\n only the master process, ``comm.rank == 0`` will\n have a non-zero :attr:`energy` taken from the tally.\n this avoids accidentally scaling the system power by\n the number of mpi processes. It's used for energyscorehelper operations." }, { "instruction": "How do you call the reset() method in the EnergyScoreHelper class?", "input": "OpenMC Python API EnergyScoreHelper.reset() method signature", "output": "To call the reset() method, use: def reset(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the prepare() method in the SourceRateHelper class?", "input": "OpenMC Python API SourceRateHelper.prepare() method signature", "output": "To call the prepare() method, use: def prepare(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the factor() method in the SourceRateHelper class?", "input": "OpenMC Python API SourceRateHelper.factor() method signature", "output": "To call the factor() method, use: def factor(self: Any, source_rate: Any). It takes 2 parameters." }, { "instruction": "What is the ConstantFissionYieldHelper class in OpenMC's Python API?", "input": "OpenMC Python API ConstantFissionYieldHelper class", "output": "The ConstantFissionYieldHelper class represents class that uses a single set of fission yields on each isotope. It provides 4 methods and 0 properties for working with constantfissionyieldhelper data in OpenMC." }, { "instruction": "What does the ConstantFissionYieldHelper class do in OpenMC's Python API?", "input": "OpenMC Python API ConstantFissionYieldHelper class description", "output": "The ConstantFissionYieldHelper class class that uses a single set of fission yields on each isotope. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the chain_nuclides parameter do when creating a ConstantFissionYieldHelper?", "input": "OpenMC Python API ConstantFissionYieldHelper constructor parameter chain_nuclides", "output": "When creating a ConstantFissionYieldHelper, the chain_nuclides parameter specifies nuclides tracked in the depletion chain. all nuclides are not required to have fission yield data.. It should be a iterable of openmc.deplete.Nuclide value." }, { "instruction": "What does the energy parameter do when creating a ConstantFissionYieldHelper?", "input": "OpenMC Python API ConstantFissionYieldHelper constructor parameter energy", "output": "When creating a ConstantFissionYieldHelper, the energy parameter specifies key in :attr:`openmc.deplete.nuclide.yield_data` corresponding to the desired set of fission yield data. typically one of ``{0.0253, 500000, 14000000}`` corresponding to 0.0253 ev, 500 kev, and 14 mev yield libraries. if the specific key is not found, will fall back to closest energy present.. It should be a float, optional value." }, { "instruction": "What does the Default parameter do when creating a ConstantFissionYieldHelper?", "input": "OpenMC Python API ConstantFissionYieldHelper constructor parameter Default", "output": "When creating a ConstantFissionYieldHelper, the Default parameter specifies . It should be a 0.0253 eV for thermal yields value." }, { "instruction": "What is the constant_yields attribute of a ConstantFissionYieldHelper?", "input": "OpenMC Python API ConstantFissionYieldHelper attribute constant_yields", "output": "The constant_yields attribute of a ConstantFissionYieldHelper contains fission yields for all nuclides that only have one set of fission yield data. dictionary of form ``{str: {str: float}}`` representing yields for ``{parent: {product: yield}}``. default return object is an empty dictionary. It's a collections.defaultdict value that you can access after creating a ConstantFissionYieldHelper instance." }, { "instruction": "What is the energy attribute of a ConstantFissionYieldHelper?", "input": "OpenMC Python API ConstantFissionYieldHelper attribute energy", "output": "The energy attribute of a ConstantFissionYieldHelper contains energy of fission yield libraries.. It's a float value that you can access after creating a ConstantFissionYieldHelper instance." }, { "instruction": "How do you call the __init__() method in the ConstantFissionYieldHelper class?", "input": "OpenMC Python API ConstantFissionYieldHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, chain_nuclides: Any, energy: Any). It takes 3 parameters." }, { "instruction": "What does the from_operator() method do in the ConstantFissionYieldHelper class?", "input": "OpenMC Python API ConstantFissionYieldHelper.from_operator() method", "output": "The from_operator() method return a new constantfissionyieldhelper using operator data all keyword arguments should be identical to their counterpart in the main ``__init__`` method. It's used for constantfissionyieldhelper operations." }, { "instruction": "How do you call the from_operator() method in the ConstantFissionYieldHelper class?", "input": "OpenMC Python API ConstantFissionYieldHelper.from_operator() method signature", "output": "To call the from_operator() method, use: @classmethod def from_operator(cls: Any, operator: Any). It takes 2 parameters." }, { "instruction": "What does the operator parameter do in the from_operator() method?", "input": "OpenMC Python API ConstantFissionYieldHelper.from_operator() parameter operator", "output": "The operator parameter operator with a depletion chain kwargs: additional keyword arguments to be used in construction. It should be a openmc.deplete.abc.TransportOperator value." }, { "instruction": "How do you call the energy() method in the ConstantFissionYieldHelper class?", "input": "OpenMC Python API ConstantFissionYieldHelper.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "What does the weighted_yields() method do in the ConstantFissionYieldHelper class?", "input": "OpenMC Python API ConstantFissionYieldHelper.weighted_yields() method", "output": "The weighted_yields() method return fission yields for all nuclides requested. It's used for constantfissionyieldhelper operations." }, { "instruction": "How do you call the weighted_yields() method in the ConstantFissionYieldHelper class?", "input": "OpenMC Python API ConstantFissionYieldHelper.weighted_yields() method signature", "output": "To call the weighted_yields() method, use: def weighted_yields(self: Any, _local_mat_index: Any). It takes 2 parameters." }, { "instruction": "What does the _local_mat_index parameter do in the weighted_yields() method?", "input": "OpenMC Python API ConstantFissionYieldHelper.weighted_yields() parameter _local_mat_index", "output": "The _local_mat_index parameter current material index. not used since all yields are constant. It should be a int, optional value." }, { "instruction": "What does the weighted_yields() method return in the ConstantFissionYieldHelper class?", "input": "OpenMC Python API ConstantFissionYieldHelper.weighted_yields() return value", "output": "The weighted_yields() method returns dictionary of ``{parent: {product: fyield}}``. The return type is collections.defaultdict." }, { "instruction": "What is the FissionYieldCutoffHelper class in OpenMC's Python API?", "input": "OpenMC Python API FissionYieldCutoffHelper class", "output": "The FissionYieldCutoffHelper class represents helper that computes fission yields based on a cutoff energy tally fission rates above and below the cutoff energy. assume that all fissions below cutoff energy have use thermal fission product yield distributions, while all fissions above use a faster set of yield distributions. uses a limit of 20 mev for tallying fission. It provides 7 methods and 0 properties for working with fissionyieldcutoffhelper data in OpenMC." }, { "instruction": "What does the FissionYieldCutoffHelper class do in OpenMC's Python API?", "input": "OpenMC Python API FissionYieldCutoffHelper class description", "output": "The FissionYieldCutoffHelper class helper that computes fission yields based on a cutoff energy tally fission rates above and below the cutoff energy. assume that all fissions below cutoff energy have use thermal fission product yield distributions, while all fissions above use a faster set of yield distributions. uses a limit of 20 mev for tallying fission. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the chain_nuclides parameter do when creating a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper constructor parameter chain_nuclides", "output": "When creating a FissionYieldCutoffHelper, the chain_nuclides parameter specifies nuclides tracked in the depletion chain. all nuclides are not required to have fission yield data.. It should be a iterable of openmc.deplete.Nuclide value." }, { "instruction": "What does the n_bmats parameter do when creating a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper constructor parameter n_bmats", "output": "When creating a FissionYieldCutoffHelper, the n_bmats parameter specifies number of burnable materials tracked in the problem. It should be a int, optional value." }, { "instruction": "What does the cutoff parameter do when creating a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper constructor parameter cutoff", "output": "When creating a FissionYieldCutoffHelper, the cutoff parameter specifies cutoff energy in [ev] below which all fissions will be use thermal yields. all other fissions will use a faster set of yields. default: 112 [ev]. It should be a float, optional value." }, { "instruction": "What does the thermal_energy parameter do when creating a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper constructor parameter thermal_energy", "output": "When creating a FissionYieldCutoffHelper, the thermal_energy parameter specifies energy of yield data corresponding to thermal yields.. It should be a float, optional value." }, { "instruction": "What does the Default parameter do when creating a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper constructor parameter Default", "output": "When creating a FissionYieldCutoffHelper, the Default parameter specifies . It should be a 0.0253 [eV] value." }, { "instruction": "What does the fast_energy parameter do when creating a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper constructor parameter fast_energy", "output": "When creating a FissionYieldCutoffHelper, the fast_energy parameter specifies energy of yield data corresponding to fast yields.. It should be a float, optional value." }, { "instruction": "What is the n_bmats attribute of a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper attribute n_bmats", "output": "The n_bmats attribute of a FissionYieldCutoffHelper contains number of burnable materials tracked in the problem. must be set prior to generating tallies. It's a int value that you can access after creating a FissionYieldCutoffHelper instance." }, { "instruction": "What is the thermal_yields attribute of a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper attribute thermal_yields", "output": "The thermal_yields attribute of a FissionYieldCutoffHelper contains dictionary of the form ``{parent: {product: yield}}`` with thermal yields. It's a dict value that you can access after creating a FissionYieldCutoffHelper instance." }, { "instruction": "What is the fast_yields attribute of a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper attribute fast_yields", "output": "The fast_yields attribute of a FissionYieldCutoffHelper contains dictionary of the form ``{parent: {product: yield}}`` with fast yields. It's a dict value that you can access after creating a FissionYieldCutoffHelper instance." }, { "instruction": "What is the constant_yields attribute of a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper attribute constant_yields", "output": "The constant_yields attribute of a FissionYieldCutoffHelper contains fission yields for all nuclides that only have one set of fission yield data. dictionary of form ``{str: {str: float}}`` representing yields for ``{parent: {product: yield}}``. default return object is an empty dictionary. It's a collections.defaultdict value that you can access after creating a FissionYieldCutoffHelper instance." }, { "instruction": "What is the results attribute of a FissionYieldCutoffHelper?", "input": "OpenMC Python API FissionYieldCutoffHelper attribute results", "output": "The results attribute of a FissionYieldCutoffHelper contains array of fission rate fractions with shape ``(n_mats, 2, n_nucs)``. ``results[:, 0]`` corresponds to the fraction of all fissions that occurred below ``cutoff``. the number of materials in the first axis corresponds to the number of materials burned by the :class:`openmc.deplete.coupledoperator`. It's a numpy.ndarray value that you can access after creating a FissionYieldCutoffHelper instance." }, { "instruction": "How do you call the __init__() method in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, chain_nuclides: Any, n_bmats: Any, cutoff: Any, thermal_energy: Any, fast_energy: Any). It takes 6 parameters." }, { "instruction": "What does the from_operator() method do in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.from_operator() method", "output": "The from_operator() method construct a helper from an operator all keyword arguments should be identical to their counterpart in the main ``__init__`` method. It's used for fissionyieldcutoffhelper operations." }, { "instruction": "How do you call the from_operator() method in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.from_operator() method signature", "output": "To call the from_operator() method, use: @classmethod def from_operator(cls: Any, operator: Any). It takes 2 parameters." }, { "instruction": "What does the operator parameter do in the from_operator() method?", "input": "OpenMC Python API FissionYieldCutoffHelper.from_operator() parameter operator", "output": "The operator parameter operator with a chain and burnable materials kwargs: additional keyword arguments to be used in construction. It should be a openmc.deplete.CoupledOperator value." }, { "instruction": "What does the generate_tallies() method do in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.generate_tallies() method", "output": "The generate_tallies() method use c api to produce a fission rate tally in burnable materials include a :class:`openmc.lib.energyfilter` to tally fission rates above and below cutoff energy. It's used for fissionyieldcutoffhelper operations." }, { "instruction": "How do you call the generate_tallies() method in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: def generate_tallies(self: Any, materials: Any, mat_indexes: Any). It takes 3 parameters." }, { "instruction": "What does the materials parameter do in the generate_tallies() method?", "input": "OpenMC Python API FissionYieldCutoffHelper.generate_tallies() parameter materials", "output": "The materials parameter materials to be used in :class:`openmc.lib.materialfilter`. It should be a iterable of :class:`openmc.lib.Material` value." }, { "instruction": "What does the mat_indexes parameter do in the generate_tallies() method?", "input": "OpenMC Python API FissionYieldCutoffHelper.generate_tallies() parameter mat_indexes", "output": "The mat_indexes parameter indices of tallied materials that will have their fission yields computed by this helper. necessary as the :class:`openmc.deplete.coupledoperator` that uses this helper may only burn a subset of all materials when running in parallel mode.. It should be a iterable of int value." }, { "instruction": "What does the unpack() method do in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.unpack() method", "output": "The unpack() method obtain fast and thermal fission fractions from tally. It's used for fissionyieldcutoffhelper operations." }, { "instruction": "How do you call the unpack() method in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.unpack() method signature", "output": "To call the unpack() method, use: def unpack(self: Any). It takes 1 parameters." }, { "instruction": "What does the weighted_yields() method do in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.weighted_yields() method", "output": "The weighted_yields() method return fission yields for a specific material for nuclides with both yield data above and below the cutoff energy, the effective yield for nuclide ``a`` will be a weighted sum of fast and thermal yields. the weights will be the fraction of ``a`` fission events in the above and below the cutoff energy. if ``a`` has fission product distribution ``f`` for fast fissions and ``t`` for thermal fissions, and 70% of ``a`` fissions are considered thermal, then the effective fission product yield distributions for ``a`` is ``0.7 * t + 0.3 * f``. It's used for fissionyieldcutoffhelper operations." }, { "instruction": "How do you call the weighted_yields() method in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.weighted_yields() method signature", "output": "To call the weighted_yields() method, use: def weighted_yields(self: Any, local_mat_index: Any). It takes 2 parameters." }, { "instruction": "What does the local_mat_index parameter do in the weighted_yields() method?", "input": "OpenMC Python API FissionYieldCutoffHelper.weighted_yields() parameter local_mat_index", "output": "The local_mat_index parameter index for specific burnable material. effective yields will be produced using ``self.results[local_mat_index]``. It should be a int value." }, { "instruction": "What does the weighted_yields() method return in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.weighted_yields() return value", "output": "The weighted_yields() method returns dictionary of ``{parent: {product: fyield}}``. The return type is collections.defaultdict." }, { "instruction": "How do you call the thermal_yields() method in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.thermal_yields() method signature", "output": "To call the thermal_yields() method, use: @property def thermal_yields(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fast_yields() method in the FissionYieldCutoffHelper class?", "input": "OpenMC Python API FissionYieldCutoffHelper.fast_yields() method signature", "output": "To call the fast_yields() method, use: @property def fast_yields(self: Any). It takes 1 parameters." }, { "instruction": "What is the AveragedFissionYieldHelper class in OpenMC's Python API?", "input": "OpenMC Python API AveragedFissionYieldHelper class", "output": "The AveragedFissionYieldHelper class represents class that computes fission yields based on average fission energy computes average energy at which fission events occurred with .. math:: \\bar{e} = \\frac{ \\int_0^\\infty e\\sigma_f(e)\\phi(e)de }{ \\int_0^\\infty\\sigma_f(e)\\phi(e)de } if the average energy for a nuclide is below the lowest energy with yield data, that set of fission yields is taken. conversely, if the average energy is above the highest energy with yield data, that set of fission yields is used. for the case where the average energy is between two sets of yields, the effective fission yield computed by linearly interpolating between yields provided at the nearest energies above and below the average. It provides 6 methods and 0 properties for working with averagedfissionyieldhelper data in OpenMC." }, { "instruction": "What does the AveragedFissionYieldHelper class do in OpenMC's Python API?", "input": "OpenMC Python API AveragedFissionYieldHelper class description", "output": "The AveragedFissionYieldHelper class class that computes fission yields based on average fission energy computes average energy at which fission events occurred with .. math:: \\bar{e} = \\frac{ \\int_0^\\infty e\\sigma_f(e)\\phi(e)de }{ \\int_0^\\infty\\sigma_f(e)\\phi(e)de } if the average energy for a nuclide is below the lowest energy with yield data, that set of fission yields is taken. conversely, if the average energy is above the highest energy with yield data, that set of fission yields is used. for the case where the average energy is between two sets of yields, the effective fission yield computed by linearly interpolating between yields provided at the nearest energies above and below the average. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the chain_nuclides parameter do when creating a AveragedFissionYieldHelper?", "input": "OpenMC Python API AveragedFissionYieldHelper constructor parameter chain_nuclides", "output": "When creating a AveragedFissionYieldHelper, the chain_nuclides parameter specifies nuclides tracked in the depletion chain. all nuclides are not required to have fission yield data.. It should be a iterable of openmc.deplete.Nuclide value." }, { "instruction": "What is the constant_yields attribute of a AveragedFissionYieldHelper?", "input": "OpenMC Python API AveragedFissionYieldHelper attribute constant_yields", "output": "The constant_yields attribute of a AveragedFissionYieldHelper contains fission yields for all nuclides that only have one set of fission yield data. dictionary of form ``{str: {str: float}}`` representing yields for ``{parent: {product: yield}}``. default return object is an empty dictionary. It's a collections.defaultdict value that you can access after creating a AveragedFissionYieldHelper instance." }, { "instruction": "What is the results attribute of a AveragedFissionYieldHelper?", "input": "OpenMC Python API AveragedFissionYieldHelper attribute results", "output": "The results attribute of a AveragedFissionYieldHelper contains if tallies have been generated and unpacked, then the array will have shape ``(n_mats, n_tnucs)``, where ``n_mats`` is the number of materials where fission reactions were tallied and ``n_tnucs`` is the number of nuclides with multiple sets of fission yields. data in the array are the average energy of fission events for tallied nuclides across burnable materials.. It's a None or numpy.ndarray value that you can access after creating a AveragedFissionYieldHelper instance." }, { "instruction": "How do you call the __init__() method in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, chain_nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the generate_tallies() method do in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.generate_tallies() method", "output": "The generate_tallies() method construct tallies to determine average energy of fissions. It's used for averagedfissionyieldhelper operations." }, { "instruction": "How do you call the generate_tallies() method in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: def generate_tallies(self: Any, materials: Any, mat_indexes: Any). It takes 3 parameters." }, { "instruction": "What does the materials parameter do in the generate_tallies() method?", "input": "OpenMC Python API AveragedFissionYieldHelper.generate_tallies() parameter materials", "output": "The materials parameter materials to be used in :class:`openmc.lib.materialfilter`. It should be a iterable of :class:`openmc.lib.Material` value." }, { "instruction": "What does the mat_indexes parameter do in the generate_tallies() method?", "input": "OpenMC Python API AveragedFissionYieldHelper.generate_tallies() parameter mat_indexes", "output": "The mat_indexes parameter indices of tallied materials that will have their fission yields computed by this helper. necessary as the :class:`openmc.deplete.coupledoperator` that uses this helper may only burn a subset of all materials when running in parallel mode.. It should be a iterable of int value." }, { "instruction": "What does the update_tally_nuclides() method do in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.update_tally_nuclides() method", "output": "The update_tally_nuclides() method tally nuclides with non-zero density and multiple yields must be run after :meth:`generate_tallies`. It's used for averagedfissionyieldhelper operations." }, { "instruction": "How do you call the update_tally_nuclides() method in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.update_tally_nuclides() method signature", "output": "To call the update_tally_nuclides() method, use: def update_tally_nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides parameter do in the update_tally_nuclides() method?", "input": "OpenMC Python API AveragedFissionYieldHelper.update_tally_nuclides() parameter nuclides", "output": "The nuclides parameter potential nuclides to be tallied, such as those with non-zero density at this stage.. It should be a iterable of str value." }, { "instruction": "What does the update_tally_nuclides() method return in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.update_tally_nuclides() return value", "output": "The update_tally_nuclides() method returns union of input nuclides and those that have multiple sets of yield data. sorted by nuclide name. The return type is tuple of str." }, { "instruction": "What does the unpack() method do in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.unpack() method", "output": "The unpack() method unpack tallies and populate :attr:`results` with average energies. It's used for averagedfissionyieldhelper operations." }, { "instruction": "How do you call the unpack() method in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.unpack() method signature", "output": "To call the unpack() method, use: def unpack(self: Any). It takes 1 parameters." }, { "instruction": "What does the weighted_yields() method do in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.weighted_yields() method", "output": "The weighted_yields() method return fission yields for a specific material use the computed average energy of fission events to determine fission yields. if average energy is between two sets of yields, linearly interpolate between the two. otherwise take the closet set of yields. It's used for averagedfissionyieldhelper operations." }, { "instruction": "How do you call the weighted_yields() method in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.weighted_yields() method signature", "output": "To call the weighted_yields() method, use: def weighted_yields(self: Any, local_mat_index: Any). It takes 2 parameters." }, { "instruction": "What does the local_mat_index parameter do in the weighted_yields() method?", "input": "OpenMC Python API AveragedFissionYieldHelper.weighted_yields() parameter local_mat_index", "output": "The local_mat_index parameter index for specific burnable material. effective yields will be produced using ``self.results[local_mat_index]``. It should be a int value." }, { "instruction": "What does the weighted_yields() method return in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.weighted_yields() return value", "output": "The weighted_yields() method returns dictionary of ``{parent: {product: fyield}}``. default return value is an empty dictionary. The return type is collections.defaultdict." }, { "instruction": "What does the from_operator() method do in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.from_operator() method", "output": "The from_operator() method return a new helper with data from an operator all keyword arguments should be identical to their counterpart in the main ``__init__`` method. It's used for averagedfissionyieldhelper operations." }, { "instruction": "How do you call the from_operator() method in the AveragedFissionYieldHelper class?", "input": "OpenMC Python API AveragedFissionYieldHelper.from_operator() method signature", "output": "To call the from_operator() method, use: @classmethod def from_operator(cls: Any, operator: Any). It takes 2 parameters." }, { "instruction": "What does the operator parameter do in the from_operator() method?", "input": "OpenMC Python API AveragedFissionYieldHelper.from_operator() parameter operator", "output": "The operator parameter operator with a depletion chain kwargs : additional keyword arguments to be used in construction. It should be a openmc.deplete.CoupledOperator value." }, { "instruction": "What is the IndependentOperator class in OpenMC's Python API?", "input": "OpenMC Python API IndependentOperator class", "output": "The IndependentOperator class represents transport-independent transport operator based on multigroup data. instances of this class can be used to perform depletion using multigroup cross sections and multigroup fluxes. normally, a user needn't call methods of this class directly. instead, an instance of this class is passed to an integrator class, such as :class:`openmc.deplete.cecmintegrator`. note that passing an empty :class:`~openmc.deplete.microxs` instance to the ``micro_xs`` argument allows a decay-only calculation to be run. .. versionadded:: 0.13.1 .. versionchanged:: 0.14.0 arguments updated to include list of fluxes and microscopic cross sections. It provides 9 methods and 0 properties for working with independentoperator data in OpenMC." }, { "instruction": "What does the IndependentOperator class do in OpenMC's Python API?", "input": "OpenMC Python API IndependentOperator class description", "output": "The IndependentOperator class transport-independent transport operator based on multigroup data. instances of this class can be used to perform depletion using multigroup cross sections and multigroup fluxes. normally, a user needn't call methods of this class directly. instead, an instance of this class is passed to an integrator class, such as :class:`openmc.deplete.cecmintegrator`. note that passing an empty :class:`~openmc.deplete.microxs` instance to the ``micro_xs`` argument allows a decay-only calculation to be run. .. versionadded:: 0.13.1 .. versionchanged:: 0.14.0 arguments updated to include list of fluxes and microscopic cross sections. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the materials parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter materials", "output": "When creating a IndependentOperator, the materials parameter specifies materials to deplete.. It should be a iterable of openmc.Material value." }, { "instruction": "What does the fluxes parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter fluxes", "output": "When creating a IndependentOperator, the fluxes parameter specifies flux in each group in [n-cm/src] for each domain. It should be a list of numpy.ndarray value." }, { "instruction": "What does the micros parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter micros", "output": "When creating a IndependentOperator, the micros parameter specifies cross sections in [b] for each domain. if the :class:`~openmc.deplete.microxs` object is empty, a decay-only calculation will be run.. It should be a list of MicroXS value." }, { "instruction": "What does the chain_file parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter chain_file", "output": "When creating a IndependentOperator, the chain_file parameter specifies path to the depletion chain xml file. defaults to ``openmc.config['chain_file']``.. It should be a str value." }, { "instruction": "What does the keff parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter keff", "output": "When creating a IndependentOperator, the keff parameter specifies keff eigenvalue and uncertainty from transport calculation.. It should be a 2-tuple of float, optional value." }, { "instruction": "What does the prev_results parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter prev_results", "output": "When creating a IndependentOperator, the prev_results parameter specifies results from a previous depletion calculation.. It should be a Results, optional value." }, { "instruction": "What does the normalization_mode parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter normalization_mode", "output": "When creating a IndependentOperator, the normalization_mode parameter specifies indicate how reaction rates should be calculated. ``\"fission-q\"`` uses the fission q values from the depletion chain to compute the flux based on the power. ``\"source-rate\"`` uses a the source rate (assumed to be neutron flux) to calculate the reaction rates.. It should be a {\"fission-q\", \"source-rate\"} value." }, { "instruction": "What does the fission_q parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter fission_q", "output": "When creating a IndependentOperator, the fission_q parameter specifies dictionary of nuclides and their fission q values [ev]. if not given, values will be pulled from the ``chain_file``. only applicable if ``\"normalization_mode\" == \"fission-q\"``.. It should be a dict, optional value." }, { "instruction": "What does the reduce_chain_level parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter reduce_chain_level", "output": "When creating a IndependentOperator, the reduce_chain_level parameter specifies depth of the search when reducing the depletion chain. the default value of ``none`` implies no limit on the depth.. It should be a int, optional value." }, { "instruction": "What does the fission_yield_opts parameter do when creating a IndependentOperator?", "input": "OpenMC Python API IndependentOperator constructor parameter fission_yield_opts", "output": "When creating a IndependentOperator, the fission_yield_opts parameter specifies optional arguments to pass to the :class:`openmc.deplete.helpers.fissionyieldhelper` object. will be passed directly on to the helper. passing a value of none will use the defaults for the associated helper.. It should be a dict of str to option, optional value." }, { "instruction": "What is the materials attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute materials", "output": "The materials attribute of a IndependentOperator contains all materials present in the model. It's a openmc.Materials value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the cross_sections attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute cross_sections", "output": "The cross_sections attribute of a IndependentOperator contains object containing multigroup cross-sections in [b] for each material.. It's a list of MicroXS value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the output_dir attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute output_dir", "output": "The output_dir attribute of a IndependentOperator contains path to output directory to save results.. It's a pathlib.Path value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the round_number attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute round_number", "output": "The round_number attribute of a IndependentOperator contains whether or not to round output to openmc to 8 digits. useful in testing, as openmc is incredibly sensitive to exact values.. It's a bool value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the number attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute number", "output": "The number attribute of a IndependentOperator contains total number of atoms in simulation.. It's a openmc.deplete.AtomNumber value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the nuclides_with_data attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute nuclides_with_data", "output": "The nuclides_with_data attribute of a IndependentOperator contains a set listing all unique nuclides available from cross_sections.xml.. It's a set of str value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the chain attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute chain", "output": "The chain attribute of a IndependentOperator contains the depletion chain information necessary to form matrices and tallies.. It's a openmc.deplete.Chain value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the reaction_rates attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute reaction_rates", "output": "The reaction_rates attribute of a IndependentOperator contains reaction rates from the last operator step.. It's a openmc.deplete.ReactionRates value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the burnable_mats attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute burnable_mats", "output": "The burnable_mats attribute of a IndependentOperator contains all burnable material ids. It's a list of str value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the heavy_metal attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute heavy_metal", "output": "The heavy_metal attribute of a IndependentOperator contains initial heavy metal inventory [g]. It's a float value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the local_mats attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute local_mats", "output": "The local_mats attribute of a IndependentOperator contains all burnable material ids being managed by a single process. It's a list of str value that you can access after creating a IndependentOperator instance." }, { "instruction": "What is the prev_res attribute of a IndependentOperator?", "input": "OpenMC Python API IndependentOperator attribute prev_res", "output": "The prev_res attribute of a IndependentOperator contains results from a previous depletion calculation. ``none`` if no results are to be used.. It's a Results or None value that you can access after creating a IndependentOperator instance." }, { "instruction": "How do you call the __init__() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, materials: Any, fluxes: Any, micros: Any, chain_file: Any, keff: Any, normalization_mode: Any, fission_q: Any, prev_results: Any, reduce_chain_level: Any, fission_yield_opts: Any). It takes 11 parameters." }, { "instruction": "What does the from_nuclides() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator.from_nuclides() method", "output": "The from_nuclides() method alternate constructor from a dictionary of nuclide concentrations\n\n volume : float\n volume of the material being depleted in [cm^3]\n nuclides : dict of str to float\n dictionary with nuclide names as keys and nuclide concentrations as\n values.\n flux : numpy.ndarray\n flux in each group in [n-cm/src]\n micro_xs : microxs\n cross sections in [b]. if the :class:`~openmc.deplete.microxs`\n object is empty, a decay-only calculation will be run.\n chain_file : str, optional\n path to the depletion chain xml file. defaults to\n ``openmc.config['chain_file']``.\n nuc_units : {'atom/cm3', 'atom/b-cm'}, optional\n units for nuclide concentration.\n keff : 2-tuple of float, optional\n keff eigenvalue and uncertainty from transport calculation.\n default is none.\n normalization_mode : {\"fission-q\", \"source-rate\"}\n indicate how reaction rates should be calculated.\n ``\"fission-q\"`` uses the fission q values from the depletion\n chain to compute the flux based on the power. ``\"source-rate\"`` uses\n the source rate (assumed to be neutron flux) to calculate the\n reaction rates.\n fission_q : dict, optional\n dictionary of nuclides and their fission q values [ev]. if not\n given, values will be pulled from the ``chain_file``. only\n applicable if ``\"normalization_mode\" == \"fission-q\"``.\n prev_results : results, optional\n results from a previous depletion calculation.\n reduce_chain_level : int, optional\n depth of the search when reducing the depletion chain. the default\n value of ``none`` implies no limit on the depth.\n fission_yield_opts : dict of str to option, optional\n optional arguments to pass to the\n :class:`openmc.deplete.helpers.fissionyieldhelper` class. will be\n passed directly on to the helper. passing a value of none will use\n the defaults for the associated helper.. It's used for independentoperator operations." }, { "instruction": "How do you call the from_nuclides() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator.from_nuclides() method signature", "output": "To call the from_nuclides() method, use: @classmethod def from_nuclides(cls: Any, volume: Any, nuclides: Any, flux: Any, micro_xs: Any, chain_file: Any, nuc_units: Any, keff: Any, normalization_mode: Any, fission_q: Any, prev_results: Any, reduce_chain_level: Any, fission_yield_opts: Any). It takes 13 parameters." }, { "instruction": "What does the _consolidate_nuclides_to_material() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._consolidate_nuclides_to_material() method", "output": "The _consolidate_nuclides_to_material() method puts nuclide list into an openmc.materials object.. It's used for independentoperator operations." }, { "instruction": "How do you call the _consolidate_nuclides_to_material() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._consolidate_nuclides_to_material() method signature", "output": "To call the _consolidate_nuclides_to_material() method, use: @staticmethod def _consolidate_nuclides_to_material(nuclides: Any, nuc_units: Any, volume: Any). It takes 3 parameters." }, { "instruction": "What does the _load_previous_results() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._load_previous_results() method", "output": "The _load_previous_results() method load results from a previous depletion simulation. It's used for independentoperator operations." }, { "instruction": "How do you call the _load_previous_results() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._load_previous_results() method signature", "output": "To call the _load_previous_results() method, use: def _load_previous_results(self: Any). It takes 1 parameters." }, { "instruction": "What does the _get_nuclides_with_data() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._get_nuclides_with_data() method", "output": "The _get_nuclides_with_data() method finds nuclides with cross section data. It's used for independentoperator operations." }, { "instruction": "How do you call the _get_nuclides_with_data() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._get_nuclides_with_data() method signature", "output": "To call the _get_nuclides_with_data() method, use: def _get_nuclides_with_data(self: Any, cross_sections: Any). It takes 2 parameters." }, { "instruction": "What does the cross_sections parameter do in the _get_nuclides_with_data() method?", "input": "OpenMC Python API IndependentOperator._get_nuclides_with_data() parameter cross_sections", "output": "The cross_sections parameter list of multigroup cross-section data.. It should be a iterable of :class`~openmc.deplete.MicroXS` value." }, { "instruction": "What does the _get_nuclides_with_data() method return in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._get_nuclides_with_data() return value", "output": "The _get_nuclides_with_data() method returns set of nuclide names that have cross secton data. The return type is set of str." }, { "instruction": "What does the _get_helper_classes() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._get_helper_classes() method", "output": "The _get_helper_classes() method get helper classes for calculating reaction rates and fission yields. It's used for independentoperator operations." }, { "instruction": "How do you call the _get_helper_classes() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._get_helper_classes() method signature", "output": "To call the _get_helper_classes() method, use: def _get_helper_classes(self: Any, helper_kwargs: Any). It takes 2 parameters." }, { "instruction": "What does the helper_kwargs parameter do in the _get_helper_classes() method?", "input": "OpenMC Python API IndependentOperator._get_helper_classes() parameter helper_kwargs", "output": "The helper_kwargs parameter keyword arguments for helper classes. It should be a dict value." }, { "instruction": "What does the initial_condition() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator.initial_condition() method", "output": "The initial_condition() method performs final setup and returns initial condition. It's used for independentoperator operations." }, { "instruction": "How do you call the initial_condition() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator.initial_condition() method signature", "output": "To call the initial_condition() method, use: def initial_condition(self: Any). It takes 1 parameters." }, { "instruction": "What does the __call__() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator.__call__() method", "output": "The __call__() method obtain the reaction rates. It's used for independentoperator operations." }, { "instruction": "How do you call the __call__() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, vec: Any, source_rate: Any). It takes 3 parameters." }, { "instruction": "What does the vec parameter do in the __call__() method?", "input": "OpenMC Python API IndependentOperator.__call__() parameter vec", "output": "The vec parameter total atoms to be used in function.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API IndependentOperator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or flux in [neutron/cm^2-s]. It should be a float value." }, { "instruction": "What does the _update_materials() method do in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._update_materials() method", "output": "The _update_materials() method updates material compositions in openmc on all processes.. It's used for independentoperator operations." }, { "instruction": "How do you call the _update_materials() method in the IndependentOperator class?", "input": "OpenMC Python API IndependentOperator._update_materials() method signature", "output": "To call the _update_materials() method, use: def _update_materials(self: Any). It takes 1 parameters." }, { "instruction": "What is the _IndependentRateHelper class in OpenMC's Python API?", "input": "OpenMC Python API _IndependentRateHelper class", "output": "The _IndependentRateHelper class represents class for generating reaction rates with multigroup fluxes and multigroup cross sections. this class does not generate tallies and instead stores cross sections for each nuclide and transmutation reaction relevant for a depletion calculation. the reaction rate is calculated by multiplying the flux by the cross sections. It provides 4 methods and 0 properties for working with _independentratehelper data in OpenMC." }, { "instruction": "What does the _IndependentRateHelper class do in OpenMC's Python API?", "input": "OpenMC Python API _IndependentRateHelper class description", "output": "The _IndependentRateHelper class class for generating reaction rates with multigroup fluxes and multigroup cross sections. this class does not generate tallies and instead stores cross sections for each nuclide and transmutation reaction relevant for a depletion calculation. the reaction rate is calculated by multiplying the flux by the cross sections. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the op parameter do when creating a _IndependentRateHelper?", "input": "OpenMC Python API _IndependentRateHelper constructor parameter op", "output": "When creating a _IndependentRateHelper, the op parameter specifies reference to the object encapsulate _independentratehelper. we pass this so we don't have to duplicate the :attr:`independentoperator.number` object.. It should be a openmc.deplete.IndependentOperator value." }, { "instruction": "What is the nuc_ind_map attribute of a _IndependentRateHelper?", "input": "OpenMC Python API _IndependentRateHelper attribute nuc_ind_map", "output": "The nuc_ind_map attribute of a _IndependentRateHelper contains dictionary mapping the nuclide index to nuclide name. It's a dict of int to str value that you can access after creating a _IndependentRateHelper instance." }, { "instruction": "What is the rx_ind_map attribute of a _IndependentRateHelper?", "input": "OpenMC Python API _IndependentRateHelper attribute rx_ind_map", "output": "The rx_ind_map attribute of a _IndependentRateHelper contains dictionary mapping reaction index to reaction name. It's a dict of int to str value that you can access after creating a _IndependentRateHelper instance." }, { "instruction": "How do you call the __init__() method in the _IndependentRateHelper class?", "input": "OpenMC Python API _IndependentRateHelper.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, op: IndependentOperator). It takes 2 parameters." }, { "instruction": "What does the generate_tallies() method do in the _IndependentRateHelper class?", "input": "OpenMC Python API _IndependentRateHelper.generate_tallies() method", "output": "The generate_tallies() method unused in this case. It's used for _independentratehelper operations." }, { "instruction": "How do you call the generate_tallies() method in the _IndependentRateHelper class?", "input": "OpenMC Python API _IndependentRateHelper.generate_tallies() method signature", "output": "To call the generate_tallies() method, use: def generate_tallies(self: Any, materials: Any, scores: Any). It takes 3 parameters." }, { "instruction": "What does the reset_tally_means() method do in the _IndependentRateHelper class?", "input": "OpenMC Python API _IndependentRateHelper.reset_tally_means() method", "output": "The reset_tally_means() method unused in this case. It's used for _independentratehelper operations." }, { "instruction": "How do you call the reset_tally_means() method in the _IndependentRateHelper class?", "input": "OpenMC Python API _IndependentRateHelper.reset_tally_means() method signature", "output": "To call the reset_tally_means() method, use: def reset_tally_means(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_material_rates() method do in the _IndependentRateHelper class?", "input": "OpenMC Python API _IndependentRateHelper.get_material_rates() method", "output": "The get_material_rates() method return 2d array of [nuclide, reaction] reaction rates. It's used for _independentratehelper operations." }, { "instruction": "How do you call the get_material_rates() method in the _IndependentRateHelper class?", "input": "OpenMC Python API _IndependentRateHelper.get_material_rates() method signature", "output": "To call the get_material_rates() method, use: def get_material_rates(self: Any, mat_index: Any, nuc_index: Any, react_index: Any). It takes 4 parameters." }, { "instruction": "What does the mat_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API _IndependentRateHelper.get_material_rates() parameter mat_index", "output": "The mat_index parameter index for the material. It should be a int value." }, { "instruction": "What does the nuc_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API _IndependentRateHelper.get_material_rates() parameter nuc_index", "output": "The nuc_index parameter ordering of desired nuclides. It should be a list of str value." }, { "instruction": "What does the react_index parameter do in the get_material_rates() method?", "input": "OpenMC Python API _IndependentRateHelper.get_material_rates() parameter react_index", "output": "The react_index parameter ordering of reactions. It should be a list of str value." }, { "instruction": "What is the PredictorIntegrator class in OpenMC's Python API?", "input": "OpenMC Python API PredictorIntegrator class", "output": "The PredictorIntegrator class represents deplete using a first-order predictor algorithm.\n\n implements the first-order predictor algorithm. this algorithm is\n mathematically defined as:\n\n .. math::\n \\mathbf{n}_{i+1} = \\exp\\left(h\\mathbf{a}(\\mathbf{n}_i) \\right) \\mathbf{n}_i. It provides 1 methods and 0 properties for working with predictorintegrator data in OpenMC." }, { "instruction": "What does the PredictorIntegrator class do in OpenMC's Python API?", "input": "OpenMC Python API PredictorIntegrator class description", "output": "The PredictorIntegrator class deplete using a first-order predictor algorithm.\n\n implements the first-order predictor algorithm. this algorithm is\n mathematically defined as:\n\n .. math::\n \\mathbf{n}_{i+1} = \\exp\\left(h\\mathbf{a}(\\mathbf{n}_i) \\right) \\mathbf{n}_i. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the PredictorIntegrator class?", "input": "OpenMC Python API PredictorIntegrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for predictorintegrator operations." }, { "instruction": "How do you call the __call__() method in the PredictorIntegrator class?", "input": "OpenMC Python API PredictorIntegrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n: Any, rates: Any, dt: Any, source_rate: Any, _i: Any). It takes 6 parameters." }, { "instruction": "What does the n parameter do in the __call__() method?", "input": "OpenMC Python API PredictorIntegrator.__call__() parameter n", "output": "The n parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the rates parameter do in the __call__() method?", "input": "OpenMC Python API PredictorIntegrator.__call__() parameter rates", "output": "The rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API PredictorIntegrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API PredictorIntegrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _i parameter do in the __call__() method?", "input": "OpenMC Python API PredictorIntegrator.__call__() parameter _i", "output": "The _i parameter iteration index. not used. It should be a int or None value." }, { "instruction": "What does the __call__() method return in the PredictorIntegrator class?", "input": "OpenMC Python API PredictorIntegrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the PredictorIntegrator class?", "input": "OpenMC Python API PredictorIntegrator.__call__() return value", "output": "The __call__() method returns concentrations at end of interval. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the PredictorIntegrator class?", "input": "OpenMC Python API PredictorIntegrator.__call__() return value", "output": "The __call__() method returns kept for consistency with api. no intermediate calls to operator with predictor. The return type is empty list." }, { "instruction": "What is the CECMIntegrator class in OpenMC's Python API?", "input": "OpenMC Python API CECMIntegrator class", "output": "The CECMIntegrator class represents deplete using the ce/cm algorithm.\n\n implements the second order `ce/cm predictor-corrector algorithm\n `_.\n\n \"ce/cm\" stands for constant extrapolation on predictor and constant\n midpoint on corrector. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{n}_{i+1/2} &= \\exp \\left (\\frac{h}{2}\\mathbf{a}(\\mathbf{n}_i)\n \\right) \\mathbf{n}_i \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left(h \\mathbf{a}(\\mathbf{n}_{i+1/2}) \\right)\n \\mathbf{n}_i.\n \\end{aligned}. It provides 1 methods and 0 properties for working with cecmintegrator data in OpenMC." }, { "instruction": "What does the CECMIntegrator class do in OpenMC's Python API?", "input": "OpenMC Python API CECMIntegrator class description", "output": "The CECMIntegrator class deplete using the ce/cm algorithm.\n\n implements the second order `ce/cm predictor-corrector algorithm\n `_.\n\n \"ce/cm\" stands for constant extrapolation on predictor and constant\n midpoint on corrector. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{n}_{i+1/2} &= \\exp \\left (\\frac{h}{2}\\mathbf{a}(\\mathbf{n}_i)\n \\right) \\mathbf{n}_i \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left(h \\mathbf{a}(\\mathbf{n}_{i+1/2}) \\right)\n \\mathbf{n}_i.\n \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the CECMIntegrator class?", "input": "OpenMC Python API CECMIntegrator.__call__() method", "output": "The __call__() method integrate using ce/cm. It's used for cecmintegrator operations." }, { "instruction": "How do you call the __call__() method in the CECMIntegrator class?", "input": "OpenMC Python API CECMIntegrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n: Any, rates: Any, dt: Any, source_rate: Any, _i: Any). It takes 6 parameters." }, { "instruction": "What does the n parameter do in the __call__() method?", "input": "OpenMC Python API CECMIntegrator.__call__() parameter n", "output": "The n parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the rates parameter do in the __call__() method?", "input": "OpenMC Python API CECMIntegrator.__call__() parameter rates", "output": "The rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API CECMIntegrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API CECMIntegrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _i parameter do in the __call__() method?", "input": "OpenMC Python API CECMIntegrator.__call__() parameter _i", "output": "The _i parameter current iteration count. not used. It should be a int, optional value." }, { "instruction": "What does the __call__() method return in the CECMIntegrator class?", "input": "OpenMC Python API CECMIntegrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the CECMIntegrator class?", "input": "OpenMC Python API CECMIntegrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the CECMIntegrator class?", "input": "OpenMC Python API CECMIntegrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from transport simulations. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What is the CF4Integrator class in OpenMC's Python API?", "input": "OpenMC Python API CF4Integrator class", "output": "The CF4Integrator class represents deplete using the cf4 algorithm.\n\n implements the fourth order `commutator-free lie algorithm\n `_.\n this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{a}_1 &= h\\mathbf{a}(\\mathbf{n}_i) \\\\\n \\hat{\\mathbf{n}}_1 &= \\exp \\left ( \\frac{\\mathbf{a}_1}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_2 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_1) \\\\\n \\hat{\\mathbf{n}}_2 &= \\exp \\left ( \\frac{\\mathbf{a}_2}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_3 &= h \\mathbf{a}(\\hat{\\mathbf{n}}_2) \\\\\n \\hat{\\mathbf{n}}_3 &= \\exp \\left ( -\\frac{\\mathbf{a}_1}{2} + \\mathbf{a}_3\n \\right ) \\hat{\\mathbf{n}}_1 \\\\\n \\mathbf{a}_4 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_3) \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left ( \\frac{\\mathbf{a}_1}{4} + \\frac{\\mathbf{a}_2}{6}\n + \\frac{\\mathbf{a}_3}{6} - \\frac{\\mathbf{a}_4}{12} \\right )\n \\exp \\left ( -\\frac{\\mathbf{a}_1}{12} + \\frac{\\mathbf{a}_2}{6} +\n \\frac{\\mathbf{a}_3}{6} + \\frac{\\mathbf{a}_4}{4} \\right ) \\mathbf{n}_i.\n \\end{aligned}. It provides 1 methods and 0 properties for working with cf4integrator data in OpenMC." }, { "instruction": "What does the CF4Integrator class do in OpenMC's Python API?", "input": "OpenMC Python API CF4Integrator class description", "output": "The CF4Integrator class deplete using the cf4 algorithm.\n\n implements the fourth order `commutator-free lie algorithm\n `_.\n this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{a}_1 &= h\\mathbf{a}(\\mathbf{n}_i) \\\\\n \\hat{\\mathbf{n}}_1 &= \\exp \\left ( \\frac{\\mathbf{a}_1}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_2 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_1) \\\\\n \\hat{\\mathbf{n}}_2 &= \\exp \\left ( \\frac{\\mathbf{a}_2}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_3 &= h \\mathbf{a}(\\hat{\\mathbf{n}}_2) \\\\\n \\hat{\\mathbf{n}}_3 &= \\exp \\left ( -\\frac{\\mathbf{a}_1}{2} + \\mathbf{a}_3\n \\right ) \\hat{\\mathbf{n}}_1 \\\\\n \\mathbf{a}_4 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_3) \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left ( \\frac{\\mathbf{a}_1}{4} + \\frac{\\mathbf{a}_2}{6}\n + \\frac{\\mathbf{a}_3}{6} - \\frac{\\mathbf{a}_4}{12} \\right )\n \\exp \\left ( -\\frac{\\mathbf{a}_1}{12} + \\frac{\\mathbf{a}_2}{6} +\n \\frac{\\mathbf{a}_3}{6} + \\frac{\\mathbf{a}_4}{4} \\right ) \\mathbf{n}_i.\n \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the CF4Integrator class?", "input": "OpenMC Python API CF4Integrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for cf4integrator operations." }, { "instruction": "How do you call the __call__() method in the CF4Integrator class?", "input": "OpenMC Python API CF4Integrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n_bos: Any, bos_rates: Any, dt: Any, source_rate: Any, _i: Any). It takes 6 parameters." }, { "instruction": "What does the n_bos parameter do in the __call__() method?", "input": "OpenMC Python API CF4Integrator.__call__() parameter n_bos", "output": "The n_bos parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the bos_rates parameter do in the __call__() method?", "input": "OpenMC Python API CF4Integrator.__call__() parameter bos_rates", "output": "The bos_rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API CF4Integrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API CF4Integrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _i parameter do in the __call__() method?", "input": "OpenMC Python API CF4Integrator.__call__() parameter _i", "output": "The _i parameter current depletion step index. not used. It should be a int, optional value." }, { "instruction": "What does the __call__() method return in the CF4Integrator class?", "input": "OpenMC Python API CF4Integrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the CF4Integrator class?", "input": "OpenMC Python API CF4Integrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the CF4Integrator class?", "input": "OpenMC Python API CF4Integrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from intermediate transport simulations. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What is the CELIIntegrator class in OpenMC's Python API?", "input": "OpenMC Python API CELIIntegrator class", "output": "The CELIIntegrator class represents deplete using the ce/li cfq4 algorithm.\n\n implements the ce/li predictor-corrector algorithm using the `fourth order\n commutator-free integrator `_.\n\n \"ce/li\" stands for constant extrapolation on predictor and linear\n interpolation on corrector. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{n}_{i+1}^p &= \\exp \\left ( h \\mathbf{a}(\\mathbf{n}_i ) \\right )\n \\mathbf{n}_i \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left( \\frac{h}{12} \\mathbf{a}(\\mathbf{n}_i) +\n \\frac{5h}{12} \\mathbf{a}(\\mathbf{n}_{i+1}^p) \\right)\n \\exp \\left( \\frac{5h}{12} \\mathbf{a}(\\mathbf{n}_i) +\n \\frac{h}{12} \\mathbf{a}(\\mathbf{n}_{i+1}^p) \\right) \\mathbf{n}_i.\n \\end{aligned}. It provides 1 methods and 0 properties for working with celiintegrator data in OpenMC." }, { "instruction": "What does the CELIIntegrator class do in OpenMC's Python API?", "input": "OpenMC Python API CELIIntegrator class description", "output": "The CELIIntegrator class deplete using the ce/li cfq4 algorithm.\n\n implements the ce/li predictor-corrector algorithm using the `fourth order\n commutator-free integrator `_.\n\n \"ce/li\" stands for constant extrapolation on predictor and linear\n interpolation on corrector. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{n}_{i+1}^p &= \\exp \\left ( h \\mathbf{a}(\\mathbf{n}_i ) \\right )\n \\mathbf{n}_i \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left( \\frac{h}{12} \\mathbf{a}(\\mathbf{n}_i) +\n \\frac{5h}{12} \\mathbf{a}(\\mathbf{n}_{i+1}^p) \\right)\n \\exp \\left( \\frac{5h}{12} \\mathbf{a}(\\mathbf{n}_i) +\n \\frac{h}{12} \\mathbf{a}(\\mathbf{n}_{i+1}^p) \\right) \\mathbf{n}_i.\n \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the CELIIntegrator class?", "input": "OpenMC Python API CELIIntegrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for celiintegrator operations." }, { "instruction": "How do you call the __call__() method in the CELIIntegrator class?", "input": "OpenMC Python API CELIIntegrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n_bos: Any, rates: Any, dt: Any, source_rate: Any, _i: Any). It takes 6 parameters." }, { "instruction": "What does the n_bos parameter do in the __call__() method?", "input": "OpenMC Python API CELIIntegrator.__call__() parameter n_bos", "output": "The n_bos parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the rates parameter do in the __call__() method?", "input": "OpenMC Python API CELIIntegrator.__call__() parameter rates", "output": "The rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API CELIIntegrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API CELIIntegrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _i parameter do in the __call__() method?", "input": "OpenMC Python API CELIIntegrator.__call__() parameter _i", "output": "The _i parameter current iteration count. not used. It should be a int, optional value." }, { "instruction": "What does the __call__() method return in the CELIIntegrator class?", "input": "OpenMC Python API CELIIntegrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the CELIIntegrator class?", "input": "OpenMC Python API CELIIntegrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the CELIIntegrator class?", "input": "OpenMC Python API CELIIntegrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from intermediate transport simulation. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What is the EPCRK4Integrator class in OpenMC's Python API?", "input": "OpenMC Python API EPCRK4Integrator class", "output": "The EPCRK4Integrator class represents deplete using the epc-rk4 algorithm.\n\n implements an extended predictor-corrector algorithm with traditional\n runge-kutta 4 method. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{a}_1 &= h\\mathbf{a}(\\mathbf{n}_i) \\\\\n \\hat{\\mathbf{n}}_1 &= \\exp \\left ( \\frac{\\mathbf{a}_1}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_2 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_1) \\\\\n \\hat{\\mathbf{n}}_2 &= \\exp \\left ( \\frac{\\mathbf{a}_2}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_3 &= h \\mathbf{a}(\\hat{\\mathbf{n}}_2) \\\\\n \\hat{\\mathbf{n}}_3 &= \\exp \\left ( \\mathbf{a}_3 \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_4 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_3) \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left ( \\frac{\\mathbf{a}_1}{6} + \\frac{\\mathbf{a}_2}{3}\n + \\frac{\\mathbf{a}_3}{3} + \\frac{\\mathbf{a}_4}{6} \\right ) \\mathbf{n}_i.\n \\end{aligned}. It provides 1 methods and 0 properties for working with epcrk4integrator data in OpenMC." }, { "instruction": "What does the EPCRK4Integrator class do in OpenMC's Python API?", "input": "OpenMC Python API EPCRK4Integrator class description", "output": "The EPCRK4Integrator class deplete using the epc-rk4 algorithm.\n\n implements an extended predictor-corrector algorithm with traditional\n runge-kutta 4 method. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{a}_1 &= h\\mathbf{a}(\\mathbf{n}_i) \\\\\n \\hat{\\mathbf{n}}_1 &= \\exp \\left ( \\frac{\\mathbf{a}_1}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_2 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_1) \\\\\n \\hat{\\mathbf{n}}_2 &= \\exp \\left ( \\frac{\\mathbf{a}_2}{2} \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_3 &= h \\mathbf{a}(\\hat{\\mathbf{n}}_2) \\\\\n \\hat{\\mathbf{n}}_3 &= \\exp \\left ( \\mathbf{a}_3 \\right ) \\mathbf{n}_i \\\\\n \\mathbf{a}_4 &= h\\mathbf{a}(\\hat{\\mathbf{n}}_3) \\\\\n \\mathbf{n}_{i+1} &= \\exp \\left ( \\frac{\\mathbf{a}_1}{6} + \\frac{\\mathbf{a}_2}{3}\n + \\frac{\\mathbf{a}_3}{3} + \\frac{\\mathbf{a}_4}{6} \\right ) \\mathbf{n}_i.\n \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the EPCRK4Integrator class?", "input": "OpenMC Python API EPCRK4Integrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for epcrk4integrator operations." }, { "instruction": "How do you call the __call__() method in the EPCRK4Integrator class?", "input": "OpenMC Python API EPCRK4Integrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n: Any, rates: Any, dt: Any, source_rate: Any, _i: Any). It takes 6 parameters." }, { "instruction": "What does the n parameter do in the __call__() method?", "input": "OpenMC Python API EPCRK4Integrator.__call__() parameter n", "output": "The n parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the rates parameter do in the __call__() method?", "input": "OpenMC Python API EPCRK4Integrator.__call__() parameter rates", "output": "The rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API EPCRK4Integrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API EPCRK4Integrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _i parameter do in the __call__() method?", "input": "OpenMC Python API EPCRK4Integrator.__call__() parameter _i", "output": "The _i parameter current depletion step index, unused.. It should be a int, optional value." }, { "instruction": "What does the __call__() method return in the EPCRK4Integrator class?", "input": "OpenMC Python API EPCRK4Integrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the EPCRK4Integrator class?", "input": "OpenMC Python API EPCRK4Integrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the EPCRK4Integrator class?", "input": "OpenMC Python API EPCRK4Integrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from intermediate transport simulations. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What is the LEQIIntegrator class in OpenMC's Python API?", "input": "OpenMC Python API LEQIIntegrator class", "output": "The LEQIIntegrator class represents deplete using the le/qi cfq4 algorithm.\n\n implements the le/qi predictor-corrector algorithm using the `fourth order\n commutator-free integrator `_.\n\n \"le/qi\" stands for linear extrapolation on predictor and quadratic\n interpolation on corrector. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{a}_{-1} &= \\mathbf{a}(\\mathbf{n}_{i-1}) \\\\\n \\mathbf{a}_0 &= \\mathbf{a}(\\mathbf{n}_i) \\\\\n \\mathbf{f}_1 &= \\frac{-h_i}{12h_{i-1}} \\mathbf{a}_{-1} + \\frac{6h_{i-1}\n + h_i}{12h_{i-1}} \\mathbf{a}_0 \\\\\n \\mathbf{f}_2 &= \\frac{-5h_i}{12h_{i-1}} \\mathbf{a}_{-1} + \\frac{6h_{i-1}\n + 5h_i}{12h_{i-1}} \\mathbf{a}_0 \\\\\n \\mathbf{n}_{i+1}^p &= \\exp (h_i \\mathbf{f}_1) \\exp(h_i \\mathbf{f}_2)\n \\mathbf{n}_i \\\\\n \\mathbf{a}_1 &= \\mathbf{a}(\\mathbf{n}_{i+1}^p) \\\\\n \\mathbf{f}_3 &= \\frac{-h_i^2}{12 h_{i-1} (h_{i-1} + h_i)} \\mathbf{a}_{-1} +\n \\frac{5 h_{i-1}^2 + 6 h_i h_{i-1} + h_i^2}{12 h_{i-1} (h_{i-1} +\n h_i)} \\mathbf{a}_0 + \\frac{h_{i-1}}{12 (h_{i-1} + h_i)} \\mathbf{a}_1 \\\\\n \\mathbf{f}_4 &= \\frac{-h_i^2}{12 h_{i-1} (h_{i-1} + h_i)} \\mathbf{a}_{-1} +\n \\frac{h_{i-1}^2 + 2 h_i h_{i-1} + h_i^2}{12 h_{i-1} (h_{i-1} + h_i)}\n \\mathbf{a}_0 + \\frac{5 h_{i-1} + 4 h_i}{12 (h_{i-1} + h_i)} \\mathbf{a}_1 \\\\\n \\mathbf{n}_{i+1} &= \\exp(h_i \\mathbf{f}_4) \\exp(h_i \\mathbf{f}_3) \\mathbf{n}_i\n \\end{aligned}\n\n it is initialized using the ce/li algorithm.. It provides 1 methods and 0 properties for working with leqiintegrator data in OpenMC." }, { "instruction": "What does the LEQIIntegrator class do in OpenMC's Python API?", "input": "OpenMC Python API LEQIIntegrator class description", "output": "The LEQIIntegrator class deplete using the le/qi cfq4 algorithm.\n\n implements the le/qi predictor-corrector algorithm using the `fourth order\n commutator-free integrator `_.\n\n \"le/qi\" stands for linear extrapolation on predictor and quadratic\n interpolation on corrector. this algorithm is mathematically defined as:\n\n .. math::\n \\begin{aligned}\n \\mathbf{a}_{-1} &= \\mathbf{a}(\\mathbf{n}_{i-1}) \\\\\n \\mathbf{a}_0 &= \\mathbf{a}(\\mathbf{n}_i) \\\\\n \\mathbf{f}_1 &= \\frac{-h_i}{12h_{i-1}} \\mathbf{a}_{-1} + \\frac{6h_{i-1}\n + h_i}{12h_{i-1}} \\mathbf{a}_0 \\\\\n \\mathbf{f}_2 &= \\frac{-5h_i}{12h_{i-1}} \\mathbf{a}_{-1} + \\frac{6h_{i-1}\n + 5h_i}{12h_{i-1}} \\mathbf{a}_0 \\\\\n \\mathbf{n}_{i+1}^p &= \\exp (h_i \\mathbf{f}_1) \\exp(h_i \\mathbf{f}_2)\n \\mathbf{n}_i \\\\\n \\mathbf{a}_1 &= \\mathbf{a}(\\mathbf{n}_{i+1}^p) \\\\\n \\mathbf{f}_3 &= \\frac{-h_i^2}{12 h_{i-1} (h_{i-1} + h_i)} \\mathbf{a}_{-1} +\n \\frac{5 h_{i-1}^2 + 6 h_i h_{i-1} + h_i^2}{12 h_{i-1} (h_{i-1} +\n h_i)} \\mathbf{a}_0 + \\frac{h_{i-1}}{12 (h_{i-1} + h_i)} \\mathbf{a}_1 \\\\\n \\mathbf{f}_4 &= \\frac{-h_i^2}{12 h_{i-1} (h_{i-1} + h_i)} \\mathbf{a}_{-1} +\n \\frac{h_{i-1}^2 + 2 h_i h_{i-1} + h_i^2}{12 h_{i-1} (h_{i-1} + h_i)}\n \\mathbf{a}_0 + \\frac{5 h_{i-1} + 4 h_i}{12 (h_{i-1} + h_i)} \\mathbf{a}_1 \\\\\n \\mathbf{n}_{i+1} &= \\exp(h_i \\mathbf{f}_4) \\exp(h_i \\mathbf{f}_3) \\mathbf{n}_i\n \\end{aligned}\n\n it is initialized using the ce/li algorithm.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the LEQIIntegrator class?", "input": "OpenMC Python API LEQIIntegrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for leqiintegrator operations." }, { "instruction": "How do you call the __call__() method in the LEQIIntegrator class?", "input": "OpenMC Python API LEQIIntegrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n_bos: Any, bos_rates: Any, dt: Any, source_rate: Any, i: Any). It takes 6 parameters." }, { "instruction": "What does the n_bos parameter do in the __call__() method?", "input": "OpenMC Python API LEQIIntegrator.__call__() parameter n_bos", "output": "The n_bos parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the bos_rates parameter do in the __call__() method?", "input": "OpenMC Python API LEQIIntegrator.__call__() parameter bos_rates", "output": "The bos_rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API LEQIIntegrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API LEQIIntegrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the i parameter do in the __call__() method?", "input": "OpenMC Python API LEQIIntegrator.__call__() parameter i", "output": "The i parameter current depletion step index. It should be a int value." }, { "instruction": "What does the __call__() method return in the LEQIIntegrator class?", "input": "OpenMC Python API LEQIIntegrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the LEQIIntegrator class?", "input": "OpenMC Python API LEQIIntegrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the LEQIIntegrator class?", "input": "OpenMC Python API LEQIIntegrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from intermediate transport simulation. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What is the SICELIIntegrator class in OpenMC's Python API?", "input": "OpenMC Python API SICELIIntegrator class", "output": "The SICELIIntegrator class represents deplete using the si-ce/li cfq4 algorithm.\n\n implements the stochastic implicit ce/li predictor-corrector algorithm\n using the `fourth order commutator-free integrator\n `_.\n\n detailed algorithm can be found in section 3.2 in `colin josey's thesis\n `_.. It provides 1 methods and 0 properties for working with siceliintegrator data in OpenMC." }, { "instruction": "What does the SICELIIntegrator class do in OpenMC's Python API?", "input": "OpenMC Python API SICELIIntegrator class description", "output": "The SICELIIntegrator class deplete using the si-ce/li cfq4 algorithm.\n\n implements the stochastic implicit ce/li predictor-corrector algorithm\n using the `fourth order commutator-free integrator\n `_.\n\n detailed algorithm can be found in section 3.2 in `colin josey's thesis\n `_.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the SICELIIntegrator class?", "input": "OpenMC Python API SICELIIntegrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for siceliintegrator operations." }, { "instruction": "How do you call the __call__() method in the SICELIIntegrator class?", "input": "OpenMC Python API SICELIIntegrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n_bos: Any, bos_rates: Any, dt: Any, source_rate: Any, _i: Any). It takes 6 parameters." }, { "instruction": "What does the n_bos parameter do in the __call__() method?", "input": "OpenMC Python API SICELIIntegrator.__call__() parameter n_bos", "output": "The n_bos parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the bos_rates parameter do in the __call__() method?", "input": "OpenMC Python API SICELIIntegrator.__call__() parameter bos_rates", "output": "The bos_rates parameter reaction rates from operator. It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API SICELIIntegrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API SICELIIntegrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _i parameter do in the __call__() method?", "input": "OpenMC Python API SICELIIntegrator.__call__() parameter _i", "output": "The _i parameter current depletion step index. not used. It should be a int, optional value." }, { "instruction": "What does the __call__() method return in the SICELIIntegrator class?", "input": "OpenMC Python API SICELIIntegrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the SICELIIntegrator class?", "input": "OpenMC Python API SICELIIntegrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the SICELIIntegrator class?", "input": "OpenMC Python API SICELIIntegrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from intermediate transport simulations. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What is the SILEQIIntegrator class in OpenMC's Python API?", "input": "OpenMC Python API SILEQIIntegrator class", "output": "The SILEQIIntegrator class represents deplete using the si-le/qi cfq4 algorithm.\n\n implements the stochastic implicit le/qi predictor-corrector algorithm\n using the `fourth order commutator-free integrator\n `_.\n\n detailed algorithm can be found in section 3.2 in `colin josey's thesis\n `_.. It provides 1 methods and 0 properties for working with sileqiintegrator data in OpenMC." }, { "instruction": "What does the SILEQIIntegrator class do in OpenMC's Python API?", "input": "OpenMC Python API SILEQIIntegrator class description", "output": "The SILEQIIntegrator class deplete using the si-le/qi cfq4 algorithm.\n\n implements the stochastic implicit le/qi predictor-corrector algorithm\n using the `fourth order commutator-free integrator\n `_.\n\n detailed algorithm can be found in section 3.2 in `colin josey's thesis\n `_.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the __call__() method do in the SILEQIIntegrator class?", "input": "OpenMC Python API SILEQIIntegrator.__call__() method", "output": "The __call__() method perform the integration across one time step. It's used for sileqiintegrator operations." }, { "instruction": "How do you call the __call__() method in the SILEQIIntegrator class?", "input": "OpenMC Python API SILEQIIntegrator.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, n_bos: Any, bos_rates: Any, dt: Any, source_rate: Any, i: Any). It takes 6 parameters." }, { "instruction": "What does the n_bos parameter do in the __call__() method?", "input": "OpenMC Python API SILEQIIntegrator.__call__() parameter n_bos", "output": "The n_bos parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the bos_rates parameter do in the __call__() method?", "input": "OpenMC Python API SILEQIIntegrator.__call__() parameter bos_rates", "output": "The bos_rates parameter reaction rates from operator for all depletable materials. It should be a list of openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the __call__() method?", "input": "OpenMC Python API SILEQIIntegrator.__call__() parameter dt", "output": "The dt parameter time in [s] for the entire depletion interval. It should be a float value." }, { "instruction": "What does the source_rate parameter do in the __call__() method?", "input": "OpenMC Python API SILEQIIntegrator.__call__() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the i parameter do in the __call__() method?", "input": "OpenMC Python API SILEQIIntegrator.__call__() parameter i", "output": "The i parameter current depletion step index. It should be a int value." }, { "instruction": "What does the __call__() method return in the SILEQIIntegrator class?", "input": "OpenMC Python API SILEQIIntegrator.__call__() return value", "output": "The __call__() method returns time spent in cram routines for all materials in [s]. The return type is float." }, { "instruction": "What does the __call__() method return in the SILEQIIntegrator class?", "input": "OpenMC Python API SILEQIIntegrator.__call__() return value", "output": "The __call__() method returns concentrations at each of the intermediate points with the final concentration as the last element. The return type is list of list of numpy.ndarray." }, { "instruction": "What does the __call__() method return in the SILEQIIntegrator class?", "input": "OpenMC Python API SILEQIIntegrator.__call__() return value", "output": "The __call__() method returns eigenvalue and reaction rates from intermediate transport simulation. The return type is list of openmc.deplete.OperatorResult." }, { "instruction": "What is the MicroXS class in OpenMC's Python API?", "input": "OpenMC Python API MicroXS class", "output": "The MicroXS class represents microscopic cross section data for use in transport-independent depletion. .. versionadded:: 0.13.1 .. versionchanged:: 0.14.0 class was heavily refactored and no longer subclasses pandas.dataframe. It provides 5 methods and 0 properties for working with microxs data in OpenMC." }, { "instruction": "What does the MicroXS class do in OpenMC's Python API?", "input": "OpenMC Python API MicroXS class description", "output": "The MicroXS class microscopic cross section data for use in transport-independent depletion. .. versionadded:: 0.13.1 .. versionchanged:: 0.14.0 class was heavily refactored and no longer subclasses pandas.dataframe. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the data parameter do when creating a MicroXS?", "input": "OpenMC Python API MicroXS constructor parameter data", "output": "When creating a MicroXS, the data parameter specifies 3d array containing microscopic cross section values for each nuclide, reaction, and energy group. cross section values are assumed to be in [b], and indexed by [nuclide, reaction, energy group]. It should be a numpy.ndarray of floats value." }, { "instruction": "What does the nuclides parameter do when creating a MicroXS?", "input": "OpenMC Python API MicroXS constructor parameter nuclides", "output": "When creating a MicroXS, the nuclides parameter specifies list of nuclide symbols for that have data for at least one reaction.. It should be a list of str value." }, { "instruction": "What does the reactions parameter do when creating a MicroXS?", "input": "OpenMC Python API MicroXS constructor parameter reactions", "output": "When creating a MicroXS, the reactions parameter specifies list of reactions. all reactions must match those in :data:`openmc.deplete.chain.reactions`. It should be a list of str value." }, { "instruction": "How do you call the __init__() method in the MicroXS class?", "input": "OpenMC Python API MicroXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, data: np.ndarray, nuclides: Any, reactions: Any). It takes 4 parameters." }, { "instruction": "What does the from_multigroup_flux() method do in the MicroXS class?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() method", "output": "The from_multigroup_flux() method generated microscopic cross sections from a known flux. the size of the microxs matrix depends on the chain file and cross sections available. microxs entry will be 0 if the nuclide cross section is not found. .. versionadded:: 0.15.0. It's used for microxs operations." }, { "instruction": "How do you call the from_multigroup_flux() method in the MicroXS class?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() method signature", "output": "To call the from_multigroup_flux() method, use: @classmethod def from_multigroup_flux(cls: Any, energies: Any, multigroup_flux: Any, chain_file: Any, temperature: float, nuclides: Any, reactions: Any). It takes 7 parameters." }, { "instruction": "What does the energies parameter do in the from_multigroup_flux() method?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() parameter energies", "output": "The energies parameter energy group boundaries in [ev] or the name of the group structure. It should be a iterable of float or str value." }, { "instruction": "What does the multi_group_flux parameter do in the from_multigroup_flux() method?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() parameter multi_group_flux", "output": "The multi_group_flux parameter energy-dependent multigroup flux values. It should be a iterable of float value." }, { "instruction": "What does the chain_file parameter do in the from_multigroup_flux() method?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() parameter chain_file", "output": "The chain_file parameter path to the depletion chain xml file that will be used in depletion simulation. defaults to ``openmc.config['chain_file']``.. It should be a str, optional value." }, { "instruction": "What does the temperature parameter do in the from_multigroup_flux() method?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() parameter temperature", "output": "The temperature parameter temperature for cross section evaluation in [k].. It should be a int, optional value." }, { "instruction": "What does the nuclides parameter do in the from_multigroup_flux() method?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() parameter nuclides", "output": "The nuclides parameter nuclides to get cross sections for. if not specified, all burnable nuclides from the depletion chain file are used.. It should be a list of str, optional value." }, { "instruction": "What does the reactions parameter do in the from_multigroup_flux() method?", "input": "OpenMC Python API MicroXS.from_multigroup_flux() parameter reactions", "output": "The reactions parameter reactions to get cross sections for. if not specified, all neutron reactions listed in the depletion chain file are used. **init_kwargs : dict keyword arguments passed to :func:`openmc.lib.init`. It should be a list of str, optional value." }, { "instruction": "What does the from_csv() method do in the MicroXS class?", "input": "OpenMC Python API MicroXS.from_csv() method", "output": "The from_csv() method load data from a comma-separated values (csv) file. It's used for microxs operations." }, { "instruction": "How do you call the from_csv() method in the MicroXS class?", "input": "OpenMC Python API MicroXS.from_csv() method signature", "output": "To call the from_csv() method, use: @classmethod def from_csv(cls: Any, csv_file: Any). It takes 2 parameters." }, { "instruction": "What does the csv_file parameter do in the from_csv() method?", "input": "OpenMC Python API MicroXS.from_csv() parameter csv_file", "output": "The csv_file parameter relative path to csv-file containing microscopic cross section data. cross section values are assumed to be in [b] **kwargs : dict keyword arguments to pass to :func:`pandas.read_csv()`.. It should be a str value." }, { "instruction": "How do you call the __getitem__() method in the MicroXS class?", "input": "OpenMC Python API MicroXS.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, index: Any). It takes 2 parameters." }, { "instruction": "What does the to_csv() method do in the MicroXS class?", "input": "OpenMC Python API MicroXS.to_csv() method", "output": "The to_csv() method write data to a comma-separated values (csv) file. It's used for microxs operations." }, { "instruction": "How do you call the to_csv() method in the MicroXS class?", "input": "OpenMC Python API MicroXS.to_csv() method signature", "output": "To call the to_csv() method, use: def to_csv(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _resolve_chain_file_path() function in OpenMC's Python API?", "input": "OpenMC Python API _resolve_chain_file_path() function signature", "output": "To call the _resolve_chain_file_path() function, use: def _resolve_chain_file_path(chain_file: Any). It takes 1 parameters." }, { "instruction": "What does the get_microxs_and_flux() function do in OpenMC's Python API?", "input": "OpenMC Python API get_microxs_and_flux() function", "output": "The get_microxs_and_flux() function generate a microscopic cross sections and flux from a model .. versionadded:: 0.14.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_microxs_and_flux() function in OpenMC's Python API?", "input": "OpenMC Python API get_microxs_and_flux() function purpose", "output": "The get_microxs_and_flux() function generate a microscopic cross sections and flux from a model .. versionadded:: 0.14.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_microxs_and_flux() function in OpenMC's Python API?", "input": "OpenMC Python API get_microxs_and_flux() function signature", "output": "To call the get_microxs_and_flux() function, use: def get_microxs_and_flux(model: openmc.Model, domains: Any, nuclides: Any, reactions: Any, energies: Any, chain_file: Any, run_kwargs: Any). It takes 7 parameters." }, { "instruction": "What does the model parameter do in the get_microxs_and_flux() function?", "input": "OpenMC Python API get_microxs_and_flux() parameter model", "output": "The model parameter openmc model object. must contain geometry, materials, and settings.. It should be a openmc.Model value." }, { "instruction": "What does the domains parameter do in the get_microxs_and_flux() function?", "input": "OpenMC Python API get_microxs_and_flux() parameter domains", "output": "The domains parameter domains in which to tally reaction rates.. It should be a list of openmc.Material or openmc.Cell or openmc.Universe, or openmc.MeshBase value." }, { "instruction": "What does the nuclides parameter do in the get_microxs_and_flux() function?", "input": "OpenMC Python API get_microxs_and_flux() parameter nuclides", "output": "The nuclides parameter nuclides to get cross sections for. if not specified, all burnable nuclides from the depletion chain file are used.. It should be a list of str value." }, { "instruction": "What does the reactions parameter do in the get_microxs_and_flux() function?", "input": "OpenMC Python API get_microxs_and_flux() parameter reactions", "output": "The reactions parameter reactions to get cross sections for. if not specified, all neutron reactions listed in the depletion chain file are used.. It should be a list of str value." }, { "instruction": "What does the energies parameter do in the get_microxs_and_flux() function?", "input": "OpenMC Python API get_microxs_and_flux() parameter energies", "output": "The energies parameter energy group boundaries in [ev] or the name of the group structure. It should be a iterable of float or str value." }, { "instruction": "What does the chain_file parameter do in the get_microxs_and_flux() function?", "input": "OpenMC Python API get_microxs_and_flux() parameter chain_file", "output": "The chain_file parameter path to the depletion chain xml file that will be used in depletion simulation. used to determine cross sections for materials not present in the inital composition. defaults to ``openmc.config['chain_file']``.. It should be a str, optional value." }, { "instruction": "What does the run_kwargs parameter do in the get_microxs_and_flux() function?", "input": "OpenMC Python API get_microxs_and_flux() parameter run_kwargs", "output": "The run_kwargs parameter keyword arguments passed to :meth:`openmc.model.run`. It should be a dict, optional value." }, { "instruction": "What is the Nuclide class in OpenMC's Python API?", "input": "OpenMC Python API Nuclide class", "output": "The Nuclide class represents decay modes, reactions, and fission yields for a single nuclide. It provides 12 methods and 0 properties for working with nuclide data in OpenMC." }, { "instruction": "What does the Nuclide class do in OpenMC's Python API?", "input": "OpenMC Python API Nuclide class description", "output": "The Nuclide class decay modes, reactions, and fission yields for a single nuclide. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a Nuclide?", "input": "OpenMC Python API Nuclide constructor parameter name", "output": "When creating a Nuclide, the name parameter specifies gnds name of this nuclide, e.g. ``\"he4\"``, ``\"am242_m1\"``. It should be a str, optional value." }, { "instruction": "What is the name attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute name", "output": "The name attribute of a Nuclide contains name of nuclide.. It's a str or None value that you can access after creating a Nuclide instance." }, { "instruction": "What is the half_life attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute half_life", "output": "The half_life attribute of a Nuclide contains half life of nuclide in [s].. It's a float or None value that you can access after creating a Nuclide instance." }, { "instruction": "What is the decay_energy attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute decay_energy", "output": "The decay_energy attribute of a Nuclide contains energy deposited from decay in [ev].. It's a float value that you can access after creating a Nuclide instance." }, { "instruction": "What is the n_decay_modes attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute n_decay_modes", "output": "The n_decay_modes attribute of a Nuclide contains number of decay pathways.. It's a int value that you can access after creating a Nuclide instance." }, { "instruction": "What is the decay_modes attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute decay_modes", "output": "The decay_modes attribute of a Nuclide contains decay mode information. each element of the list is a named tuple with attributes 'type', 'target', and 'branching_ratio'.. It's a list of openmc.deplete.DecayTuple value that you can access after creating a Nuclide instance." }, { "instruction": "What is the n_reaction_paths attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute n_reaction_paths", "output": "The n_reaction_paths attribute of a Nuclide contains number of possible reaction pathways.. It's a int value that you can access after creating a Nuclide instance." }, { "instruction": "What is the reactions attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute reactions", "output": "The reactions attribute of a Nuclide contains reaction information. each element of the list is a named tuple with attribute 'type', 'target', 'q', and 'branching_ratio'.. It's a list of openmc.deplete.ReactionTuple value that you can access after creating a Nuclide instance." }, { "instruction": "What is the sources attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute sources", "output": "The sources attribute of a Nuclide contains dictionary mapping particle type as string to energy distribution of decay source represented as :class:`openmc.stats.univariate`. It's a dict value that you can access after creating a Nuclide instance." }, { "instruction": "What is the yield_data attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute yield_data", "output": "The yield_data attribute of a Nuclide contains fission product yields at tabulated energies for this nuclide. can be treated as a nested dictionary ``{energy: {product: yield}}``. It's a FissionYieldDistribution or None value that you can access after creating a Nuclide instance." }, { "instruction": "What is the yield_energies attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute yield_energies", "output": "The yield_energies attribute of a Nuclide contains energies at which fission product yields exist. It's a tuple of float or None value that you can access after creating a Nuclide instance." }, { "instruction": "How do you call the __init__() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_decay_modes() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.n_decay_modes() method signature", "output": "To call the n_decay_modes() method, use: @property def n_decay_modes(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_reaction_paths() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.n_reaction_paths() method signature", "output": "To call the n_reaction_paths() method, use: @property def n_reaction_paths(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the yield_data() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.yield_data() method signature", "output": "To call the yield_data() method, use: @property def yield_data(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the yield_data() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.yield_data() method signature", "output": "To call the yield_data() method, use: @yield_data.setter def yield_data(self: Any, fission_yields: Any). It takes 2 parameters." }, { "instruction": "How do you call the yield_energies() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.yield_energies() method signature", "output": "To call the yield_energies() method, use: @property def yield_energies(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_decay_mode() method do in the Nuclide class?", "input": "OpenMC Python API Nuclide.add_decay_mode() method", "output": "The add_decay_mode() method add decay mode to the nuclide. It's used for nuclide operations." }, { "instruction": "How do you call the add_decay_mode() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.add_decay_mode() method signature", "output": "To call the add_decay_mode() method, use: def add_decay_mode(self: Any, type: Any, target: Any, branching_ratio: Any). It takes 4 parameters." }, { "instruction": "What does the type parameter do in the add_decay_mode() method?", "input": "OpenMC Python API Nuclide.add_decay_mode() parameter type", "output": "The type parameter type of the decay mode, e.g., 'beta-'. It should be a str value." }, { "instruction": "What does the target parameter do in the add_decay_mode() method?", "input": "OpenMC Python API Nuclide.add_decay_mode() parameter target", "output": "The target parameter nuclide resulting from decay. a value of ``none`` implies the target does not exist in the currently configured depletion chain. It should be a str or None value." }, { "instruction": "What does the branching_ratio parameter do in the add_decay_mode() method?", "input": "OpenMC Python API Nuclide.add_decay_mode() parameter branching_ratio", "output": "The branching_ratio parameter branching ratio of the decay mode. It should be a float value." }, { "instruction": "What does the add_reaction() method do in the Nuclide class?", "input": "OpenMC Python API Nuclide.add_reaction() method", "output": "The add_reaction() method add transmutation reaction to the nuclide. It's used for nuclide operations." }, { "instruction": "How do you call the add_reaction() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.add_reaction() method signature", "output": "To call the add_reaction() method, use: def add_reaction(self: Any, type: Any, target: Any, Q: Any, branching_ratio: Any). It takes 5 parameters." }, { "instruction": "What does the type parameter do in the add_reaction() method?", "input": "OpenMC Python API Nuclide.add_reaction() parameter type", "output": "The type parameter type of the reaction, e.g., 'fission'. It should be a str value." }, { "instruction": "What does the target parameter do in the add_reaction() method?", "input": "OpenMC Python API Nuclide.add_reaction() parameter target", "output": "The target parameter nuclide resulting from reaction. a value of ``none`` implies either no single target, e.g. from fission, or that the target nuclide is not considered in the current depletion chain. It should be a str or None value." }, { "instruction": "What does the Q parameter do in the add_reaction() method?", "input": "OpenMC Python API Nuclide.add_reaction() parameter Q", "output": "The Q parameter q value of the reaction in [ev]. It should be a float value." }, { "instruction": "What does the branching_ratio parameter do in the add_reaction() method?", "input": "OpenMC Python API Nuclide.add_reaction() parameter branching_ratio", "output": "The branching_ratio parameter branching ratio of the reaction. It should be a float value." }, { "instruction": "What does the from_xml() method do in the Nuclide class?", "input": "OpenMC Python API Nuclide.from_xml() method", "output": "The from_xml() method read nuclide from an xml element. It's used for nuclide operations." }, { "instruction": "How do you call the from_xml() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, element: Any, root: Any, fission_q: Any). It takes 4 parameters." }, { "instruction": "What does the element parameter do in the from_xml() method?", "input": "OpenMC Python API Nuclide.from_xml() parameter element", "output": "The element parameter xml element to read nuclide data from. It should be a lxml.etree._Element value." }, { "instruction": "What does the root parameter do in the from_xml() method?", "input": "OpenMC Python API Nuclide.from_xml() parameter root", "output": "The root parameter root xml element for chain file (only used when fission product yields are borrowed from another parent). It should be a lxml.etree._Element, optional value." }, { "instruction": "What does the fission_q parameter do in the from_xml() method?", "input": "OpenMC Python API Nuclide.from_xml() parameter fission_q", "output": "The fission_q parameter user-supplied fission q value [ev]. will be read from the element if not given. It should be a None or float value." }, { "instruction": "What does the from_xml() method return in the Nuclide class?", "input": "OpenMC Python API Nuclide.from_xml() return value", "output": "The from_xml() method returns instance of a nuclide. The return type is openmc.deplete.Nuclide." }, { "instruction": "What does the to_xml_element() method do in the Nuclide class?", "input": "OpenMC Python API Nuclide.to_xml_element() method", "output": "The to_xml_element() method write nuclide to xml element. It's used for nuclide operations." }, { "instruction": "How do you call the to_xml_element() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Nuclide class?", "input": "OpenMC Python API Nuclide.to_xml_element() return value", "output": "The to_xml_element() method returns xml element to write nuclide data to. The return type is lxml.etree._Element." }, { "instruction": "What does the validate() method do in the Nuclide class?", "input": "OpenMC Python API Nuclide.validate() method", "output": "The validate() method search for possible inconsistencies the following checks are performed: 1) for all non-fission reactions and decay modes, does the sum of branching ratios equal about one? 2) for fission reactions, does the sum of fission yield fractions equal about two?. It's used for nuclide operations." }, { "instruction": "How do you call the validate() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.validate() method signature", "output": "To call the validate() method, use: def validate(self: Any, strict: Any, quiet: Any, tolerance: Any). It takes 4 parameters." }, { "instruction": "What does the strict parameter do in the validate() method?", "input": "OpenMC Python API Nuclide.validate() parameter strict", "output": "The strict parameter raise exceptions at the first inconsistency if true. otherwise mark a warning. It should be a bool, optional value." }, { "instruction": "What does the quiet parameter do in the validate() method?", "input": "OpenMC Python API Nuclide.validate() parameter quiet", "output": "The quiet parameter flag to suppress warnings and return immediately at the first inconsistency. used only if ``strict`` does not evaluate to ``true``.. It should be a bool, optional value." }, { "instruction": "What does the tolerance parameter do in the validate() method?", "input": "OpenMC Python API Nuclide.validate() parameter tolerance", "output": "The tolerance parameter absolute tolerance for comparisons. used to compare computed value ``x`` to intended value ``y`` as:: valid = (y - tolerance <= x <= y + tolerance). It should be a float, optional value." }, { "instruction": "What does the validate() method return in the Nuclide class?", "input": "OpenMC Python API Nuclide.validate() return value", "output": "The validate() method returns true if no inconsistencies were found. The return type is bool." }, { "instruction": "What is the FissionYieldDistribution class in OpenMC's Python API?", "input": "OpenMC Python API FissionYieldDistribution class", "output": "The FissionYieldDistribution class represents energy-dependent fission product yields for a single nuclide can be used as a dictionary mapping energies and products to fission yields:: >>> fydist = fissionyielddistribution( ... {0.0253: {\"xe135\": 0.021}}) >>> fydist[0.0253][\"xe135\"] 0.021. It provides 8 methods and 0 properties for working with fissionyielddistribution data in OpenMC." }, { "instruction": "What does the FissionYieldDistribution class do in OpenMC's Python API?", "input": "OpenMC Python API FissionYieldDistribution class description", "output": "The FissionYieldDistribution class energy-dependent fission product yields for a single nuclide can be used as a dictionary mapping energies and products to fission yields:: >>> fydist = fissionyielddistribution( ... {0.0253: {\"xe135\": 0.021}}) >>> fydist[0.0253][\"xe135\"] 0.021. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the fission_yields parameter do when creating a FissionYieldDistribution?", "input": "OpenMC Python API FissionYieldDistribution constructor parameter fission_yields", "output": "When creating a FissionYieldDistribution, the fission_yields parameter specifies dictionary of energies and fission product yields for that energy. expected to be of the form ``{float: {str: float}}``. the first float is the energy, typically in ev, that represents this distribution. the underlying dictionary maps fission products to their respective yields.. It should be a dict value." }, { "instruction": "What is the energies attribute of a FissionYieldDistribution?", "input": "OpenMC Python API FissionYieldDistribution attribute energies", "output": "The energies attribute of a FissionYieldDistribution contains energies for which fission yields exist. sorted by increasing energy. It's a tuple value that you can access after creating a FissionYieldDistribution instance." }, { "instruction": "What is the products attribute of a FissionYieldDistribution?", "input": "OpenMC Python API FissionYieldDistribution attribute products", "output": "The products attribute of a FissionYieldDistribution contains fission products produced at all energies. sorted by name.. It's a tuple value that you can access after creating a FissionYieldDistribution instance." }, { "instruction": "What is the yield_matrix attribute of a FissionYieldDistribution?", "input": "OpenMC Python API FissionYieldDistribution attribute yield_matrix", "output": "The yield_matrix attribute of a FissionYieldDistribution contains array ``(n_energy, n_products)`` where ``yield_matrix[g, j]`` is the fission yield of product ``j`` for energy group ``g``. see also -------- * :meth:`from_xml_element` - construction methods * :class:`fissionyield` - class used for storing yields at a given energy. It's a numpy.ndarray value that you can access after creating a FissionYieldDistribution instance." }, { "instruction": "How do you call the __init__() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, fission_yields: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getitem__() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_xml_element() method do in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.from_xml_element() method", "output": "The from_xml_element() method construct a distribution from a depletion chain xml file. It's used for fissionyielddistribution operations." }, { "instruction": "How do you call the from_xml_element() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the element parameter do in the from_xml_element() method?", "input": "OpenMC Python API FissionYieldDistribution.from_xml_element() parameter element", "output": "The element parameter xml element to pull fission yield data from. It should be a lxml.etree._Element value." }, { "instruction": "What does the to_xml_element() method do in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.to_xml_element() method", "output": "The to_xml_element() method write fission yield data to an xml element. It's used for fissionyielddistribution operations." }, { "instruction": "How do you call the to_xml_element() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "What does the root parameter do in the to_xml_element() method?", "input": "OpenMC Python API FissionYieldDistribution.to_xml_element() parameter root", "output": "The root parameter element to write distribution data to. It should be a lxml.etree._Element value." }, { "instruction": "What does the restrict_products() method do in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.restrict_products() method", "output": "The restrict_products() method return a new distribution with select products .. versionadded:: 0.12. It's used for fissionyielddistribution operations." }, { "instruction": "How do you call the restrict_products() method in the FissionYieldDistribution class?", "input": "OpenMC Python API FissionYieldDistribution.restrict_products() method signature", "output": "To call the restrict_products() method, use: def restrict_products(self: Any, possible_products: Any). It takes 2 parameters." }, { "instruction": "What does the possible_products parameter do in the restrict_products() method?", "input": "OpenMC Python API FissionYieldDistribution.restrict_products() parameter possible_products", "output": "The possible_products parameter candidate pool of fission products. existing products not contained here will not exist in the new instance. It should be a iterable of str value." }, { "instruction": "What is the FissionYield class in OpenMC's Python API?", "input": "OpenMC Python API FissionYield class", "output": "The FissionYield class represents mapping for fission yields of a parent at a specific energy separated to support nested dictionary-like behavior for :class:`fissionyielddistribution`, and allowing math operations on a single vector of yields. can in turn be used like a dictionary to fetch fission yields. supports multiplication of a scalar to scale the fission yields and addition of another set of yields. does not support resizing / inserting new products that do not exist. It provides 14 methods and 0 properties for working with fissionyield data in OpenMC." }, { "instruction": "What does the FissionYield class do in OpenMC's Python API?", "input": "OpenMC Python API FissionYield class description", "output": "The FissionYield class mapping for fission yields of a parent at a specific energy separated to support nested dictionary-like behavior for :class:`fissionyielddistribution`, and allowing math operations on a single vector of yields. can in turn be used like a dictionary to fetch fission yields. supports multiplication of a scalar to scale the fission yields and addition of another set of yields. does not support resizing / inserting new products that do not exist. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the products parameter do when creating a FissionYield?", "input": "OpenMC Python API FissionYield constructor parameter products", "output": "When creating a FissionYield, the products parameter specifies sorted products for this specific distribution. It should be a tuple of str value." }, { "instruction": "What does the yields parameter do when creating a FissionYield?", "input": "OpenMC Python API FissionYield constructor parameter yields", "output": "When creating a FissionYield, the yields parameter specifies fission product yields for each product in ``products``. It should be a numpy.ndarray value." }, { "instruction": "What is the products attribute of a FissionYield?", "input": "OpenMC Python API FissionYield attribute products", "output": "The products attribute of a FissionYield contains products for this specific distribution. It's a tuple of str value that you can access after creating a FissionYield instance." }, { "instruction": "What is the yields attribute of a FissionYield?", "input": "OpenMC Python API FissionYield attribute yields", "output": "The yields attribute of a FissionYield contains fission product yields for each product in ``products``. It's a numpy.ndarray value that you can access after creating a FissionYield instance." }, { "instruction": "How do you call the __init__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, products: Any, yields: Any). It takes 3 parameters." }, { "instruction": "How do you call the __contains__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, product: Any). It takes 2 parameters." }, { "instruction": "How do you call the __getitem__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, product: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __iter__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "What does the items() method do in the FissionYield class?", "input": "OpenMC Python API FissionYield.items() method", "output": "The items() method return pairs of product, yield. It's used for fissionyield operations." }, { "instruction": "How do you call the items() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.items() method signature", "output": "To call the items() method, use: def items(self: Any). It takes 1 parameters." }, { "instruction": "What does the __add__() method do in the FissionYield class?", "input": "OpenMC Python API FissionYield.__add__() method", "output": "The __add__() method add one set of fission yields to this set, return new yields. It's used for fissionyield operations." }, { "instruction": "How do you call the __add__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__add__() method signature", "output": "To call the __add__() method, use: def __add__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the __iadd__() method do in the FissionYield class?", "input": "OpenMC Python API FissionYield.__iadd__() method", "output": "The __iadd__() method increment value from other fission yield. It's used for fissionyield operations." }, { "instruction": "How do you call the __iadd__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__iadd__() method signature", "output": "To call the __iadd__() method, use: def __iadd__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __radd__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__radd__() method signature", "output": "To call the __radd__() method, use: def __radd__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the __imul__() method do in the FissionYield class?", "input": "OpenMC Python API FissionYield.__imul__() method", "output": "The __imul__() method scale these fission yields by a real scalar. It's used for fissionyield operations." }, { "instruction": "How do you call the __imul__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__imul__() method signature", "output": "To call the __imul__() method, use: def __imul__(self: Any, scalar: Any). It takes 2 parameters." }, { "instruction": "What does the __mul__() method do in the FissionYield class?", "input": "OpenMC Python API FissionYield.__mul__() method", "output": "The __mul__() method return a new set of yields scaled by a real scalar. It's used for fissionyield operations." }, { "instruction": "How do you call the __mul__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__mul__() method signature", "output": "To call the __mul__() method, use: def __mul__(self: Any, scalar: Any). It takes 2 parameters." }, { "instruction": "How do you call the __rmul__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__rmul__() method signature", "output": "To call the __rmul__() method, use: def __rmul__(self: Any, scalar: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the FissionYield class?", "input": "OpenMC Python API FissionYield.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What is the OpenMCOperator class in OpenMC's Python API?", "input": "OpenMC Python API OpenMCOperator class", "output": "The OpenMCOperator class represents abstract class holding openmc-specific functions for running depletion calculations. specific classes for running transport-coupled or transport-independent depletion calculations are implemented as subclasses of openmcoperator. It provides 16 methods and 0 properties for working with openmcoperator data in OpenMC." }, { "instruction": "What does the OpenMCOperator class do in OpenMC's Python API?", "input": "OpenMC Python API OpenMCOperator class description", "output": "The OpenMCOperator class abstract class holding openmc-specific functions for running depletion calculations. specific classes for running transport-coupled or transport-independent depletion calculations are implemented as subclasses of openmcoperator. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the materials parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter materials", "output": "When creating a OpenMCOperator, the materials parameter specifies list of all materials in the model. It should be a openmc.Materials value." }, { "instruction": "What does the cross_sections parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter cross_sections", "output": "When creating a OpenMCOperator, the cross_sections parameter specifies path to continuous energy cross section library, or list of objects containing cross sections.. It should be a str or list of MicroXS value." }, { "instruction": "What does the chain_file parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter chain_file", "output": "When creating a OpenMCOperator, the chain_file parameter specifies path to the depletion chain xml file. defaults to openmc.config['chain_file'].. It should be a str, optional value." }, { "instruction": "What does the prev_results parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter prev_results", "output": "When creating a OpenMCOperator, the prev_results parameter specifies results from a previous depletion calculation. if this argument is specified, the depletion calculation will start from the latest state in the previous results.. It should be a Results, optional value." }, { "instruction": "What does the diff_burnable_mats parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter diff_burnable_mats", "output": "When creating a OpenMCOperator, the diff_burnable_mats parameter specifies whether to differentiate burnable materials with multiple instances.. It should be a bool, optional value." }, { "instruction": "What does the fission_q parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter fission_q", "output": "When creating a OpenMCOperator, the fission_q parameter specifies dictionary of nuclides and their fission q values [ev].. It should be a dict, optional value." }, { "instruction": "What does the helper_kwargs parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter helper_kwargs", "output": "When creating a OpenMCOperator, the helper_kwargs parameter specifies keyword arguments for helper classes. It should be a dict value." }, { "instruction": "What does the reduce_chain_level parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter reduce_chain_level", "output": "When creating a OpenMCOperator, the reduce_chain_level parameter specifies depth of the search when reducing the depletion chain. the default value of ``none`` implies no limit on the depth.. It should be a int, optional value." }, { "instruction": "What does the diff_volume_method parameter do when creating a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator constructor parameter diff_volume_method", "output": "When creating a OpenMCOperator, the diff_volume_method parameter specifies specifies how the volumes of the new materials should be found. default is to 'divide equally' which divides the original material volume equally between the new materials, 'match cell' sets the volume of the material to volume of the cell they fill. .. versionadded:: 0.14.0. It should be a str value." }, { "instruction": "What is the materials attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute materials", "output": "The materials attribute of a OpenMCOperator contains all materials present in the model. It's a openmc.Materials value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the cross_sections attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute cross_sections", "output": "The cross_sections attribute of a OpenMCOperator contains path to continuous energy cross section library, or list of objects containing cross sections.. It's a str or list of MicroXS value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the output_dir attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute output_dir", "output": "The output_dir attribute of a OpenMCOperator contains path to output directory to save results.. It's a pathlib.Path value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the round_number attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute round_number", "output": "The round_number attribute of a OpenMCOperator contains whether or not to round output to openmc to 8 digits. useful in testing, as openmc is incredibly sensitive to exact values.. It's a bool value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the number attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute number", "output": "The number attribute of a OpenMCOperator contains total number of atoms in simulation.. It's a openmc.deplete.AtomNumber value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the nuclides_with_data attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute nuclides_with_data", "output": "The nuclides_with_data attribute of a OpenMCOperator contains a set listing all unique nuclides available from cross_sections.xml.. It's a set of str value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the chain attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute chain", "output": "The chain attribute of a OpenMCOperator contains the depletion chain information necessary to form matrices and tallies.. It's a openmc.deplete.Chain value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the reaction_rates attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute reaction_rates", "output": "The reaction_rates attribute of a OpenMCOperator contains reaction rates from the last operator step.. It's a openmc.deplete.ReactionRates value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the burnable_mats attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute burnable_mats", "output": "The burnable_mats attribute of a OpenMCOperator contains all burnable material ids. It's a list of str value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the heavy_metal attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute heavy_metal", "output": "The heavy_metal attribute of a OpenMCOperator contains initial heavy metal inventory [g]. It's a float value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the local_mats attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute local_mats", "output": "The local_mats attribute of a OpenMCOperator contains all burnable material ids being managed by a single process. It's a list of str value that you can access after creating a OpenMCOperator instance." }, { "instruction": "What is the prev_res attribute of a OpenMCOperator?", "input": "OpenMC Python API OpenMCOperator attribute prev_res", "output": "The prev_res attribute of a OpenMCOperator contains results from a previous depletion calculation. ``none`` if no results are to be used.. It's a Results or None value that you can access after creating a OpenMCOperator instance." }, { "instruction": "How do you call the __init__() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, materials: Any, cross_sections: Any, chain_file: Any, prev_results: Any, diff_burnable_mats: Any, diff_volume_method: Any, fission_q: Any, helper_kwargs: Any, reduce_chain_level: Any). It takes 10 parameters." }, { "instruction": "What does the _differentiate_burnable_mats() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._differentiate_burnable_mats() method", "output": "The _differentiate_burnable_mats() method assign distribmats for each burnable material. It's used for openmcoperator operations." }, { "instruction": "How do you call the _differentiate_burnable_mats() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._differentiate_burnable_mats() method signature", "output": "To call the _differentiate_burnable_mats() method, use: def _differentiate_burnable_mats(self: Any). It takes 1 parameters." }, { "instruction": "What does the _get_burnable_mats() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_burnable_mats() method", "output": "The _get_burnable_mats() method determine depletable materials, volumes, and nuclides. It's used for openmcoperator operations." }, { "instruction": "How do you call the _get_burnable_mats() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_burnable_mats() method signature", "output": "To call the _get_burnable_mats() method, use: def _get_burnable_mats(self: Any). It takes 1 parameters." }, { "instruction": "What does the _get_burnable_mats() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_burnable_mats() return value", "output": "The _get_burnable_mats() method returns list of burnable material ids. The return type is list of str." }, { "instruction": "What does the _get_burnable_mats() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_burnable_mats() return value", "output": "The _get_burnable_mats() method returns volume of each material in [cm^3]. The return type is dict of str to float." }, { "instruction": "What does the _get_burnable_mats() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_burnable_mats() return value", "output": "The _get_burnable_mats() method returns nuclides in order of how they'll appear in the simulation.. The return type is list of str." }, { "instruction": "What does the _load_previous_results() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._load_previous_results() method", "output": "The _load_previous_results() method load results from a previous depletion simulation. It's used for openmcoperator operations." }, { "instruction": "How do you call the _load_previous_results() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._load_previous_results() method signature", "output": "To call the _load_previous_results() method, use: def _load_previous_results(self: Any). It takes 1 parameters." }, { "instruction": "What does the _get_nuclides_with_data() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_nuclides_with_data() method", "output": "The _get_nuclides_with_data() method find nuclides with cross section data.. It's used for openmcoperator operations." }, { "instruction": "How do you call the _get_nuclides_with_data() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_nuclides_with_data() method signature", "output": "To call the _get_nuclides_with_data() method, use: @abstractmethod def _get_nuclides_with_data(self: Any, cross_sections: Any). It takes 2 parameters." }, { "instruction": "What does the _extract_number() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._extract_number() method", "output": "The _extract_number() method construct atomnumber using geometry. It's used for openmcoperator operations." }, { "instruction": "How do you call the _extract_number() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._extract_number() method signature", "output": "To call the _extract_number() method, use: def _extract_number(self: Any, local_mats: Any, volume: Any, all_nuclides: Any, prev_res: Any). It takes 5 parameters." }, { "instruction": "What does the local_mats parameter do in the _extract_number() method?", "input": "OpenMC Python API OpenMCOperator._extract_number() parameter local_mats", "output": "The local_mats parameter material ids to be managed by this process. It should be a list of str value." }, { "instruction": "What does the volume parameter do in the _extract_number() method?", "input": "OpenMC Python API OpenMCOperator._extract_number() parameter volume", "output": "The volume parameter volumes for the above materials in [cm^3]. It should be a dict of str to float value." }, { "instruction": "What does the all_nuclides parameter do in the _extract_number() method?", "input": "OpenMC Python API OpenMCOperator._extract_number() parameter all_nuclides", "output": "The all_nuclides parameter nuclides to be used in the simulation.. It should be a list of str value." }, { "instruction": "What does the prev_res parameter do in the _extract_number() method?", "input": "OpenMC Python API OpenMCOperator._extract_number() parameter prev_res", "output": "The prev_res parameter results from a previous depletion calculation. It should be a Results, optional value." }, { "instruction": "What does the _set_number_from_mat() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._set_number_from_mat() method", "output": "The _set_number_from_mat() method extracts material and number densities from openmc.material. It's used for openmcoperator operations." }, { "instruction": "How do you call the _set_number_from_mat() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._set_number_from_mat() method signature", "output": "To call the _set_number_from_mat() method, use: def _set_number_from_mat(self: Any, mat: Any). It takes 2 parameters." }, { "instruction": "What does the mat parameter do in the _set_number_from_mat() method?", "input": "OpenMC Python API OpenMCOperator._set_number_from_mat() parameter mat", "output": "The mat parameter the material to read from. It should be a openmc.Material value." }, { "instruction": "What does the _set_number_from_results() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._set_number_from_results() method", "output": "The _set_number_from_results() method extracts material nuclides and number densities. if the nuclide concentration's evolution is tracked, the densities come from depletion results. else, densities are extracted from the geometry in the summary. It's used for openmcoperator operations." }, { "instruction": "How do you call the _set_number_from_results() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._set_number_from_results() method signature", "output": "To call the _set_number_from_results() method, use: def _set_number_from_results(self: Any, mat: Any, prev_res: Any). It takes 3 parameters." }, { "instruction": "What does the mat parameter do in the _set_number_from_results() method?", "input": "OpenMC Python API OpenMCOperator._set_number_from_results() parameter mat", "output": "The mat parameter the material to read from. It should be a openmc.Material value." }, { "instruction": "What does the prev_res parameter do in the _set_number_from_results() method?", "input": "OpenMC Python API OpenMCOperator._set_number_from_results() parameter prev_res", "output": "The prev_res parameter results from a previous depletion calculation. It should be a Results value." }, { "instruction": "What does the _get_helper_classes() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_helper_classes() method", "output": "The _get_helper_classes() method create the ``_rate_helper``, ``_normalization_helper``, and ``_yield_helper`` objects. It's used for openmcoperator operations." }, { "instruction": "How do you call the _get_helper_classes() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_helper_classes() method signature", "output": "To call the _get_helper_classes() method, use: @abstractmethod def _get_helper_classes(self: Any, helper_kwargs: Any). It takes 2 parameters." }, { "instruction": "What does the helper_kwargs parameter do in the _get_helper_classes() method?", "input": "OpenMC Python API OpenMCOperator._get_helper_classes() parameter helper_kwargs", "output": "The helper_kwargs parameter keyword arguments for helper classes. It should be a dict value." }, { "instruction": "What does the initial_condition() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.initial_condition() method", "output": "The initial_condition() method performs final setup and returns initial condition. It's used for openmcoperator operations." }, { "instruction": "How do you call the initial_condition() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.initial_condition() method signature", "output": "To call the initial_condition() method, use: def initial_condition(self: Any, materials: Any). It takes 2 parameters." }, { "instruction": "What does the materials parameter do in the initial_condition() method?", "input": "OpenMC Python API OpenMCOperator.initial_condition() parameter materials", "output": "The materials parameter list of materials. It should be a list of openmc.lib.Material value." }, { "instruction": "What does the _update_materials_and_nuclides() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._update_materials_and_nuclides() method", "output": "The _update_materials_and_nuclides() method update the number density, material compositions, and nuclide lists in helper objects. It's used for openmcoperator operations." }, { "instruction": "How do you call the _update_materials_and_nuclides() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._update_materials_and_nuclides() method signature", "output": "To call the _update_materials_and_nuclides() method, use: def _update_materials_and_nuclides(self: Any, vec: Any). It takes 2 parameters." }, { "instruction": "What does the vec parameter do in the _update_materials_and_nuclides() method?", "input": "OpenMC Python API OpenMCOperator._update_materials_and_nuclides() parameter vec", "output": "The vec parameter total atoms.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the _update_materials() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._update_materials() method", "output": "The _update_materials() method updates material compositions in openmc on all processes.. It's used for openmcoperator operations." }, { "instruction": "How do you call the _update_materials() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._update_materials() method signature", "output": "To call the _update_materials() method, use: @abstractmethod def _update_materials(self: Any). It takes 1 parameters." }, { "instruction": "What does the write_bos_data() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.write_bos_data() method", "output": "The write_bos_data() method document beginning of step data for a given step called at the beginning of a depletion step and at the final point in the simulation. It's used for openmcoperator operations." }, { "instruction": "How do you call the write_bos_data() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.write_bos_data() method signature", "output": "To call the write_bos_data() method, use: def write_bos_data(self: Any, step: Any). It takes 2 parameters." }, { "instruction": "What does the step parameter do in the write_bos_data() method?", "input": "OpenMC Python API OpenMCOperator.write_bos_data() parameter step", "output": "The step parameter current depletion step including restarts. It should be a int value." }, { "instruction": "What does the _get_reaction_nuclides() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_reaction_nuclides() method", "output": "The _get_reaction_nuclides() method determine nuclides that should be tallied for reaction rates. this method returns a list of all nuclides that have cross section data and are listed in the depletion chain. technically, we should count nuclides that may not appear in the depletion chain because we still need to get the fission reaction rate for these nuclides in order to normalize power, but that is left as a future exercise. It's used for openmcoperator operations." }, { "instruction": "How do you call the _get_reaction_nuclides() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._get_reaction_nuclides() method signature", "output": "To call the _get_reaction_nuclides() method, use: def _get_reaction_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the _calculate_reaction_rates() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._calculate_reaction_rates() method", "output": "The _calculate_reaction_rates() method unpack tallies from openmc and return an operator result this method uses openmc's c api bindings to determine the k-effective value and reaction rates from the simulation. the reaction rates are normalized by a helper class depending on the method being used. It's used for openmcoperator operations." }, { "instruction": "How do you call the _calculate_reaction_rates() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._calculate_reaction_rates() method signature", "output": "To call the _calculate_reaction_rates() method, use: def _calculate_reaction_rates(self: Any, source_rate: Any). It takes 2 parameters." }, { "instruction": "What does the source_rate parameter do in the _calculate_reaction_rates() method?", "input": "OpenMC Python API OpenMCOperator._calculate_reaction_rates() parameter source_rate", "output": "The source_rate parameter power in [w] or source rate in [neutron/sec]. It should be a float value." }, { "instruction": "What does the _calculate_reaction_rates() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator._calculate_reaction_rates() return value", "output": "The _calculate_reaction_rates() method returns reaction rates for nuclides. The return type is openmc.deplete.ReactionRates." }, { "instruction": "What does the get_results_info() method do in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.get_results_info() method", "output": "The get_results_info() method returns volume list, material lists, and nuc lists. It's used for openmcoperator operations." }, { "instruction": "How do you call the get_results_info() method in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.get_results_info() method signature", "output": "To call the get_results_info() method, use: def get_results_info(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_results_info() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.get_results_info() return value", "output": "The get_results_info() method returns volumes corresponding to materials in full_burn_dict. The return type is dict of str float." }, { "instruction": "What does the get_results_info() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.get_results_info() return value", "output": "The get_results_info() method returns a list of all nuclide names. used for sorting the simulation.. The return type is list of str." }, { "instruction": "What does the get_results_info() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.get_results_info() return value", "output": "The get_results_info() method returns a list of all material ids to be burned. used for sorting the simulation.. The return type is list of int." }, { "instruction": "What does the get_results_info() method return in the OpenMCOperator class?", "input": "OpenMC Python API OpenMCOperator.get_results_info() return value", "output": "The get_results_info() method returns list of all burnable material ids. The return type is list." }, { "instruction": "What does the _distribute() function do in OpenMC's Python API?", "input": "OpenMC Python API _distribute() function", "output": "The _distribute() function distribute items across mpi communicator. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _distribute() function in OpenMC's Python API?", "input": "OpenMC Python API _distribute() function purpose", "output": "The _distribute() function distribute items across mpi communicator. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _distribute() function in OpenMC's Python API?", "input": "OpenMC Python API _distribute() function signature", "output": "To call the _distribute() function, use: def _distribute(items: Any). It takes 1 parameters." }, { "instruction": "What does the items parameter do in the _distribute() function?", "input": "OpenMC Python API _distribute() parameter items", "output": "The items parameter list of items of distribute. It should be a list value." }, { "instruction": "What does the deplete() function do in OpenMC's Python API?", "input": "OpenMC Python API deplete() function", "output": "The deplete() function deplete materials using given reaction rates for a specified time. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the deplete() function in OpenMC's Python API?", "input": "OpenMC Python API deplete() function purpose", "output": "The deplete() function deplete materials using given reaction rates for a specified time. It's part of OpenMC's Python API." }, { "instruction": "How do you call the deplete() function in OpenMC's Python API?", "input": "OpenMC Python API deplete() function signature", "output": "To call the deplete() function, use: def deplete(func: Any, chain: Any, n: Any, rates: Any, dt: Any, matrix_func: Any, transfer_rates: Any). It takes 7 parameters." }, { "instruction": "What does the func parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter func", "output": "The func parameter function to use to get new compositions. expected to have the signature ``func(a, n0, t) -> n1``. It should be a callable value." }, { "instruction": "What does the chain parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter chain", "output": "The chain parameter depletion chain. It should be a openmc.deplete.Chain value." }, { "instruction": "What does the n parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter n", "output": "The n parameter list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. It should be a list of numpy.ndarray value." }, { "instruction": "What does the rates parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter rates", "output": "The rates parameter reaction rates (from transport operator). It should be a openmc.deplete.ReactionRates value." }, { "instruction": "What does the dt parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter dt", "output": "The dt parameter time in [s] to deplete for. It should be a float value." }, { "instruction": "What does the maxtrix_func parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter maxtrix_func", "output": "The maxtrix_func parameter function to form the depletion matrix after calling ``matrix_func(chain, rates, fission_yields)``, where ``fission_yields = {parent: {product: yield_frac}}`` expected to return the depletion matrix required by ``func``. It should be a callable, optional value." }, { "instruction": "What does the transfer_rates parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter transfer_rates", "output": "The transfer_rates parameter object to perform continuous reprocessing. .. versionadded:: 0.14.0. It should be a openmc.deplete.TransferRates, Optional value." }, { "instruction": "What does the matrix_args parameter do in the deplete() function?", "input": "OpenMC Python API deplete() parameter matrix_args", "output": "The matrix_args parameter additional arguments passed to matrix_func. It should be a Any, optional value." }, { "instruction": "What does the deplete() function return in OpenMC's Python API?", "input": "OpenMC Python API deplete() return value", "output": "The deplete() function returns updated list of atom number arrays for each material. each array in the list contains the number of [atom] of each nuclide.. The return type is list of numpy.ndarray." }, { "instruction": "What is the ReactionRates class in OpenMC's Python API?", "input": "OpenMC Python API ReactionRates class", "output": "The ReactionRates class represents reaction rates resulting from a transport operator call this class is a subclass of :class:`numpy.ndarray` with a few custom attributes that make it easy to determine what index corresponds to a given material, nuclide, and reaction rate. It provides 9 methods and 0 properties for working with reactionrates data in OpenMC." }, { "instruction": "What does the ReactionRates class do in OpenMC's Python API?", "input": "OpenMC Python API ReactionRates class description", "output": "The ReactionRates class reaction rates resulting from a transport operator call this class is a subclass of :class:`numpy.ndarray` with a few custom attributes that make it easy to determine what index corresponds to a given material, nuclide, and reaction rate. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the local_mats parameter do when creating a ReactionRates?", "input": "OpenMC Python API ReactionRates constructor parameter local_mats", "output": "When creating a ReactionRates, the local_mats parameter specifies material ids. It should be a list of str value." }, { "instruction": "What does the nuclides parameter do when creating a ReactionRates?", "input": "OpenMC Python API ReactionRates constructor parameter nuclides", "output": "When creating a ReactionRates, the nuclides parameter specifies depletable nuclides. It should be a list of str value." }, { "instruction": "What does the reactions parameter do when creating a ReactionRates?", "input": "OpenMC Python API ReactionRates constructor parameter reactions", "output": "When creating a ReactionRates, the reactions parameter specifies transmutation reactions being tracked. It should be a list of str value." }, { "instruction": "What does the from_results parameter do when creating a ReactionRates?", "input": "OpenMC Python API ReactionRates constructor parameter from_results", "output": "When creating a ReactionRates, the from_results parameter specifies if the reaction rates are loaded from results, indexing dictionaries need to be kept the same.. It should be a boolean value." }, { "instruction": "What is the index_mat attribute of a ReactionRates?", "input": "OpenMC Python API ReactionRates attribute index_mat", "output": "The index_mat attribute of a ReactionRates contains a dictionary mapping material id as string to index.. It's a dict of str to int value that you can access after creating a ReactionRates instance." }, { "instruction": "What is the index_nuc attribute of a ReactionRates?", "input": "OpenMC Python API ReactionRates attribute index_nuc", "output": "The index_nuc attribute of a ReactionRates contains a dictionary mapping nuclide name as string to index.. It's a dict of str to int value that you can access after creating a ReactionRates instance." }, { "instruction": "What is the index_rx attribute of a ReactionRates?", "input": "OpenMC Python API ReactionRates attribute index_rx", "output": "The index_rx attribute of a ReactionRates contains a dictionary mapping reaction name as string to index.. It's a dict of str to int value that you can access after creating a ReactionRates instance." }, { "instruction": "What is the n_mat attribute of a ReactionRates?", "input": "OpenMC Python API ReactionRates attribute n_mat", "output": "The n_mat attribute of a ReactionRates contains number of materials.. It's a int value that you can access after creating a ReactionRates instance." }, { "instruction": "What is the n_nuc attribute of a ReactionRates?", "input": "OpenMC Python API ReactionRates attribute n_nuc", "output": "The n_nuc attribute of a ReactionRates contains number of nucs.. It's a int value that you can access after creating a ReactionRates instance." }, { "instruction": "What is the n_react attribute of a ReactionRates?", "input": "OpenMC Python API ReactionRates attribute n_react", "output": "The n_react attribute of a ReactionRates contains number of reactions.. It's a int value that you can access after creating a ReactionRates instance." }, { "instruction": "How do you call the __new__() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, local_mats: Any, nuclides: Any, reactions: Any, from_results: Any). It takes 5 parameters." }, { "instruction": "How do you call the __array_finalize__() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.__array_finalize__() method signature", "output": "To call the __array_finalize__() method, use: def __array_finalize__(self: Any, obj: Any). It takes 2 parameters." }, { "instruction": "How do you call the __reduce__() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.__reduce__() method signature", "output": "To call the __reduce__() method, use: def __reduce__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __setstate__() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.__setstate__() method signature", "output": "To call the __setstate__() method, use: def __setstate__(self: Any, state: Any). It takes 2 parameters." }, { "instruction": "How do you call the n_mat() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.n_mat() method signature", "output": "To call the n_mat() method, use: @property def n_mat(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_nuc() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.n_nuc() method signature", "output": "To call the n_nuc() method, use: @property def n_nuc(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_react() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.n_react() method signature", "output": "To call the n_react() method, use: @property def n_react(self: Any). It takes 1 parameters." }, { "instruction": "What does the get() method do in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.get() method", "output": "The get() method get reaction rate by material/nuclide/reaction. It's used for reactionrates operations." }, { "instruction": "How do you call the get() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.get() method signature", "output": "To call the get() method, use: def get(self: Any, mat: Any, nuc: Any, rx: Any). It takes 4 parameters." }, { "instruction": "What does the mat parameter do in the get() method?", "input": "OpenMC Python API ReactionRates.get() parameter mat", "output": "The mat parameter material id as a string. It should be a str value." }, { "instruction": "What does the nuc parameter do in the get() method?", "input": "OpenMC Python API ReactionRates.get() parameter nuc", "output": "The nuc parameter nuclide name. It should be a str value." }, { "instruction": "What does the rx parameter do in the get() method?", "input": "OpenMC Python API ReactionRates.get() parameter rx", "output": "The rx parameter name of the reaction. It should be a str value." }, { "instruction": "What does the set() method do in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.set() method", "output": "The set() method set reaction rate by material/nuclide/reaction. It's used for reactionrates operations." }, { "instruction": "How do you call the set() method in the ReactionRates class?", "input": "OpenMC Python API ReactionRates.set() method signature", "output": "To call the set() method, use: def set(self: Any, mat: Any, nuc: Any, rx: Any, value: Any). It takes 5 parameters." }, { "instruction": "What does the mat parameter do in the set() method?", "input": "OpenMC Python API ReactionRates.set() parameter mat", "output": "The mat parameter material id as a string. It should be a str value." }, { "instruction": "What does the nuc parameter do in the set() method?", "input": "OpenMC Python API ReactionRates.set() parameter nuc", "output": "The nuc parameter nuclide name. It should be a str value." }, { "instruction": "What does the rx parameter do in the set() method?", "input": "OpenMC Python API ReactionRates.set() parameter rx", "output": "The rx parameter name of the reaction. It should be a str value." }, { "instruction": "What does the value parameter do in the set() method?", "input": "OpenMC Python API ReactionRates.set() parameter value", "output": "The value parameter corresponding reaction rate to set. It should be a float value." }, { "instruction": "What is the Results class in OpenMC's Python API?", "input": "OpenMC Python API Results class", "output": "The Results class represents results from a depletion simulation the :class:`results` class acts as a list that stores the results from each depletion step and provides extra methods for interrogating these results. .. versionchanged:: 0.13.1 name changed from ``resultslist`` to ``results``. It provides 14 methods and 0 properties for working with results data in OpenMC." }, { "instruction": "What does the Results class do in OpenMC's Python API?", "input": "OpenMC Python API Results class description", "output": "The Results class results from a depletion simulation the :class:`results` class acts as a list that stores the results from each depletion step and provides extra methods for interrogating these results. .. versionchanged:: 0.13.1 name changed from ``resultslist`` to ``results``. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filename parameter do when creating a Results?", "input": "OpenMC Python API Results constructor parameter filename", "output": "When creating a Results, the filename parameter specifies path to depletion result file. It should be a str, optional value." }, { "instruction": "How do you call the __init__() method in the Results class?", "input": "OpenMC Python API Results.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the from_hdf5() method do in the Results class?", "input": "OpenMC Python API Results.from_hdf5() method", "output": "The from_hdf5() method load in depletion results from a previous file. It's used for results operations." }, { "instruction": "How do you call the from_hdf5() method in the Results class?", "input": "OpenMC Python API Results.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, filename: PathLike). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the from_hdf5() method?", "input": "OpenMC Python API Results.from_hdf5() parameter filename", "output": "The filename parameter path to depletion result file. It should be a str value." }, { "instruction": "What does the get_activity() method do in the Results class?", "input": "OpenMC Python API Results.get_activity() method", "output": "The get_activity() method get activity of material over time. .. versionadded:: 0.14.0. It's used for results operations." }, { "instruction": "How do you call the get_activity() method in the Results class?", "input": "OpenMC Python API Results.get_activity() method signature", "output": "To call the get_activity() method, use: def get_activity(self: Any, mat: Any, units: str, by_nuclide: bool, volume: Any). It takes 5 parameters." }, { "instruction": "What does the mat parameter do in the get_activity() method?", "input": "OpenMC Python API Results.get_activity() parameter mat", "output": "The mat parameter material object or material id to evaluate. It should be a openmc.Material, str value." }, { "instruction": "What does the units parameter do in the get_activity() method?", "input": "OpenMC Python API Results.get_activity() parameter units", "output": "The units parameter specifies the type of activity to return, options include total activity [bq], specific [bq/g, bq/kg] or volumetric activity [bq/cm3].. It should be a {'Bq', 'Bq/g', 'Bq/kg', 'Bq/cm3'} value." }, { "instruction": "What does the by_nuclide parameter do in the get_activity() method?", "input": "OpenMC Python API Results.get_activity() parameter by_nuclide", "output": "The by_nuclide parameter specifies if the activity should be returned for the material as a whole or per nuclide. default is false.. It should be a bool value." }, { "instruction": "What does the volume parameter do in the get_activity() method?", "input": "OpenMC Python API Results.get_activity() parameter volume", "output": "The volume parameter volume of the material. if not passed, defaults to using the :attr:`material.volume` attribute.. It should be a float, optional value." }, { "instruction": "What does the get_activity() method return in the Results class?", "input": "OpenMC Python API Results.get_activity() return value", "output": "The get_activity() method returns array of times in [s]. The return type is numpy.ndarray." }, { "instruction": "What does the get_activity() method return in the Results class?", "input": "OpenMC Python API Results.get_activity() return value", "output": "The get_activity() method returns array of total activities if by_nuclide = false (default) or list of dictionaries of activities by nuclide if by_nuclide = true.. The return type is numpy.ndarray or List[dict]." }, { "instruction": "What does the get_atoms() method do in the Results class?", "input": "OpenMC Python API Results.get_atoms() method", "output": "The get_atoms() method get number of nuclides over time from a single material. It's used for results operations." }, { "instruction": "How do you call the get_atoms() method in the Results class?", "input": "OpenMC Python API Results.get_atoms() method signature", "output": "To call the get_atoms() method, use: def get_atoms(self: Any, mat: Any, nuc: str, nuc_units: str, time_units: str). It takes 5 parameters." }, { "instruction": "What does the mat parameter do in the get_atoms() method?", "input": "OpenMC Python API Results.get_atoms() parameter mat", "output": "The mat parameter material object or material id to evaluate. It should be a openmc.Material, str value." }, { "instruction": "What does the nuc parameter do in the get_atoms() method?", "input": "OpenMC Python API Results.get_atoms() parameter nuc", "output": "The nuc parameter nuclide name to evaluate. It should be a str value." }, { "instruction": "What does the nuc_units parameter do in the get_atoms() method?", "input": "OpenMC Python API Results.get_atoms() parameter nuc_units", "output": "The nuc_units parameter units for the returned concentration. default is ``\"atoms\"`` .. versionadded:: 0.12. It should be a {\"atoms\", \"atom/b-cm\", \"atom/cm3\"}, optional value." }, { "instruction": "What does the time_units parameter do in the get_atoms() method?", "input": "OpenMC Python API Results.get_atoms() parameter time_units", "output": "The time_units parameter units for the returned time array. default is ``\"s\"`` to return the value in seconds. other options are minutes ``\"min\"``, hours ``\"h\"``, days ``\"d\"``, and julian years ``\"a\"``. .. versionadded:: 0.12. It should be a {\"s\", \"min\", \"h\", \"d\", \"a\"}, optional value." }, { "instruction": "What does the get_atoms() method return in the Results class?", "input": "OpenMC Python API Results.get_atoms() return value", "output": "The get_atoms() method returns array of times in units of ``time_units``. The return type is numpy.ndarray." }, { "instruction": "What does the get_atoms() method return in the Results class?", "input": "OpenMC Python API Results.get_atoms() return value", "output": "The get_atoms() method returns concentration of specified nuclide in units of ``nuc_units``. The return type is numpy.ndarray." }, { "instruction": "What does the get_decay_heat() method do in the Results class?", "input": "OpenMC Python API Results.get_decay_heat() method", "output": "The get_decay_heat() method get decay heat of material over time. .. versionadded:: 0.14.0. It's used for results operations." }, { "instruction": "How do you call the get_decay_heat() method in the Results class?", "input": "OpenMC Python API Results.get_decay_heat() method signature", "output": "To call the get_decay_heat() method, use: def get_decay_heat(self: Any, mat: Any, units: str, by_nuclide: bool, volume: Any). It takes 5 parameters." }, { "instruction": "What does the mat parameter do in the get_decay_heat() method?", "input": "OpenMC Python API Results.get_decay_heat() parameter mat", "output": "The mat parameter material object or material id to evaluate.. It should be a openmc.Material, str value." }, { "instruction": "What does the units parameter do in the get_decay_heat() method?", "input": "OpenMC Python API Results.get_decay_heat() parameter units", "output": "The units parameter specifies the units of decay heat to return. options include total heat [w], specific [w/g, w/kg] or volumetric heat [w/cm3].. It should be a {'W', 'W/g', 'W/kg', 'W/cm3'} value." }, { "instruction": "What does the by_nuclide parameter do in the get_decay_heat() method?", "input": "OpenMC Python API Results.get_decay_heat() parameter by_nuclide", "output": "The by_nuclide parameter specifies if the decay heat should be returned for the material as a whole or per nuclide. default is false.. It should be a bool value." }, { "instruction": "What does the volume parameter do in the get_decay_heat() method?", "input": "OpenMC Python API Results.get_decay_heat() parameter volume", "output": "The volume parameter volume of the material. if not passed, defaults to using the :attr:`material.volume` attribute.. It should be a float, optional value." }, { "instruction": "What does the get_decay_heat() method return in the Results class?", "input": "OpenMC Python API Results.get_decay_heat() return value", "output": "The get_decay_heat() method returns array of times in [s]. The return type is numpy.ndarray." }, { "instruction": "What does the get_decay_heat() method return in the Results class?", "input": "OpenMC Python API Results.get_decay_heat() return value", "output": "The get_decay_heat() method returns array of total decay heat values if by_nuclide = false (default) or list of dictionaries of decay heat values by nuclide if by_nuclide = true.. The return type is numpy.ndarray or list[dict]." }, { "instruction": "What does the get_mass() method do in the Results class?", "input": "OpenMC Python API Results.get_mass() method", "output": "The get_mass() method get mass of nuclides over time from a single material .. versionadded:: 0.14.0. It's used for results operations." }, { "instruction": "How do you call the get_mass() method in the Results class?", "input": "OpenMC Python API Results.get_mass() method signature", "output": "To call the get_mass() method, use: def get_mass(self: Any, mat: Any, nuc: str, mass_units: str, time_units: str). It takes 5 parameters." }, { "instruction": "What does the mat parameter do in the get_mass() method?", "input": "OpenMC Python API Results.get_mass() parameter mat", "output": "The mat parameter material object or material id to evaluate. It should be a openmc.Material, str value." }, { "instruction": "What does the nuc parameter do in the get_mass() method?", "input": "OpenMC Python API Results.get_mass() parameter nuc", "output": "The nuc parameter nuclide name to evaluate. It should be a str value." }, { "instruction": "What does the mass_units parameter do in the get_mass() method?", "input": "OpenMC Python API Results.get_mass() parameter mass_units", "output": "The mass_units parameter units for the returned mass.. It should be a {\"g\", \"g/cm3\", \"kg\"}, optional value." }, { "instruction": "What does the time_units parameter do in the get_mass() method?", "input": "OpenMC Python API Results.get_mass() parameter time_units", "output": "The time_units parameter units for the returned time array. default is ``\"s\"`` to return the value in seconds. other options are minutes ``\"min\"``, hours ``\"h\"``, days ``\"d\"``, and julian years ``\"a\"``.. It should be a {\"s\", \"min\", \"h\", \"d\", \"a\"}, optional value." }, { "instruction": "What does the get_mass() method return in the Results class?", "input": "OpenMC Python API Results.get_mass() return value", "output": "The get_mass() method returns array of times in units of ``time_units``. The return type is numpy.ndarray." }, { "instruction": "What does the get_mass() method return in the Results class?", "input": "OpenMC Python API Results.get_mass() return value", "output": "The get_mass() method returns mass of specified nuclide in units of ``mass_units``. The return type is numpy.ndarray." }, { "instruction": "What does the get_reaction_rate() method do in the Results class?", "input": "OpenMC Python API Results.get_reaction_rate() method", "output": "The get_reaction_rate() method get reaction rate in a single material/nuclide over time. It's used for results operations." }, { "instruction": "How do you call the get_reaction_rate() method in the Results class?", "input": "OpenMC Python API Results.get_reaction_rate() method signature", "output": "To call the get_reaction_rate() method, use: def get_reaction_rate(self: Any, mat: Any, nuc: str, rx: str). It takes 4 parameters." }, { "instruction": "What does the mat parameter do in the get_reaction_rate() method?", "input": "OpenMC Python API Results.get_reaction_rate() parameter mat", "output": "The mat parameter material object or material id to evaluate. It should be a openmc.Material, str value." }, { "instruction": "What does the nuc parameter do in the get_reaction_rate() method?", "input": "OpenMC Python API Results.get_reaction_rate() parameter nuc", "output": "The nuc parameter nuclide name to evaluate. It should be a str value." }, { "instruction": "What does the rx parameter do in the get_reaction_rate() method?", "input": "OpenMC Python API Results.get_reaction_rate() parameter rx", "output": "The rx parameter reaction rate to evaluate. It should be a str value." }, { "instruction": "What does the get_reaction_rate() method return in the Results class?", "input": "OpenMC Python API Results.get_reaction_rate() return value", "output": "The get_reaction_rate() method returns array of times in [s]. The return type is numpy.ndarray." }, { "instruction": "What does the get_reaction_rate() method return in the Results class?", "input": "OpenMC Python API Results.get_reaction_rate() return value", "output": "The get_reaction_rate() method returns array of reaction rates. The return type is numpy.ndarray." }, { "instruction": "What does the get_keff() method do in the Results class?", "input": "OpenMC Python API Results.get_keff() method", "output": "The get_keff() method evaluates the eigenvalue from a results list. .. versionadded:: 0.13.1. It's used for results operations." }, { "instruction": "How do you call the get_keff() method in the Results class?", "input": "OpenMC Python API Results.get_keff() method signature", "output": "To call the get_keff() method, use: def get_keff(self: Any, time_units: str). It takes 2 parameters." }, { "instruction": "What does the time_units parameter do in the get_keff() method?", "input": "OpenMC Python API Results.get_keff() parameter time_units", "output": "The time_units parameter desired units for the times array. options are seconds ``\"s\"``, minutes ``\"min\"``, hours ``\"h\"``, days ``\"d\"``, and julian years ``\"a\"``.. It should be a {\"s\", \"d\", \"min\", \"h\", \"a\"}, optional value." }, { "instruction": "What does the get_keff() method return in the Results class?", "input": "OpenMC Python API Results.get_keff() return value", "output": "The get_keff() method returns array of times in specified units. The return type is numpy.ndarray." }, { "instruction": "What does the get_keff() method return in the Results class?", "input": "OpenMC Python API Results.get_keff() return value", "output": "The get_keff() method returns k-eigenvalue at each time. column 0 contains the eigenvalue, while column 1 contains the associated uncertainty. The return type is numpy.ndarray." }, { "instruction": "How do you call the get_eigenvalue() method in the Results class?", "input": "OpenMC Python API Results.get_eigenvalue() method signature", "output": "To call the get_eigenvalue() method, use: def get_eigenvalue(self: Any, time_units: str). It takes 2 parameters." }, { "instruction": "What does the get_depletion_time() method do in the Results class?", "input": "OpenMC Python API Results.get_depletion_time() method", "output": "The get_depletion_time() method return an array of the average time to deplete a material .. note:: the return value will have one fewer values than several other methods, such as :meth:`get_keff`, because no depletion is performed at the final transport stage. It's used for results operations." }, { "instruction": "How do you call the get_depletion_time() method in the Results class?", "input": "OpenMC Python API Results.get_depletion_time() method signature", "output": "To call the get_depletion_time() method, use: def get_depletion_time(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_depletion_time() method return in the Results class?", "input": "OpenMC Python API Results.get_depletion_time() return value", "output": "The get_depletion_time() method returns vector of average time to deplete a single material across all processes and materials.. The return type is numpy.ndarray." }, { "instruction": "What does the get_times() method do in the Results class?", "input": "OpenMC Python API Results.get_times() method", "output": "The get_times() method return the points in time that define the depletion schedule .. versionadded:: 0.12.1. It's used for results operations." }, { "instruction": "How do you call the get_times() method in the Results class?", "input": "OpenMC Python API Results.get_times() method signature", "output": "To call the get_times() method, use: def get_times(self: Any, time_units: str). It takes 2 parameters." }, { "instruction": "What does the time_units parameter do in the get_times() method?", "input": "OpenMC Python API Results.get_times() parameter time_units", "output": "The time_units parameter return the vector in these units. default is to convert to days ``\"d\"``. other options are seconds ``\"s\"``, minutes ``\"min\"``, hours ``\"h\"``, days ``\"d\"``, and julian years ``\"a\"``.. It should be a {\"s\", \"d\", \"min\", \"h\", \"a\"}, optional value." }, { "instruction": "What does the get_source_rates() method do in the Results class?", "input": "OpenMC Python API Results.get_source_rates() method", "output": "The get_source_rates() method .. versionadded:: 0.15.1. It's used for results operations." }, { "instruction": "How do you call the get_source_rates() method in the Results class?", "input": "OpenMC Python API Results.get_source_rates() method signature", "output": "To call the get_source_rates() method, use: def get_source_rates(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_step_where() method do in the Results class?", "input": "OpenMC Python API Results.get_step_where() method", "output": "The get_step_where() method return the index closest to a given point in time in the event ``time`` lies exactly between two points, the lower index will be returned. it is possible that the index will be at most one past the point in time requested, but only according to tolerances requested. passing ``atol=math.inf`` and ``rtol=math.inf`` will return the closest index to the requested point. .. versionadded:: 0.12.1. It's used for results operations." }, { "instruction": "How do you call the get_step_where() method in the Results class?", "input": "OpenMC Python API Results.get_step_where() method signature", "output": "To call the get_step_where() method, use: def get_step_where(self: Any, time: Any, time_units: str, atol: float, rtol: float). It takes 5 parameters." }, { "instruction": "What does the time parameter do in the get_step_where() method?", "input": "OpenMC Python API Results.get_step_where() parameter time", "output": "The time parameter desired point in time. It should be a float value." }, { "instruction": "What does the time_units parameter do in the get_step_where() method?", "input": "OpenMC Python API Results.get_step_where() parameter time_units", "output": "The time_units parameter units on ``time``. default: days ``\"d\"``. other options are seconds ``\"s\"``, minutes ``\"min\"``, hours ``\"h\"`` and julian years ``\"a\"``.. It should be a {\"s\", \"d\", \"min\", \"h\", \"a\"}, optional value." }, { "instruction": "What does the atol parameter do in the get_step_where() method?", "input": "OpenMC Python API Results.get_step_where() parameter atol", "output": "The atol parameter absolute tolerance (in ``time_units``) if ``time`` is not found.. It should be a float, optional value." }, { "instruction": "What does the rtol parameter do in the get_step_where() method?", "input": "OpenMC Python API Results.get_step_where() parameter rtol", "output": "The rtol parameter relative tolerance if ``time`` is not found.. It should be a float, optional value." }, { "instruction": "What does the export_to_materials() method do in the Results class?", "input": "OpenMC Python API Results.export_to_materials() method", "output": "The export_to_materials() method return openmc.materials object based on results at a given step .. versionadded:: 0.12.1. It's used for results operations." }, { "instruction": "How do you call the export_to_materials() method in the Results class?", "input": "OpenMC Python API Results.export_to_materials() method signature", "output": "To call the export_to_materials() method, use: def export_to_materials(self: Any, burnup_index: int, nuc_with_data: Any, path: PathLike). It takes 4 parameters." }, { "instruction": "What does the burn_index parameter do in the export_to_materials() method?", "input": "OpenMC Python API Results.export_to_materials() parameter burn_index", "output": "The burn_index parameter index of burnup step to evaluate. see also: get_step_where for obtaining burnup step indices from other data such as the time.. It should be a int value." }, { "instruction": "What does the nuc_with_data parameter do in the export_to_materials() method?", "input": "OpenMC Python API Results.export_to_materials() parameter nuc_with_data", "output": "The nuc_with_data parameter nuclides to include in resulting materials. this can be specified if not all nuclides appearing in depletion results have associated neutron cross sections, and as such cannot be used in subsequent transport calculations. if not provided, nuclides from the cross_sections element of materials.xml will be used. if that element is not present, nuclides from openmc.config['cross_sections'] will be used.. It should be a Iterable of str, optional value." }, { "instruction": "What does the path parameter do in the export_to_materials() method?", "input": "OpenMC Python API Results.export_to_materials() parameter path", "output": "The path parameter path to materials xml file to read. defaults to 'materials.xml'. .. versionadded:: 0.13.3. It should be a PathLike value." }, { "instruction": "What does the export_to_materials() method return in the Results class?", "input": "OpenMC Python API Results.export_to_materials() return value", "output": "The export_to_materials() method returns a modified materials instance containing depleted material data and original isotopic compositions of non-depletable materials. The return type is Materials." }, { "instruction": "What does the _get_time_as() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_time_as() function", "output": "The _get_time_as() function converts the time in seconds to time in different units. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_time_as() function in OpenMC's Python API?", "input": "OpenMC Python API _get_time_as() function purpose", "output": "The _get_time_as() function converts the time in seconds to time in different units. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_time_as() function in OpenMC's Python API?", "input": "OpenMC Python API _get_time_as() function signature", "output": "To call the _get_time_as() function, use: def _get_time_as(seconds: float, units: str). It takes 2 parameters." }, { "instruction": "What does the seconds parameter do in the _get_time_as() function?", "input": "OpenMC Python API _get_time_as() parameter seconds", "output": "The seconds parameter the time to convert expressed in seconds. It should be a float value." }, { "instruction": "What does the units parameter do in the _get_time_as() function?", "input": "OpenMC Python API _get_time_as() parameter units", "output": "The units parameter the units to convert time into. available options are seconds ``\"s\"``, minutes ``\"min\"``, hours ``\"h\"`` days ``\"d\"``, julian years ``\"a\"``. It should be a {\"s\", \"min\", \"h\", \"d\", \"a\"} value." }, { "instruction": "What is the StepResult class in OpenMC's Python API?", "input": "OpenMC Python API StepResult class", "output": "The StepResult class represents result of a single depletion timestep .. versionchanged:: 0.13.1 name changed from ``results`` to ``stepresult``. It provides 17 methods and 0 properties for working with stepresult data in OpenMC." }, { "instruction": "What does the StepResult class do in OpenMC's Python API?", "input": "OpenMC Python API StepResult class description", "output": "The StepResult class result of a single depletion timestep .. versionchanged:: 0.13.1 name changed from ``results`` to ``stepresult``. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the k attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute k", "output": "The k attribute of a StepResult contains eigenvalue and uncertainty for each substep.. It's a list of (float, float) value that you can access after creating a StepResult instance." }, { "instruction": "What is the time attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute time", "output": "The time attribute of a StepResult contains time at beginning, end of step, in seconds.. It's a list of float value that you can access after creating a StepResult instance." }, { "instruction": "What is the source_rate attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute source_rate", "output": "The source_rate attribute of a StepResult contains source rate during timestep in [w] or [neutron/sec]. It's a float value that you can access after creating a StepResult instance." }, { "instruction": "What is the n_mat attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute n_mat", "output": "The n_mat attribute of a StepResult contains number of mats.. It's a int value that you can access after creating a StepResult instance." }, { "instruction": "What is the n_nuc attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute n_nuc", "output": "The n_nuc attribute of a StepResult contains number of nuclides.. It's a int value that you can access after creating a StepResult instance." }, { "instruction": "What is the rates attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute rates", "output": "The rates attribute of a StepResult contains the reaction rates for each substep.. It's a list of ReactionRates value that you can access after creating a StepResult instance." }, { "instruction": "What is the volume attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute volume", "output": "The volume attribute of a StepResult contains dictionary mapping mat id to volume.. It's a dict of str to float value that you can access after creating a StepResult instance." }, { "instruction": "What is the index_mat attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute index_mat", "output": "The index_mat attribute of a StepResult contains a dictionary mapping mat id as string to index.. It's a dict of str to int value that you can access after creating a StepResult instance." }, { "instruction": "What is the index_nuc attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute index_nuc", "output": "The index_nuc attribute of a StepResult contains a dictionary mapping nuclide name as string to index.. It's a dict of str to int value that you can access after creating a StepResult instance." }, { "instruction": "What is the mat_to_hdf5_ind attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute mat_to_hdf5_ind", "output": "The mat_to_hdf5_ind attribute of a StepResult contains a dictionary mapping mat id as string to global index.. It's a dict of str to int value that you can access after creating a StepResult instance." }, { "instruction": "What is the n_hdf5_mats attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute n_hdf5_mats", "output": "The n_hdf5_mats attribute of a StepResult contains number of materials in entire geometry.. It's a int value that you can access after creating a StepResult instance." }, { "instruction": "What is the n_stages attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute n_stages", "output": "The n_stages attribute of a StepResult contains number of stages in simulation.. It's a int value that you can access after creating a StepResult instance." }, { "instruction": "What is the data attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute data", "output": "The data attribute of a StepResult contains atom quantity, stored by stage, mat, then by nuclide.. It's a numpy.ndarray value that you can access after creating a StepResult instance." }, { "instruction": "What is the proc_time attribute of a StepResult?", "input": "OpenMC Python API StepResult attribute proc_time", "output": "The proc_time attribute of a StepResult contains average time spent depleting a material across all materials and processes. It's a int value that you can access after creating a StepResult instance." }, { "instruction": "How do you call the __init__() method in the StepResult class?", "input": "OpenMC Python API StepResult.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the StepResult class?", "input": "OpenMC Python API StepResult.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the __getitem__() method do in the StepResult class?", "input": "OpenMC Python API StepResult.__getitem__() method", "output": "The __getitem__() method retrieves an item from results. It's used for stepresult operations." }, { "instruction": "How do you call the __getitem__() method in the StepResult class?", "input": "OpenMC Python API StepResult.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, pos: Any). It takes 2 parameters." }, { "instruction": "What does the pos parameter do in the __getitem__() method?", "input": "OpenMC Python API StepResult.__getitem__() parameter pos", "output": "The pos parameter a three-length tuple containing a stage index, mat index and a nuc index. all can be integers or slices. the second two can be strings corresponding to their respective dictionary.. It should be a tuple value." }, { "instruction": "What does the __setitem__() method do in the StepResult class?", "input": "OpenMC Python API StepResult.__setitem__() method", "output": "The __setitem__() method sets an item from results. It's used for stepresult operations." }, { "instruction": "How do you call the __setitem__() method in the StepResult class?", "input": "OpenMC Python API StepResult.__setitem__() method signature", "output": "To call the __setitem__() method, use: def __setitem__(self: Any, pos: Any, val: Any). It takes 3 parameters." }, { "instruction": "What does the pos parameter do in the __setitem__() method?", "input": "OpenMC Python API StepResult.__setitem__() parameter pos", "output": "The pos parameter a three-length tuple containing a stage index, mat index and a nuc index. all can be integers or slices. the second two can be strings corresponding to their respective dictionary.. It should be a tuple value." }, { "instruction": "What does the val parameter do in the __setitem__() method?", "input": "OpenMC Python API StepResult.__setitem__() parameter val", "output": "The val parameter the value to set data to.. It should be a float value." }, { "instruction": "How do you call the n_mat() method in the StepResult class?", "input": "OpenMC Python API StepResult.n_mat() method signature", "output": "To call the n_mat() method, use: @property def n_mat(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_nuc() method in the StepResult class?", "input": "OpenMC Python API StepResult.n_nuc() method signature", "output": "To call the n_nuc() method, use: @property def n_nuc(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_hdf5_mats() method in the StepResult class?", "input": "OpenMC Python API StepResult.n_hdf5_mats() method signature", "output": "To call the n_hdf5_mats() method, use: @property def n_hdf5_mats(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_stages() method in the StepResult class?", "input": "OpenMC Python API StepResult.n_stages() method signature", "output": "To call the n_stages() method, use: @property def n_stages(self: Any). It takes 1 parameters." }, { "instruction": "What does the allocate() method do in the StepResult class?", "input": "OpenMC Python API StepResult.allocate() method", "output": "The allocate() method allocate memory for depletion step data. It's used for stepresult operations." }, { "instruction": "How do you call the allocate() method in the StepResult class?", "input": "OpenMC Python API StepResult.allocate() method signature", "output": "To call the allocate() method, use: def allocate(self: Any, volume: Any, nuc_list: Any, burn_list: Any, full_burn_list: Any, stages: Any). It takes 6 parameters." }, { "instruction": "What does the volume parameter do in the allocate() method?", "input": "OpenMC Python API StepResult.allocate() parameter volume", "output": "The volume parameter volumes corresponding to materials in full_burn_dict. It should be a dict of str float value." }, { "instruction": "What does the nuc_list parameter do in the allocate() method?", "input": "OpenMC Python API StepResult.allocate() parameter nuc_list", "output": "The nuc_list parameter a list of all nuclide names. used for sorting the simulation.. It should be a list of str value." }, { "instruction": "What does the burn_list parameter do in the allocate() method?", "input": "OpenMC Python API StepResult.allocate() parameter burn_list", "output": "The burn_list parameter a list of all mat ids to be burned. used for sorting the simulation.. It should be a list of int value." }, { "instruction": "What does the full_burn_list parameter do in the allocate() method?", "input": "OpenMC Python API StepResult.allocate() parameter full_burn_list", "output": "The full_burn_list parameter list of all burnable material ids. It should be a list of str value." }, { "instruction": "What does the stages parameter do in the allocate() method?", "input": "OpenMC Python API StepResult.allocate() parameter stages", "output": "The stages parameter number of stages in simulation.. It should be a int value." }, { "instruction": "What does the distribute() method do in the StepResult class?", "input": "OpenMC Python API StepResult.distribute() method", "output": "The distribute() method create a new object containing data for distributed materials. It's used for stepresult operations." }, { "instruction": "How do you call the distribute() method in the StepResult class?", "input": "OpenMC Python API StepResult.distribute() method signature", "output": "To call the distribute() method, use: def distribute(self: Any, local_materials: Any, ranges: Any). It takes 3 parameters." }, { "instruction": "What does the local_materials parameter do in the distribute() method?", "input": "OpenMC Python API StepResult.distribute() parameter local_materials", "output": "The local_materials parameter materials for this process. It should be a iterable of str value." }, { "instruction": "What does the ranges parameter do in the distribute() method?", "input": "OpenMC Python API StepResult.distribute() parameter ranges", "output": "The ranges parameter slice-like object indicating indicies of ``local_materials`` in the material dimension of :attr:`data` and each element. It should be a iterable of int value." }, { "instruction": "What does the in parameter do in the distribute() method?", "input": "OpenMC Python API StepResult.distribute() parameter in", "output": "The in parameter . It should be a attr:`rates` value." }, { "instruction": "What does the get_material() method do in the StepResult class?", "input": "OpenMC Python API StepResult.get_material() method", "output": "The get_material() method return material object for given depleted composition .. versionadded:: 0.13.2. It's used for stepresult operations." }, { "instruction": "How do you call the get_material() method in the StepResult class?", "input": "OpenMC Python API StepResult.get_material() method signature", "output": "To call the get_material() method, use: def get_material(self: Any, mat_id: Any). It takes 2 parameters." }, { "instruction": "What does the mat_id parameter do in the get_material() method?", "input": "OpenMC Python API StepResult.get_material() parameter mat_id", "output": "The mat_id parameter material id as a string. It should be a str value." }, { "instruction": "What does the export_to_hdf5() method do in the StepResult class?", "input": "OpenMC Python API StepResult.export_to_hdf5() method", "output": "The export_to_hdf5() method export results to an hdf5 file. It's used for stepresult operations." }, { "instruction": "How do you call the export_to_hdf5() method in the StepResult class?", "input": "OpenMC Python API StepResult.export_to_hdf5() method signature", "output": "To call the export_to_hdf5() method, use: def export_to_hdf5(self: Any, filename: Any, step: Any). It takes 3 parameters." }, { "instruction": "What does the filename parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API StepResult.export_to_hdf5() parameter filename", "output": "The filename parameter the filename to write to. It should be a str value." }, { "instruction": "What does the step parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API StepResult.export_to_hdf5() parameter step", "output": "The step parameter what step is this?. It should be a int value." }, { "instruction": "What does the _write_hdf5_metadata() method do in the StepResult class?", "input": "OpenMC Python API StepResult._write_hdf5_metadata() method", "output": "The _write_hdf5_metadata() method writes result metadata in hdf5 file. It's used for stepresult operations." }, { "instruction": "How do you call the _write_hdf5_metadata() method in the StepResult class?", "input": "OpenMC Python API StepResult._write_hdf5_metadata() method signature", "output": "To call the _write_hdf5_metadata() method, use: def _write_hdf5_metadata(self: Any, handle: Any). It takes 2 parameters." }, { "instruction": "What does the handle parameter do in the _write_hdf5_metadata() method?", "input": "OpenMC Python API StepResult._write_hdf5_metadata() parameter handle", "output": "The handle parameter an hdf5 file or group type to store this in.. It should be a h5py.File or h5py.Group value." }, { "instruction": "What does the _to_hdf5() method do in the StepResult class?", "input": "OpenMC Python API StepResult._to_hdf5() method", "output": "The _to_hdf5() method converts results object into an hdf5 object. It's used for stepresult operations." }, { "instruction": "How do you call the _to_hdf5() method in the StepResult class?", "input": "OpenMC Python API StepResult._to_hdf5() method signature", "output": "To call the _to_hdf5() method, use: def _to_hdf5(self: Any, handle: Any, index: Any, parallel: Any). It takes 4 parameters." }, { "instruction": "What does the handle parameter do in the _to_hdf5() method?", "input": "OpenMC Python API StepResult._to_hdf5() parameter handle", "output": "The handle parameter an hdf5 file or group type to store this in.. It should be a h5py.File or h5py.Group value." }, { "instruction": "What does the index parameter do in the _to_hdf5() method?", "input": "OpenMC Python API StepResult._to_hdf5() parameter index", "output": "The index parameter what step is this?. It should be a int value." }, { "instruction": "What does the parallel parameter do in the _to_hdf5() method?", "input": "OpenMC Python API StepResult._to_hdf5() parameter parallel", "output": "The parallel parameter being called with parallel hdf5?. It should be a bool value." }, { "instruction": "What does the from_hdf5() method do in the StepResult class?", "input": "OpenMC Python API StepResult.from_hdf5() method", "output": "The from_hdf5() method loads results object from hdf5. It's used for stepresult operations." }, { "instruction": "How do you call the from_hdf5() method in the StepResult class?", "input": "OpenMC Python API StepResult.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, handle: Any, step: Any). It takes 3 parameters." }, { "instruction": "What does the handle parameter do in the from_hdf5() method?", "input": "OpenMC Python API StepResult.from_hdf5() parameter handle", "output": "The handle parameter an hdf5 file or group type to load from.. It should be a h5py.File or h5py.Group value." }, { "instruction": "What does the step parameter do in the from_hdf5() method?", "input": "OpenMC Python API StepResult.from_hdf5() parameter step", "output": "The step parameter index for depletion step. It should be a int value." }, { "instruction": "What does the save() method do in the StepResult class?", "input": "OpenMC Python API StepResult.save() method", "output": "The save() method creates and writes depletion results to disk. It's used for stepresult operations." }, { "instruction": "How do you call the save() method in the StepResult class?", "input": "OpenMC Python API StepResult.save() method signature", "output": "To call the save() method, use: @staticmethod def save(op: Any, x: Any, op_results: Any, t: Any, source_rate: Any, step_ind: Any, proc_time: Any, path: PathLike). It takes 8 parameters." }, { "instruction": "What does the op parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter op", "output": "The op parameter the operator used to generate these results.. It should be a openmc.deplete.abc.TransportOperator value." }, { "instruction": "What does the x parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter x", "output": "The x parameter the prior x vectors. indexed [i][cell] using the above equation.. It should be a list of list of numpy.array value." }, { "instruction": "What does the op_results parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter op_results", "output": "The op_results parameter results of applying transport operator. It should be a list of openmc.deplete.OperatorResult value." }, { "instruction": "What does the t parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter t", "output": "The t parameter time indices.. It should be a list of float value." }, { "instruction": "What does the source_rate parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter source_rate", "output": "The source_rate parameter source rate during time step in [w] or [neutron/sec]. It should be a float value." }, { "instruction": "What does the step_ind parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter step_ind", "output": "The step_ind parameter step index.. It should be a int value." }, { "instruction": "What does the proc_time parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter proc_time", "output": "The proc_time parameter total process time spent depleting materials. this may be process-dependent and will be reduced across mpi processes.. It should be a float or None value." }, { "instruction": "What does the path parameter do in the save() method?", "input": "OpenMC Python API StepResult.save() parameter path", "output": "The path parameter path to file to write. defaults to 'depletion_results.h5'. .. versionadded:: 0.14.0. It should be a PathLike value." }, { "instruction": "What does the transfer_volumes() method do in the StepResult class?", "input": "OpenMC Python API StepResult.transfer_volumes() method", "output": "The transfer_volumes() method transfers volumes from depletion results to geometry. It's used for stepresult operations." }, { "instruction": "How do you call the transfer_volumes() method in the StepResult class?", "input": "OpenMC Python API StepResult.transfer_volumes() method signature", "output": "To call the transfer_volumes() method, use: def transfer_volumes(self: Any, model: Any). It takes 2 parameters." }, { "instruction": "What does the model parameter do in the transfer_volumes() method?", "input": "OpenMC Python API StepResult.transfer_volumes() parameter model", "output": "The model parameter calculation. It should be a OpenMC model to be used in a depletion restart value." }, { "instruction": "What is the TransferRates class in OpenMC's Python API?", "input": "OpenMC Python API TransferRates class", "output": "The TransferRates class represents class for defining continuous removals and feeds. molten salt reactors (msrs) benefit from continuous reprocessing, which removes fission products and feeds fresh fuel into the system. msrs inspired the development of this class. an instance of this class can be passed directly to an instance of one of the :class:`openmc.deplete.integrator` classes. .. versionadded:: 0.14.0. It provides 6 methods and 0 properties for working with transferrates data in OpenMC." }, { "instruction": "What does the TransferRates class do in OpenMC's Python API?", "input": "OpenMC Python API TransferRates class description", "output": "The TransferRates class class for defining continuous removals and feeds. molten salt reactors (msrs) benefit from continuous reprocessing, which removes fission products and feeds fresh fuel into the system. msrs inspired the development of this class. an instance of this class can be passed directly to an instance of one of the :class:`openmc.deplete.integrator` classes. .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the operator parameter do when creating a TransferRates?", "input": "OpenMC Python API TransferRates constructor parameter operator", "output": "When creating a TransferRates, the operator parameter specifies depletion operator. It should be a openmc.TransportOperator value." }, { "instruction": "What does the model parameter do when creating a TransferRates?", "input": "OpenMC Python API TransferRates constructor parameter model", "output": "When creating a TransferRates, the model parameter specifies openmc model containing materials and geometry. if using :class:`openmc.deplete.coupledoperator`, the model must also contain. It should be a openmc.Model value." }, { "instruction": "What does the a parameter do when creating a TransferRates?", "input": "OpenMC Python API TransferRates constructor parameter a", "output": "When creating a TransferRates, the a parameter specifies . It should be a class:`opnemc.Settings` object. value." }, { "instruction": "What is the burnable_mats attribute of a TransferRates?", "input": "OpenMC Python API TransferRates attribute burnable_mats", "output": "The burnable_mats attribute of a TransferRates contains all burnable material ids.. It's a list of str value that you can access after creating a TransferRates instance." }, { "instruction": "What is the local_mats attribute of a TransferRates?", "input": "OpenMC Python API TransferRates attribute local_mats", "output": "The local_mats attribute of a TransferRates contains all burnable material ids being managed by a single process. It's a list of str value that you can access after creating a TransferRates instance." }, { "instruction": "What is the transfer_rates attribute of a TransferRates?", "input": "OpenMC Python API TransferRates attribute transfer_rates", "output": "The transfer_rates attribute of a TransferRates contains container of transfer rates, components (elements and/or nuclides) and destination material. It's a dict of str to dict value that you can access after creating a TransferRates instance." }, { "instruction": "What is the index_transfer attribute of a TransferRates?", "input": "OpenMC Python API TransferRates attribute index_transfer", "output": "The index_transfer attribute of a TransferRates contains pair of strings needed to build final matrix (destination_material, mat). It's a Set of pair of str value that you can access after creating a TransferRates instance." }, { "instruction": "How do you call the __init__() method in the TransferRates class?", "input": "OpenMC Python API TransferRates.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, operator: Any, model: Any). It takes 3 parameters." }, { "instruction": "What does the _get_material_id() method do in the TransferRates class?", "input": "OpenMC Python API TransferRates._get_material_id() method", "output": "The _get_material_id() method helper method for getting material id from material obj or name. It's used for transferrates operations." }, { "instruction": "How do you call the _get_material_id() method in the TransferRates class?", "input": "OpenMC Python API TransferRates._get_material_id() method signature", "output": "To call the _get_material_id() method, use: def _get_material_id(self: Any, val: Any). It takes 2 parameters." }, { "instruction": "What does the val parameter do in the _get_material_id() method?", "input": "OpenMC Python API TransferRates._get_material_id() parameter val", "output": "The val parameter . It should be a openmc.Material or str or int representing material name/id value." }, { "instruction": "What does the _get_material_id() method return in the TransferRates class?", "input": "OpenMC Python API TransferRates._get_material_id() return value", "output": "The _get_material_id() method returns . The return type is str." }, { "instruction": "What does the get_transfer_rate() method do in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_transfer_rate() method", "output": "The get_transfer_rate() method return transfer rate for given material and element. It's used for transferrates operations." }, { "instruction": "How do you call the get_transfer_rate() method in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_transfer_rate() method signature", "output": "To call the get_transfer_rate() method, use: def get_transfer_rate(self: Any, material: Any, component: Any). It takes 3 parameters." }, { "instruction": "What does the material parameter do in the get_transfer_rate() method?", "input": "OpenMC Python API TransferRates.get_transfer_rate() parameter material", "output": "The material parameter depletable material. It should be a openmc.Material or str or int value." }, { "instruction": "What does the component parameter do in the get_transfer_rate() method?", "input": "OpenMC Python API TransferRates.get_transfer_rate() parameter component", "output": "The component parameter element or nuclide to get transfer rate value. It should be a str value." }, { "instruction": "What does the get_transfer_rate() method return in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_transfer_rate() return value", "output": "The get_transfer_rate() method returns transfer rate values. The return type is list of floats." }, { "instruction": "What does the get_destination_material() method do in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_destination_material() method", "output": "The get_destination_material() method return destination material for given material and component, if defined. It's used for transferrates operations." }, { "instruction": "How do you call the get_destination_material() method in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_destination_material() method signature", "output": "To call the get_destination_material() method, use: def get_destination_material(self: Any, material: Any, component: Any). It takes 3 parameters." }, { "instruction": "What does the material parameter do in the get_destination_material() method?", "input": "OpenMC Python API TransferRates.get_destination_material() parameter material", "output": "The material parameter depletable material. It should be a openmc.Material or str or int value." }, { "instruction": "What does the component parameter do in the get_destination_material() method?", "input": "OpenMC Python API TransferRates.get_destination_material() parameter component", "output": "The component parameter element or nuclide that gets transferred to another material.. It should be a str value." }, { "instruction": "What does the get_destination_material() method return in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_destination_material() return value", "output": "The get_destination_material() method returns depletable material id to where the element or nuclide gets transferred. The return type is list of str." }, { "instruction": "What does the get_components() method do in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_components() method", "output": "The get_components() method extract removing elements and/or nuclides for a given material. It's used for transferrates operations." }, { "instruction": "How do you call the get_components() method in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_components() method signature", "output": "To call the get_components() method, use: def get_components(self: Any, material: Any). It takes 2 parameters." }, { "instruction": "What does the material parameter do in the get_components() method?", "input": "OpenMC Python API TransferRates.get_components() parameter material", "output": "The material parameter depletable material. It should be a openmc.Material or str or int value." }, { "instruction": "What does the get_components() method return in the TransferRates class?", "input": "OpenMC Python API TransferRates.get_components() return value", "output": "The get_components() method returns list of elements and nuclides where transfer rates exist. The return type is list." }, { "instruction": "What does the set_transfer_rate() method do in the TransferRates class?", "input": "OpenMC Python API TransferRates.set_transfer_rate() method", "output": "The set_transfer_rate() method set element and/or nuclide transfer rates in a depletable material. It's used for transferrates operations." }, { "instruction": "How do you call the set_transfer_rate() method in the TransferRates class?", "input": "OpenMC Python API TransferRates.set_transfer_rate() method signature", "output": "To call the set_transfer_rate() method, use: def set_transfer_rate(self: Any, material: Any, components: Any, transfer_rate: Any, transfer_rate_units: Any, destination_material: Any). It takes 6 parameters." }, { "instruction": "What does the material parameter do in the set_transfer_rate() method?", "input": "OpenMC Python API TransferRates.set_transfer_rate() parameter material", "output": "The material parameter depletable material. It should be a openmc.Material or str or int value." }, { "instruction": "What does the components parameter do in the set_transfer_rate() method?", "input": "OpenMC Python API TransferRates.set_transfer_rate() parameter components", "output": "The components parameter list of strings of elements and/or nuclides that share transfer rate. cannot add transfer rates for nuclides to a material where a transfer rate for its element is specified and vice versa.. It should be a list of str value." }, { "instruction": "What does the transfer_rate parameter do in the set_transfer_rate() method?", "input": "OpenMC Python API TransferRates.set_transfer_rate() parameter transfer_rate", "output": "The transfer_rate parameter rate at which elements and/or nuclides are transferred. a positive or negative value corresponds to a removal or feed rate, respectively.. It should be a float value." }, { "instruction": "What does the destination_material parameter do in the set_transfer_rate() method?", "input": "OpenMC Python API TransferRates.set_transfer_rate() parameter destination_material", "output": "The destination_material parameter destination material to where nuclides get fed.. It should be a openmc.Material or str or int, Optional value." }, { "instruction": "What does the transfer_rate_units parameter do in the set_transfer_rate() method?", "input": "OpenMC Python API TransferRates.set_transfer_rate() parameter transfer_rate_units", "output": "The transfer_rate_units parameter units for values specified in the transfer_rate argument. 's' for seconds, 'min' for minutes, 'h' for hours, 'a' for julian years.. It should be a {'1/s', '1/min', '1/h', '1/d', '1/a'} value." }, { "instruction": "How do you call the allgather() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.allgather() method signature", "output": "To call the allgather() method, use: def allgather(self: Any, sendobj: Any). It takes 2 parameters." }, { "instruction": "How do you call the allreduce() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.allreduce() method signature", "output": "To call the allreduce() method, use: def allreduce(self: Any, sendobj: Any, op: Any). It takes 3 parameters." }, { "instruction": "How do you call the barrier() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.barrier() method signature", "output": "To call the barrier() method, use: def barrier(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bcast() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.bcast() method signature", "output": "To call the bcast() method, use: def bcast(self: Any, obj: Any, root: Any). It takes 3 parameters." }, { "instruction": "How do you call the gather() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.gather() method signature", "output": "To call the gather() method, use: def gather(self: Any, sendobj: Any, root: Any). It takes 3 parameters." }, { "instruction": "How do you call the py2f() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.py2f() method signature", "output": "To call the py2f() method, use: def py2f(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the reduce() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.reduce() method signature", "output": "To call the reduce() method, use: def reduce(self: Any, sendobj: Any, op: Any, root: Any). It takes 4 parameters." }, { "instruction": "How do you call the scatter() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.scatter() method signature", "output": "To call the scatter() method, use: def scatter(self: Any, sendobj: Any, root: Any). It takes 3 parameters." }, { "instruction": "How do you call the Abort() method in the DummyCommunicator class?", "input": "OpenMC Python API DummyCommunicator.Abort() method signature", "output": "To call the Abort() method, use: def Abort(self: Any, exit_code_or_msg: Any). It takes 2 parameters." }, { "instruction": "What is the Element class in OpenMC's Python API?", "input": "OpenMC Python API Element class", "output": "The Element class represents a natural element that auto-expands to add the isotopes of an element to a material in their natural abundance. internally, the openmc python api expands the natural element into isotopes only when the materials.xml file is created. It provides 3 methods and 0 properties for working with element data in OpenMC." }, { "instruction": "What does the Element class do in OpenMC's Python API?", "input": "OpenMC Python API Element class description", "output": "The Element class a natural element that auto-expands to add the isotopes of an element to a material in their natural abundance. internally, the openmc python api expands the natural element into isotopes only when the materials.xml file is created. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a Element?", "input": "OpenMC Python API Element constructor parameter name", "output": "When creating a Element, the name parameter specifies chemical symbol of the element, e.g. pu. It should be a str value." }, { "instruction": "What is the name attribute of a Element?", "input": "OpenMC Python API Element attribute name", "output": "The name attribute of a Element contains chemical symbol of the element, e.g. pu. It's a str value that you can access after creating a Element instance." }, { "instruction": "How do you call the __new__() method in the Element class?", "input": "OpenMC Python API Element.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the Element class?", "input": "OpenMC Python API Element.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What does the expand() method do in the Element class?", "input": "OpenMC Python API Element.expand() method", "output": "The expand() method expand natural element into its naturally-occurring isotopes. an optional cross_sections argument or the ``cross_sections`` configuration value is used to specify a cross_sections.xml file. if the cross_sections.xml file is found, the element is expanded only into the isotopes/nuclides present in cross_sections.xml. if no cross_sections.xml file is found, the element is expanded based on its naturally occurring isotopes. It's used for element operations." }, { "instruction": "How do you call the expand() method in the Element class?", "input": "OpenMC Python API Element.expand() method signature", "output": "To call the expand() method, use: def expand(self: Any, percent: Any, percent_type: Any, enrichment: Any, enrichment_target: Any, enrichment_type: Any, cross_sections: Any). It takes 7 parameters." }, { "instruction": "What does the percent parameter do in the expand() method?", "input": "OpenMC Python API Element.expand() parameter percent", "output": "The percent parameter atom or weight percent. It should be a float value." }, { "instruction": "What does the percent_type parameter do in the expand() method?", "input": "OpenMC Python API Element.expand() parameter percent_type", "output": "The percent_type parameter 'ao' for atom percent and 'wo' for weight percent. It should be a {'ao', 'wo'} value." }, { "instruction": "What does the enrichment parameter do in the expand() method?", "input": "OpenMC Python API Element.expand() parameter enrichment", "output": "The enrichment parameter enrichment of an enrichment_target nuclide in percent (ao or wo). if enrichment_target is not supplied then it is enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none (natural composition).. It should be a float, optional value." }, { "instruction": "What does the enrichment_target parameter do in the expand() method?", "input": "OpenMC Python API Element.expand() parameter enrichment_target", "output": "The enrichment_target parameter single nuclide name to enrich from a natural composition (e.g., 'o16') .. versionadded:: 0.12. It should be a str, optional value." }, { "instruction": "What does the enrichment_type parameter do in the expand() method?", "input": "OpenMC Python API Element.expand() parameter enrichment_type", "output": "The enrichment_type parameter 'ao' for enrichment as atom percent and 'wo' for weight percent. default is: 'ao' for two-isotope enrichment; 'wo' for u enrichment .. versionadded:: 0.12. It should be a {'ao', 'wo'}, optional value." }, { "instruction": "What does the cross_sections parameter do in the expand() method?", "input": "OpenMC Python API Element.expand() parameter cross_sections", "output": "The cross_sections parameter location of cross_sections.xml file. default is none.. It should be a str, optional value." }, { "instruction": "What does the expand() method return in the Element class?", "input": "OpenMC Python API Element.expand() return value", "output": "The expand() method returns naturally-occurring isotopes of the element. each item of the list is a tuple consisting of a nuclide string, the atom/weight percent, and the string 'ao' or 'wo'.. The return type is list." }, { "instruction": "What does the pwr_pin_cell() function do in OpenMC's Python API?", "input": "OpenMC Python API pwr_pin_cell() function", "output": "The pwr_pin_cell() function create a pwr pin-cell model. this model is a single fuel pin with 2.4 w/o enriched uo2 corresponding to a beginning-of-cycle condition and borated water. the specifications are from the `beavrs `_ benchmark. note that the number of particles/batches is initially set very low for testing purposes. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the pwr_pin_cell() function in OpenMC's Python API?", "input": "OpenMC Python API pwr_pin_cell() function purpose", "output": "The pwr_pin_cell() function create a pwr pin-cell model. this model is a single fuel pin with 2.4 w/o enriched uo2 corresponding to a beginning-of-cycle condition and borated water. the specifications are from the `beavrs `_ benchmark. note that the number of particles/batches is initially set very low for testing purposes. It's part of OpenMC's Python API." }, { "instruction": "How do you call the pwr_pin_cell() function in OpenMC's Python API?", "input": "OpenMC Python API pwr_pin_cell() function signature", "output": "To call the pwr_pin_cell() function, use: def pwr_pin_cell(). It takes 0 parameters." }, { "instruction": "What does the pwr_pin_cell() function return in OpenMC's Python API?", "input": "OpenMC Python API pwr_pin_cell() return value", "output": "The pwr_pin_cell() function returns a pwr pin-cell model. The return type is openmc.Model." }, { "instruction": "What does the pwr_core() function do in OpenMC's Python API?", "input": "OpenMC Python API pwr_core() function", "output": "The pwr_core() function create a pwr full-core model. this model is the oecd/nea monte carlo performance benchmark which is a grossly simplified pressurized water reactor (pwr) with 241 fuel assemblies. note that the number of particles/batches is initially set very low for testing purposes. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the pwr_core() function in OpenMC's Python API?", "input": "OpenMC Python API pwr_core() function purpose", "output": "The pwr_core() function create a pwr full-core model. this model is the oecd/nea monte carlo performance benchmark which is a grossly simplified pressurized water reactor (pwr) with 241 fuel assemblies. note that the number of particles/batches is initially set very low for testing purposes. It's part of OpenMC's Python API." }, { "instruction": "How do you call the pwr_core() function in OpenMC's Python API?", "input": "OpenMC Python API pwr_core() function signature", "output": "To call the pwr_core() function, use: def pwr_core(). It takes 0 parameters." }, { "instruction": "What does the pwr_core() function return in OpenMC's Python API?", "input": "OpenMC Python API pwr_core() return value", "output": "The pwr_core() function returns full-core pwr model. The return type is openmc.Model." }, { "instruction": "What does the pwr_assembly() function do in OpenMC's Python API?", "input": "OpenMC Python API pwr_assembly() function", "output": "The pwr_assembly() function create a pwr assembly model. this model is a reflected 17x17 fuel assembly from the the `beavrs `_ benchmark. the fuel is 2.4 w/o enriched uo2 corresponding to a beginning-of-cycle condition. note that the number of particles/batches is initially set very low for testing purposes. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the pwr_assembly() function in OpenMC's Python API?", "input": "OpenMC Python API pwr_assembly() function purpose", "output": "The pwr_assembly() function create a pwr assembly model. this model is a reflected 17x17 fuel assembly from the the `beavrs `_ benchmark. the fuel is 2.4 w/o enriched uo2 corresponding to a beginning-of-cycle condition. note that the number of particles/batches is initially set very low for testing purposes. It's part of OpenMC's Python API." }, { "instruction": "How do you call the pwr_assembly() function in OpenMC's Python API?", "input": "OpenMC Python API pwr_assembly() function signature", "output": "To call the pwr_assembly() function, use: def pwr_assembly(). It takes 0 parameters." }, { "instruction": "What does the pwr_assembly() function return in OpenMC's Python API?", "input": "OpenMC Python API pwr_assembly() return value", "output": "The pwr_assembly() function returns a pwr assembly model. The return type is openmc.Model." }, { "instruction": "What does the slab_mg() function do in OpenMC's Python API?", "input": "OpenMC Python API slab_mg() function", "output": "The slab_mg() function create a 1d slab model. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the slab_mg() function in OpenMC's Python API?", "input": "OpenMC Python API slab_mg() function purpose", "output": "The slab_mg() function create a 1d slab model. It's part of OpenMC's Python API." }, { "instruction": "How do you call the slab_mg() function in OpenMC's Python API?", "input": "OpenMC Python API slab_mg() function signature", "output": "To call the slab_mg() function, use: def slab_mg(num_regions: Any, mat_names: Any, mgxslib_name: Any). It takes 3 parameters." }, { "instruction": "What does the num_regions parameter do in the slab_mg() function?", "input": "OpenMC Python API slab_mg() parameter num_regions", "output": "The num_regions parameter number of regions in the problem, each with a unique mgxs dataset. defaults to 1.. It should be a int, optional value." }, { "instruction": "What does the mat_names parameter do in the slab_mg() function?", "input": "OpenMC Python API slab_mg() parameter mat_names", "output": "The mat_names parameter list of the material names to use; defaults to ['mat_1', 'mat_2',...].. It should be a Iterable of str, optional value." }, { "instruction": "What does the mgxslib_name parameter do in the slab_mg() function?", "input": "OpenMC Python API slab_mg() parameter mgxslib_name", "output": "The mgxslib_name parameter mgxs library file to use; defaults to '2g.h5'.. It should be a str, optional value." }, { "instruction": "What does the slab_mg() function return in OpenMC's Python API?", "input": "OpenMC Python API slab_mg() return value", "output": "The slab_mg() function returns one-group, 1d slab model. The return type is openmc.Model." }, { "instruction": "What does the random_ray_lattice() function do in OpenMC's Python API?", "input": "OpenMC Python API random_ray_lattice() function", "output": "The random_ray_lattice() function create a 2x2 pwr pincell asymmetrical lattic eexample. this model is a 2x2 reflective lattice of fuel pins with one of the lattice locations having just moderator instead of a fuel pin. it uses 7 group cross section data. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the random_ray_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API random_ray_lattice() function purpose", "output": "The random_ray_lattice() function create a 2x2 pwr pincell asymmetrical lattic eexample. this model is a 2x2 reflective lattice of fuel pins with one of the lattice locations having just moderator instead of a fuel pin. it uses 7 group cross section data. It's part of OpenMC's Python API." }, { "instruction": "How do you call the random_ray_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API random_ray_lattice() function signature", "output": "To call the random_ray_lattice() function, use: def random_ray_lattice(). It takes 0 parameters." }, { "instruction": "What does the random_ray_lattice() function return in OpenMC's Python API?", "input": "OpenMC Python API random_ray_lattice() return value", "output": "The random_ray_lattice() function returns a pwr 2x2 lattice model. The return type is openmc.Model." }, { "instruction": "What does the random_ray_three_region_cube() function do in OpenMC's Python API?", "input": "OpenMC Python API random_ray_three_region_cube() function", "output": "The random_ray_three_region_cube() function create a three region cube model. this is a simple monoenergetic problem of a cube with three concentric cubic regions. the innermost region is near void (with sigma_t around 10^-5) and contains an external isotropic source term, the middle region is void (with sigma_t around 10^-4), and the outer region of the cube is an absorber (with sigma_t around 1). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the random_ray_three_region_cube() function in OpenMC's Python API?", "input": "OpenMC Python API random_ray_three_region_cube() function purpose", "output": "The random_ray_three_region_cube() function create a three region cube model. this is a simple monoenergetic problem of a cube with three concentric cubic regions. the innermost region is near void (with sigma_t around 10^-5) and contains an external isotropic source term, the middle region is void (with sigma_t around 10^-4), and the outer region of the cube is an absorber (with sigma_t around 1). It's part of OpenMC's Python API." }, { "instruction": "How do you call the random_ray_three_region_cube() function in OpenMC's Python API?", "input": "OpenMC Python API random_ray_three_region_cube() function signature", "output": "To call the random_ray_three_region_cube() function, use: def random_ray_three_region_cube(). It takes 0 parameters." }, { "instruction": "What does the random_ray_three_region_cube() function return in OpenMC's Python API?", "input": "OpenMC Python API random_ray_three_region_cube() return value", "output": "The random_ray_three_region_cube() function returns a three region cube model. The return type is openmc.Model." }, { "instruction": "How do you call the fill_cube() function in OpenMC's Python API?", "input": "OpenMC Python API fill_cube() function signature", "output": "To call the fill_cube() function, use: def fill_cube(N: Any, n_1: Any, n_2: Any, fill_1: Any, fill_2: Any, fill_3: Any). It takes 6 parameters." }, { "instruction": "What is the OpenMCError class in OpenMC's Python API?", "input": "OpenMC Python API OpenMCError class", "output": "The OpenMCError class represents root exception class for openmc.. It provides 0 methods and 0 properties for working with openmcerror data in OpenMC." }, { "instruction": "What does the OpenMCError class do in OpenMC's Python API?", "input": "OpenMC Python API OpenMCError class description", "output": "The OpenMCError class root exception class for openmc.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the GeometryError class in OpenMC's Python API?", "input": "OpenMC Python API GeometryError class", "output": "The GeometryError class represents geometry-related error. It provides 0 methods and 0 properties for working with geometryerror data in OpenMC." }, { "instruction": "What does the GeometryError class do in OpenMC's Python API?", "input": "OpenMC Python API GeometryError class description", "output": "The GeometryError class geometry-related error. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the InvalidIDError class in OpenMC's Python API?", "input": "OpenMC Python API InvalidIDError class", "output": "The InvalidIDError class represents use of an id that is invalid.. It provides 0 methods and 0 properties for working with invalididerror data in OpenMC." }, { "instruction": "What does the InvalidIDError class do in OpenMC's Python API?", "input": "OpenMC Python API InvalidIDError class description", "output": "The InvalidIDError class use of an id that is invalid.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the AllocationError class in OpenMC's Python API?", "input": "OpenMC Python API AllocationError class", "output": "The AllocationError class represents error related to memory allocation.. It provides 0 methods and 0 properties for working with allocationerror data in OpenMC." }, { "instruction": "What does the AllocationError class do in OpenMC's Python API?", "input": "OpenMC Python API AllocationError class description", "output": "The AllocationError class error related to memory allocation.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the OutOfBoundsError class in OpenMC's Python API?", "input": "OpenMC Python API OutOfBoundsError class", "output": "The OutOfBoundsError class represents index in array out of bounds.. It provides 0 methods and 0 properties for working with outofboundserror data in OpenMC." }, { "instruction": "What does the OutOfBoundsError class do in OpenMC's Python API?", "input": "OpenMC Python API OutOfBoundsError class description", "output": "The OutOfBoundsError class index in array out of bounds.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the DataError class in OpenMC's Python API?", "input": "OpenMC Python API DataError class", "output": "The DataError class represents error relating to nuclear data.. It provides 0 methods and 0 properties for working with dataerror data in OpenMC." }, { "instruction": "What does the DataError class do in OpenMC's Python API?", "input": "OpenMC Python API DataError class description", "output": "The DataError class error relating to nuclear data.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the PhysicsError class in OpenMC's Python API?", "input": "OpenMC Python API PhysicsError class", "output": "The PhysicsError class represents error relating to performing physics.. It provides 0 methods and 0 properties for working with physicserror data in OpenMC." }, { "instruction": "What does the PhysicsError class do in OpenMC's Python API?", "input": "OpenMC Python API PhysicsError class description", "output": "The PhysicsError class error relating to performing physics.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the InvalidArgumentError class in OpenMC's Python API?", "input": "OpenMC Python API InvalidArgumentError class", "output": "The InvalidArgumentError class represents argument passed was invalid.. It provides 0 methods and 0 properties for working with invalidargumenterror data in OpenMC." }, { "instruction": "What does the InvalidArgumentError class do in OpenMC's Python API?", "input": "OpenMC Python API InvalidArgumentError class description", "output": "The InvalidArgumentError class argument passed was invalid.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the InvalidTypeError class in OpenMC's Python API?", "input": "OpenMC Python API InvalidTypeError class", "output": "The InvalidTypeError class represents tried to perform an operation on the wrong type.. It provides 0 methods and 0 properties for working with invalidtypeerror data in OpenMC." }, { "instruction": "What does the InvalidTypeError class do in OpenMC's Python API?", "input": "OpenMC Python API InvalidTypeError class description", "output": "The InvalidTypeError class tried to perform an operation on the wrong type.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the SetupError class in OpenMC's Python API?", "input": "OpenMC Python API SetupError class", "output": "The SetupError class represents error while setting up a problem.. It provides 0 methods and 0 properties for working with setuperror data in OpenMC." }, { "instruction": "What does the SetupError class do in OpenMC's Python API?", "input": "OpenMC Python API SetupError class description", "output": "The SetupError class error while setting up a problem.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the _process_CLI_arguments() function do in OpenMC's Python API?", "input": "OpenMC Python API _process_CLI_arguments() function", "output": "The _process_CLI_arguments() function converts user-readable flags in to command-line arguments to be run with the openmc executable via subprocess. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _process_CLI_arguments() function in OpenMC's Python API?", "input": "OpenMC Python API _process_CLI_arguments() function purpose", "output": "The _process_CLI_arguments() function converts user-readable flags in to command-line arguments to be run with the openmc executable via subprocess. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _process_CLI_arguments() function in OpenMC's Python API?", "input": "OpenMC Python API _process_CLI_arguments() function signature", "output": "To call the _process_CLI_arguments() function, use: def _process_CLI_arguments(volume: Any, geometry_debug: Any, particles: Any, plot: Any, restart_file: Any, threads: Any, tracks: Any, event_based: Any, openmc_exec: Any, mpi_args: Any, path_input: Any). It takes 11 parameters." }, { "instruction": "What does the volume parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter volume", "output": "The volume parameter run in stochastic volume calculation mode. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the geometry_debug parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter geometry_debug", "output": "The geometry_debug parameter turn on geometry debugging during simulation. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the particles parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter particles", "output": "The particles parameter number of particles to simulate per generation.. It should be a int, optional value." }, { "instruction": "What does the plot parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter plot", "output": "The plot parameter run in plotting mode. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the restart_file parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter restart_file", "output": "The restart_file parameter path to restart file to use. It should be a str or PathLike value." }, { "instruction": "What does the threads parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter threads", "output": "The threads parameter number of openmp threads. if openmc is compiled with openmp threading enabled, the default is implementation-dependent but is usually equal to the number of hardware threads available (or a value set by the :envvar:`omp_num_threads` environment variable).. It should be a int, optional value." }, { "instruction": "What does the tracks parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter tracks", "output": "The tracks parameter enables the writing of particles tracks. the number of particle tracks written to tracks.h5 is limited to 1000 unless settings.max_tracks is set. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the event_based parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter event_based", "output": "The event_based parameter turns on event-based parallelism if true. if none, the value in the settings will be used.. It should be a None or bool, optional value." }, { "instruction": "What does the openmc_exec parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. defaults to 'openmc'.. It should be a str, optional value." }, { "instruction": "What does the mpi_args parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter mpi_args", "output": "The mpi_args parameter mpi execute command and any additional mpi arguments to pass, e.g., ['mpiexec', '-n', '8'].. It should be a list of str, optional value." }, { "instruction": "What does the path_input parameter do in the _process_CLI_arguments() function?", "input": "OpenMC Python API _process_CLI_arguments() parameter path_input", "output": "The path_input parameter path to a single xml file or a directory containing xml files for the openmc executable to read. .. versionadded:: 0.13.0. It should be a str or PathLike value." }, { "instruction": "What does the _process_CLI_arguments() function return in OpenMC's Python API?", "input": "OpenMC Python API _process_CLI_arguments() return value", "output": "The _process_CLI_arguments() function returns the runtime flags converted to cli arguments of the openmc executable. The return type is Iterable of str." }, { "instruction": "How do you call the _run() function in OpenMC's Python API?", "input": "OpenMC Python API _run() function signature", "output": "To call the _run() function, use: def _run(args: Any, output: Any, cwd: Any). It takes 3 parameters." }, { "instruction": "What does the plot_geometry() function do in OpenMC's Python API?", "input": "OpenMC Python API plot_geometry() function", "output": "The plot_geometry() function run openmc in plotting mode. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the plot_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API plot_geometry() function purpose", "output": "The plot_geometry() function run openmc in plotting mode. It's part of OpenMC's Python API." }, { "instruction": "How do you call the plot_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API plot_geometry() function signature", "output": "To call the plot_geometry() function, use: def plot_geometry(output: Any, openmc_exec: Any, cwd: Any, path_input: Any). It takes 4 parameters." }, { "instruction": "What does the output parameter do in the plot_geometry() function?", "input": "OpenMC Python API plot_geometry() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool, optional value." }, { "instruction": "What does the openmc_exec parameter do in the plot_geometry() function?", "input": "OpenMC Python API plot_geometry() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. It should be a str, optional value." }, { "instruction": "What does the cwd parameter do in the plot_geometry() function?", "input": "OpenMC Python API plot_geometry() parameter cwd", "output": "The cwd parameter path to working directory to run in. It should be a str, optional value." }, { "instruction": "What does the path_input parameter do in the plot_geometry() function?", "input": "OpenMC Python API plot_geometry() parameter path_input", "output": "The path_input parameter path to a single xml file or a directory containing xml files for the openmc executable to read. .. versionadded:: 0.13.3. It should be a str value." }, { "instruction": "What does the plot_inline() function do in OpenMC's Python API?", "input": "OpenMC Python API plot_inline() function", "output": "The plot_inline() function display plots inline in a jupyter notebook. .. versionchanged:: 0.13.0 the *convert_exec* argument was removed since openmc now produces .png images directly. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the plot_inline() function in OpenMC's Python API?", "input": "OpenMC Python API plot_inline() function purpose", "output": "The plot_inline() function display plots inline in a jupyter notebook. .. versionchanged:: 0.13.0 the *convert_exec* argument was removed since openmc now produces .png images directly. It's part of OpenMC's Python API." }, { "instruction": "How do you call the plot_inline() function in OpenMC's Python API?", "input": "OpenMC Python API plot_inline() function signature", "output": "To call the plot_inline() function, use: def plot_inline(plots: Any, openmc_exec: Any, cwd: Any, path_input: Any). It takes 4 parameters." }, { "instruction": "What does the plots parameter do in the plot_inline() function?", "input": "OpenMC Python API plot_inline() parameter plots", "output": "The plots parameter plots to display. It should be a Iterable of openmc.Plot value." }, { "instruction": "What does the openmc_exec parameter do in the plot_inline() function?", "input": "OpenMC Python API plot_inline() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. It should be a str value." }, { "instruction": "What does the cwd parameter do in the plot_inline() function?", "input": "OpenMC Python API plot_inline() parameter cwd", "output": "The cwd parameter path to working directory to run in. It should be a str, optional value." }, { "instruction": "What does the path_input parameter do in the plot_inline() function?", "input": "OpenMC Python API plot_inline() parameter path_input", "output": "The path_input parameter path to a single xml file or a directory containing xml files for the openmc executable to read. .. versionadded:: 0.13.3. It should be a str value." }, { "instruction": "What does the calculate_volumes() function do in OpenMC's Python API?", "input": "OpenMC Python API calculate_volumes() function", "output": "The calculate_volumes() function run stochastic volume calculations in openmc. this function runs openmc in stochastic volume calculation mode. to specify the parameters of a volume calculation, one must first create a :class:`openmc.volumecalculation` instance and assign it to :attr:`openmc.settings.volume_calculations`. for example: >>> vol = openmc.volumecalculation(domains=[cell1, cell2], samples=100000) >>> settings = openmc.settings() >>> settings.volume_calculations = [vol] >>> settings.export_to_xml() >>> openmc.calculate_volumes(). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the calculate_volumes() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_volumes() function purpose", "output": "The calculate_volumes() function run stochastic volume calculations in openmc. this function runs openmc in stochastic volume calculation mode. to specify the parameters of a volume calculation, one must first create a :class:`openmc.volumecalculation` instance and assign it to :attr:`openmc.settings.volume_calculations`. for example: >>> vol = openmc.volumecalculation(domains=[cell1, cell2], samples=100000) >>> settings = openmc.settings() >>> settings.volume_calculations = [vol] >>> settings.export_to_xml() >>> openmc.calculate_volumes(). It's part of OpenMC's Python API." }, { "instruction": "How do you call the calculate_volumes() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_volumes() function signature", "output": "To call the calculate_volumes() function, use: def calculate_volumes(threads: Any, output: Any, cwd: Any, openmc_exec: Any, mpi_args: Any, path_input: Any). It takes 6 parameters." }, { "instruction": "What does the threads parameter do in the calculate_volumes() function?", "input": "OpenMC Python API calculate_volumes() parameter threads", "output": "The threads parameter number of openmp threads. if openmc is compiled with openmp threading enabled, the default is implementation-dependent but is usually equal to the number of hardware threads available (or a value set by the :envvar:`omp_num_threads` environment variable).. It should be a int, optional value." }, { "instruction": "What does the output parameter do in the calculate_volumes() function?", "input": "OpenMC Python API calculate_volumes() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool, optional value." }, { "instruction": "What does the openmc_exec parameter do in the calculate_volumes() function?", "input": "OpenMC Python API calculate_volumes() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. defaults to 'openmc'.. It should be a str, optional value." }, { "instruction": "What does the mpi_args parameter do in the calculate_volumes() function?", "input": "OpenMC Python API calculate_volumes() parameter mpi_args", "output": "The mpi_args parameter mpi execute command and any additional mpi arguments to pass, e.g., ['mpiexec', '-n', '8'].. It should be a list of str, optional value." }, { "instruction": "What does the cwd parameter do in the calculate_volumes() function?", "input": "OpenMC Python API calculate_volumes() parameter cwd", "output": "The cwd parameter path to working directory to run in. defaults to the current working directory.. It should be a str, optional value." }, { "instruction": "What does the path_input parameter do in the calculate_volumes() function?", "input": "OpenMC Python API calculate_volumes() parameter path_input", "output": "The path_input parameter path to a single xml file or a directory containing xml files for the openmc executable to read.. It should be a str or PathLike value." }, { "instruction": "What does the run() function do in OpenMC's Python API?", "input": "OpenMC Python API run() function", "output": "The run() function run an openmc simulation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the run() function in OpenMC's Python API?", "input": "OpenMC Python API run() function purpose", "output": "The run() function run an openmc simulation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the run() function in OpenMC's Python API?", "input": "OpenMC Python API run() function signature", "output": "To call the run() function, use: def run(particles: Any, threads: Any, geometry_debug: Any, restart_file: Any, tracks: Any, output: Any, cwd: Any, openmc_exec: Any, mpi_args: Any, event_based: Any, path_input: Any). It takes 11 parameters." }, { "instruction": "What does the particles parameter do in the run() function?", "input": "OpenMC Python API run() parameter particles", "output": "The particles parameter number of particles to simulate per generation.. It should be a int, optional value." }, { "instruction": "What does the threads parameter do in the run() function?", "input": "OpenMC Python API run() parameter threads", "output": "The threads parameter number of openmp threads. if openmc is compiled with openmp threading enabled, the default is implementation-dependent but is usually equal to the number of hardware threads available (or a value set by the :envvar:`omp_num_threads` environment variable).. It should be a int, optional value." }, { "instruction": "What does the geometry_debug parameter do in the run() function?", "input": "OpenMC Python API run() parameter geometry_debug", "output": "The geometry_debug parameter turn on geometry debugging during simulation. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the restart_file parameter do in the run() function?", "input": "OpenMC Python API run() parameter restart_file", "output": "The restart_file parameter path to restart file to use. It should be a str or PathLike value." }, { "instruction": "What does the tracks parameter do in the run() function?", "input": "OpenMC Python API run() parameter tracks", "output": "The tracks parameter enables the writing of particles tracks. the number of particle tracks written to tracks.h5 is limited to 1000 unless settings.max_tracks is set. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the output parameter do in the run() function?", "input": "OpenMC Python API run() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool value." }, { "instruction": "What does the cwd parameter do in the run() function?", "input": "OpenMC Python API run() parameter cwd", "output": "The cwd parameter path to working directory to run in. defaults to the current working directory.. It should be a str, optional value." }, { "instruction": "What does the openmc_exec parameter do in the run() function?", "input": "OpenMC Python API run() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. defaults to 'openmc'.. It should be a str, optional value." }, { "instruction": "What does the mpi_args parameter do in the run() function?", "input": "OpenMC Python API run() parameter mpi_args", "output": "The mpi_args parameter mpi execute command and any additional mpi arguments to pass, e.g., ['mpiexec', '-n', '8'].. It should be a list of str, optional value." }, { "instruction": "What does the event_based parameter do in the run() function?", "input": "OpenMC Python API run() parameter event_based", "output": "The event_based parameter turns on event-based parallelism, instead of default history-based .. versionadded:: 0.12. It should be a bool, optional value." }, { "instruction": "What does the path_input parameter do in the run() function?", "input": "OpenMC Python API run() parameter path_input", "output": "The path_input parameter path to a single xml file or a directory containing xml files for the openmc executable to read. .. versionadded:: 0.13.3. It should be a str or PathLike value." }, { "instruction": "What is the FilterMeta class in OpenMC's Python API?", "input": "OpenMC Python API FilterMeta class", "output": "The FilterMeta class represents metaclass for filters that ensures class names are appropriate.. It provides 1 methods and 0 properties for working with filtermeta data in OpenMC." }, { "instruction": "What does the FilterMeta class do in OpenMC's Python API?", "input": "OpenMC Python API FilterMeta class description", "output": "The FilterMeta class metaclass for filters that ensures class names are appropriate.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __new__() method in the FilterMeta class?", "input": "OpenMC Python API FilterMeta.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, name: Any, bases: Any, namespace: Any). It takes 4 parameters." }, { "instruction": "What is the Filter class in OpenMC's Python API?", "input": "OpenMC Python API Filter class", "output": "The Filter class represents tally modifier that describes phase-space and other characteristics. It provides 20 methods and 0 properties for working with filter data in OpenMC." }, { "instruction": "What does the Filter class do in OpenMC's Python API?", "input": "OpenMC Python API Filter class description", "output": "The Filter class tally modifier that describes phase-space and other characteristics. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a Filter?", "input": "OpenMC Python API Filter constructor parameter bins", "output": "When creating a Filter, the bins parameter specifies the bins for the filter. this takes on different meaning for different filters. see the docstrings for subclasses of this filter or the online documentation for more details.. It should be a Integral or Iterable of Integral or Iterable of Real value." }, { "instruction": "What does the filter_id parameter do when creating a Filter?", "input": "OpenMC Python API Filter constructor parameter filter_id", "output": "When creating a Filter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a Filter?", "input": "OpenMC Python API Filter attribute bins", "output": "The bins attribute of a Filter contains the bins for the filter. It's a Integral or Iterable of Integral or Iterable of Real value that you can access after creating a Filter instance." }, { "instruction": "What is the id attribute of a Filter?", "input": "OpenMC Python API Filter attribute id", "output": "The id attribute of a Filter contains unique identifier for the filter. It's a int value that you can access after creating a Filter instance." }, { "instruction": "What is the num_bins attribute of a Filter?", "input": "OpenMC Python API Filter attribute num_bins", "output": "The num_bins attribute of a Filter contains the number of filter bins. It's a Integral value that you can access after creating a Filter instance." }, { "instruction": "What is the shape attribute of a Filter?", "input": "OpenMC Python API Filter attribute shape", "output": "The shape attribute of a Filter contains the shape of the filter. It's a tuple value that you can access after creating a Filter instance." }, { "instruction": "How do you call the __init__() method in the Filter class?", "input": "OpenMC Python API Filter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, bins: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the __eq__() method in the Filter class?", "input": "OpenMC Python API Filter.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __gt__() method in the Filter class?", "input": "OpenMC Python API Filter.__gt__() method signature", "output": "To call the __gt__() method, use: def __gt__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __lt__() method in the Filter class?", "input": "OpenMC Python API Filter.__lt__() method signature", "output": "To call the __lt__() method, use: def __lt__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __hash__() method in the Filter class?", "input": "OpenMC Python API Filter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the Filter class?", "input": "OpenMC Python API Filter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the _recursive_subclasses() method do in the Filter class?", "input": "OpenMC Python API Filter._recursive_subclasses() method", "output": "The _recursive_subclasses() method return all subclasses and their subclasses, etc.. It's used for filter operations." }, { "instruction": "How do you call the _recursive_subclasses() method in the Filter class?", "input": "OpenMC Python API Filter._recursive_subclasses() method signature", "output": "To call the _recursive_subclasses() method, use: @classmethod def _recursive_subclasses(cls: Any). It takes 1 parameters." }, { "instruction": "What does the from_hdf5() method do in the Filter class?", "input": "OpenMC Python API Filter.from_hdf5() method", "output": "The from_hdf5() method construct a new filter instance from hdf5 data. It's used for filter operations." }, { "instruction": "How do you call the from_hdf5() method in the Filter class?", "input": "OpenMC Python API Filter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Filter.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from keyword arguments -----------------. It should be a h5py.Group value." }, { "instruction": "What does the meshes parameter do in the from_hdf5() method?", "input": "OpenMC Python API Filter.from_hdf5() parameter meshes", "output": "The meshes parameter dictionary mapping integer ids to openmc.meshbase objects. only used for openmc.meshfilter objects.. It should be a dict value." }, { "instruction": "How do you call the bins() method in the Filter class?", "input": "OpenMC Python API Filter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bins() method in the Filter class?", "input": "OpenMC Python API Filter.bins() method signature", "output": "To call the bins() method, use: @bins.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_bins() method in the Filter class?", "input": "OpenMC Python API Filter.num_bins() method signature", "output": "To call the num_bins() method, use: @property def num_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the shape() method in the Filter class?", "input": "OpenMC Python API Filter.shape() method signature", "output": "To call the shape() method, use: @property def shape(self: Any). It takes 1 parameters." }, { "instruction": "What does the check_bins() method do in the Filter class?", "input": "OpenMC Python API Filter.check_bins() method", "output": "The check_bins() method make sure given bins are valid for this filter. It's used for filter operations." }, { "instruction": "How do you call the check_bins() method in the Filter class?", "input": "OpenMC Python API Filter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the Filter class?", "input": "OpenMC Python API Filter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for filter operations." }, { "instruction": "How do you call the to_xml_element() method in the Filter class?", "input": "OpenMC Python API Filter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Filter class?", "input": "OpenMC Python API Filter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing filter data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Filter class?", "input": "OpenMC Python API Filter.from_xml_element() method", "output": "The from_xml_element() method generate a filter from an xml element. It's used for filter operations." }, { "instruction": "How do you call the from_xml_element() method in the Filter class?", "input": "OpenMC Python API Filter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Filter.from_xml_element() parameter elem", "output": "The elem parameter xml element **kwargs keyword arguments (e.g., mesh information). It should be a lxml.etree._Element value." }, { "instruction": "What does the can_merge() method do in the Filter class?", "input": "OpenMC Python API Filter.can_merge() method", "output": "The can_merge() method determine if filter can be merged with another. It's used for filter operations." }, { "instruction": "How do you call the can_merge() method in the Filter class?", "input": "OpenMC Python API Filter.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the can_merge() method?", "input": "OpenMC Python API Filter.can_merge() parameter other", "output": "The other parameter filter to compare with. It should be a openmc.Filter value." }, { "instruction": "What does the merge() method do in the Filter class?", "input": "OpenMC Python API Filter.merge() method", "output": "The merge() method merge this filter with another. It's used for filter operations." }, { "instruction": "How do you call the merge() method in the Filter class?", "input": "OpenMC Python API Filter.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API Filter.merge() parameter other", "output": "The other parameter filter to merge with. It should be a openmc.Filter value." }, { "instruction": "What does the merge() method return in the Filter class?", "input": "OpenMC Python API Filter.merge() return value", "output": "The merge() method returns filter resulting from the merge. The return type is openmc.Filter." }, { "instruction": "What does the is_subset() method do in the Filter class?", "input": "OpenMC Python API Filter.is_subset() method", "output": "The is_subset() method determine if another filter is a subset of this filter. if all of the bins in the other filter are included as bins in this filter, then it is a subset of this filter. It's used for filter operations." }, { "instruction": "How do you call the is_subset() method in the Filter class?", "input": "OpenMC Python API Filter.is_subset() method signature", "output": "To call the is_subset() method, use: def is_subset(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the is_subset() method?", "input": "OpenMC Python API Filter.is_subset() parameter other", "output": "The other parameter the filter to query as a subset of this filter. It should be a openmc.Filter value." }, { "instruction": "What does the get_bin_index() method do in the Filter class?", "input": "OpenMC Python API Filter.get_bin_index() method", "output": "The get_bin_index() method returns the index in the filter for some bin. It's used for filter operations." }, { "instruction": "How do you call the get_bin_index() method in the Filter class?", "input": "OpenMC Python API Filter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "What does the filter_bin parameter do in the get_bin_index() method?", "input": "OpenMC Python API Filter.get_bin_index() parameter filter_bin", "output": "The filter_bin parameter the bin is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. the bin is an integer for the cell instance id for 'distribcell' filters. the bin is a 2-tuple of floats for 'energy' and 'energyout' filters corresponding to the energy boundaries of the bin of interest. the bin is an (x,y,z) 3-tuple for 'mesh' filters corresponding to the mesh cell of interest.. It should be a int or tuple value." }, { "instruction": "What does the get_bin_index() method return in the Filter class?", "input": "OpenMC Python API Filter.get_bin_index() return value", "output": "The get_bin_index() method returns the index in the tally data array for this filter bin.. The return type is int." }, { "instruction": "What does the get_pandas_dataframe() method do in the Filter class?", "input": "OpenMC Python API Filter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the filter's bins. this method constructs a pandas dataframe object for the filter with columns annotated by filter bin information. this is a helper method for :meth:`tally.get_pandas_dataframe`. It's used for filter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the Filter class?", "input": "OpenMC Python API Filter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Filter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Filter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter keyword arguments -----------------. It should be a int value." }, { "instruction": "What does the paths parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Filter.get_pandas_dataframe() parameter paths", "output": "The paths parameter only used for distribcellfilter. if true (default), expand distribcell indices into multi-index columns describing the path to that distribcell through the csg tree. note: this option assumes that all distribcell paths are of the same length and do not have the same universes and cells but different lattice cell indices.. It should be a bool value." }, { "instruction": "What is the WithIDFilter class in OpenMC's Python API?", "input": "OpenMC Python API WithIDFilter class", "output": "The WithIDFilter class represents abstract parent for filters of types with ids (cell, material, etc.).. It provides 2 methods and 0 properties for working with withidfilter data in OpenMC." }, { "instruction": "What does the WithIDFilter class do in OpenMC's Python API?", "input": "OpenMC Python API WithIDFilter class description", "output": "The WithIDFilter class abstract parent for filters of types with ids (cell, material, etc.).. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the WithIDFilter class?", "input": "OpenMC Python API WithIDFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, bins: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the check_bins() method in the WithIDFilter class?", "input": "OpenMC Python API WithIDFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the UniverseFilter class in OpenMC's Python API?", "input": "OpenMC Python API UniverseFilter class", "output": "The UniverseFilter class represents bins tally event locations based on the universe they occurred in. It provides 0 methods and 0 properties for working with universefilter data in OpenMC." }, { "instruction": "What does the UniverseFilter class do in OpenMC's Python API?", "input": "OpenMC Python API UniverseFilter class description", "output": "The UniverseFilter class bins tally event locations based on the universe they occurred in. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a UniverseFilter?", "input": "OpenMC Python API UniverseFilter constructor parameter bins", "output": "When creating a UniverseFilter, the bins parameter specifies the universes to tally. either :class:`openmc.universebase` objects or their integral id numbers can be used.. It should be a openmc.UniverseBase, int, or iterable thereof value." }, { "instruction": "What does the filter_id parameter do when creating a UniverseFilter?", "input": "OpenMC Python API UniverseFilter constructor parameter filter_id", "output": "When creating a UniverseFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a UniverseFilter?", "input": "OpenMC Python API UniverseFilter attribute bins", "output": "The bins attribute of a UniverseFilter contains openmc.universebase ids.. It's a Iterable of Integral value that you can access after creating a UniverseFilter instance." }, { "instruction": "What is the id attribute of a UniverseFilter?", "input": "OpenMC Python API UniverseFilter attribute id", "output": "The id attribute of a UniverseFilter contains unique identifier for the filter. It's a int value that you can access after creating a UniverseFilter instance." }, { "instruction": "What is the num_bins attribute of a UniverseFilter?", "input": "OpenMC Python API UniverseFilter attribute num_bins", "output": "The num_bins attribute of a UniverseFilter contains the number of filter bins. It's a Integral value that you can access after creating a UniverseFilter instance." }, { "instruction": "What is the MaterialFilter class in OpenMC's Python API?", "input": "OpenMC Python API MaterialFilter class", "output": "The MaterialFilter class represents bins tally event locations based on the material they occurred in. It provides 0 methods and 0 properties for working with materialfilter data in OpenMC." }, { "instruction": "What does the MaterialFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MaterialFilter class description", "output": "The MaterialFilter class bins tally event locations based on the material they occurred in. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a MaterialFilter?", "input": "OpenMC Python API MaterialFilter constructor parameter bins", "output": "When creating a MaterialFilter, the bins parameter specifies the material(s) to tally. either :class:`openmc.material` objects or their integral id numbers can be used.. It should be a openmc.Material, Integral, or iterable thereof value." }, { "instruction": "What does the filter_id parameter do when creating a MaterialFilter?", "input": "OpenMC Python API MaterialFilter constructor parameter filter_id", "output": "When creating a MaterialFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a MaterialFilter?", "input": "OpenMC Python API MaterialFilter attribute bins", "output": "The bins attribute of a MaterialFilter contains openmc.material ids.. It's a Iterable of Integral value that you can access after creating a MaterialFilter instance." }, { "instruction": "What is the id attribute of a MaterialFilter?", "input": "OpenMC Python API MaterialFilter attribute id", "output": "The id attribute of a MaterialFilter contains unique identifier for the filter. It's a int value that you can access after creating a MaterialFilter instance." }, { "instruction": "What is the num_bins attribute of a MaterialFilter?", "input": "OpenMC Python API MaterialFilter attribute num_bins", "output": "The num_bins attribute of a MaterialFilter contains the number of filter bins. It's a Integral value that you can access after creating a MaterialFilter instance." }, { "instruction": "What is the MaterialFromFilter class in OpenMC's Python API?", "input": "OpenMC Python API MaterialFromFilter class", "output": "The MaterialFromFilter class represents bins tally event locations based on the material they occurred in. It provides 0 methods and 0 properties for working with materialfromfilter data in OpenMC." }, { "instruction": "What does the MaterialFromFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MaterialFromFilter class description", "output": "The MaterialFromFilter class bins tally event locations based on the material they occurred in. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a MaterialFromFilter?", "input": "OpenMC Python API MaterialFromFilter constructor parameter bins", "output": "When creating a MaterialFromFilter, the bins parameter specifies the material(s) to tally. either :class:`openmc.material` objects or their integral id numbers can be used.. It should be a openmc.Material, Integral, or iterable thereof value." }, { "instruction": "What does the filter_id parameter do when creating a MaterialFromFilter?", "input": "OpenMC Python API MaterialFromFilter constructor parameter filter_id", "output": "When creating a MaterialFromFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a MaterialFromFilter?", "input": "OpenMC Python API MaterialFromFilter attribute bins", "output": "The bins attribute of a MaterialFromFilter contains openmc.material ids.. It's a Iterable of Integral value that you can access after creating a MaterialFromFilter instance." }, { "instruction": "What is the id attribute of a MaterialFromFilter?", "input": "OpenMC Python API MaterialFromFilter attribute id", "output": "The id attribute of a MaterialFromFilter contains unique identifier for the filter. It's a int value that you can access after creating a MaterialFromFilter instance." }, { "instruction": "What is the num_bins attribute of a MaterialFromFilter?", "input": "OpenMC Python API MaterialFromFilter attribute num_bins", "output": "The num_bins attribute of a MaterialFromFilter contains the number of filter bins. It's a Integral value that you can access after creating a MaterialFromFilter instance." }, { "instruction": "What is the CellFilter class in OpenMC's Python API?", "input": "OpenMC Python API CellFilter class", "output": "The CellFilter class represents bins tally event locations based on the cell they occurred in. It provides 0 methods and 0 properties for working with cellfilter data in OpenMC." }, { "instruction": "What does the CellFilter class do in OpenMC's Python API?", "input": "OpenMC Python API CellFilter class description", "output": "The CellFilter class bins tally event locations based on the cell they occurred in. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a CellFilter?", "input": "OpenMC Python API CellFilter constructor parameter bins", "output": "When creating a CellFilter, the bins parameter specifies the cells to tally. either :class:`openmc.cell` objects or their id numbers can be used.. It should be a openmc.Cell, int, or iterable thereof value." }, { "instruction": "What does the filter_id parameter do when creating a CellFilter?", "input": "OpenMC Python API CellFilter constructor parameter filter_id", "output": "When creating a CellFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a CellFilter?", "input": "OpenMC Python API CellFilter attribute bins", "output": "The bins attribute of a CellFilter contains openmc.cell ids.. It's a Iterable of Integral value that you can access after creating a CellFilter instance." }, { "instruction": "What is the id attribute of a CellFilter?", "input": "OpenMC Python API CellFilter attribute id", "output": "The id attribute of a CellFilter contains unique identifier for the filter. It's a int value that you can access after creating a CellFilter instance." }, { "instruction": "What is the num_bins attribute of a CellFilter?", "input": "OpenMC Python API CellFilter attribute num_bins", "output": "The num_bins attribute of a CellFilter contains the number of filter bins. It's a Integral value that you can access after creating a CellFilter instance." }, { "instruction": "What is the CellFromFilter class in OpenMC's Python API?", "input": "OpenMC Python API CellFromFilter class", "output": "The CellFromFilter class represents bins tally on which cell the particle came from. It provides 0 methods and 0 properties for working with cellfromfilter data in OpenMC." }, { "instruction": "What does the CellFromFilter class do in OpenMC's Python API?", "input": "OpenMC Python API CellFromFilter class description", "output": "The CellFromFilter class bins tally on which cell the particle came from. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a CellFromFilter?", "input": "OpenMC Python API CellFromFilter constructor parameter bins", "output": "When creating a CellFromFilter, the bins parameter specifies the cell(s) to tally. either :class:`openmc.cell` objects or their integral id numbers can be used.. It should be a openmc.Cell, Integral, or iterable thereof value." }, { "instruction": "What does the filter_id parameter do when creating a CellFromFilter?", "input": "OpenMC Python API CellFromFilter constructor parameter filter_id", "output": "When creating a CellFromFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a CellFromFilter?", "input": "OpenMC Python API CellFromFilter attribute bins", "output": "The bins attribute of a CellFromFilter contains cell ids.. It's a Integral or Iterable of Integral value that you can access after creating a CellFromFilter instance." }, { "instruction": "What is the id attribute of a CellFromFilter?", "input": "OpenMC Python API CellFromFilter attribute id", "output": "The id attribute of a CellFromFilter contains unique identifier for the filter. It's a int value that you can access after creating a CellFromFilter instance." }, { "instruction": "What is the num_bins attribute of a CellFromFilter?", "input": "OpenMC Python API CellFromFilter attribute num_bins", "output": "The num_bins attribute of a CellFromFilter contains the number of filter bins. It's a Integral value that you can access after creating a CellFromFilter instance." }, { "instruction": "What is the CellBornFilter class in OpenMC's Python API?", "input": "OpenMC Python API CellBornFilter class", "output": "The CellBornFilter class represents bins tally events based on which cell the particle was born in. It provides 0 methods and 0 properties for working with cellbornfilter data in OpenMC." }, { "instruction": "What does the CellBornFilter class do in OpenMC's Python API?", "input": "OpenMC Python API CellBornFilter class description", "output": "The CellBornFilter class bins tally events based on which cell the particle was born in. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a CellBornFilter?", "input": "OpenMC Python API CellBornFilter constructor parameter bins", "output": "When creating a CellBornFilter, the bins parameter specifies the birth cells to tally. either :class:`openmc.cell` objects or their integral id numbers can be used.. It should be a openmc.Cell, Integral, or iterable thereof value." }, { "instruction": "What does the filter_id parameter do when creating a CellBornFilter?", "input": "OpenMC Python API CellBornFilter constructor parameter filter_id", "output": "When creating a CellBornFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a CellBornFilter?", "input": "OpenMC Python API CellBornFilter attribute bins", "output": "The bins attribute of a CellBornFilter contains cell ids.. It's a Iterable of Integral value that you can access after creating a CellBornFilter instance." }, { "instruction": "What is the id attribute of a CellBornFilter?", "input": "OpenMC Python API CellBornFilter attribute id", "output": "The id attribute of a CellBornFilter contains unique identifier for the filter. It's a int value that you can access after creating a CellBornFilter instance." }, { "instruction": "What is the num_bins attribute of a CellBornFilter?", "input": "OpenMC Python API CellBornFilter attribute num_bins", "output": "The num_bins attribute of a CellBornFilter contains the number of filter bins. It's a Integral value that you can access after creating a CellBornFilter instance." }, { "instruction": "What is the CellInstanceFilter class in OpenMC's Python API?", "input": "OpenMC Python API CellInstanceFilter class", "output": "The CellInstanceFilter class represents bins tally events based on which cell instance a particle is in. this filter is similar to :class:`distribcellfilter` but allows one to select particular instances to be tallied (instead of obtaining *all* instances by default) and allows instances from different cells to be specified in a single filter. .. versionadded:: 0.12. It provides 5 methods and 0 properties for working with cellinstancefilter data in OpenMC." }, { "instruction": "What does the CellInstanceFilter class do in OpenMC's Python API?", "input": "OpenMC Python API CellInstanceFilter class description", "output": "The CellInstanceFilter class bins tally events based on which cell instance a particle is in. this filter is similar to :class:`distribcellfilter` but allows one to select particular instances to be tallied (instead of obtaining *all* instances by default) and allows instances from different cells to be specified in a single filter. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a CellInstanceFilter?", "input": "OpenMC Python API CellInstanceFilter constructor parameter bins", "output": "When creating a CellInstanceFilter, the bins parameter specifies the cell instances to tally, given as 2-tuples. for the first value in the tuple, either openmc.cell objects or their integral id numbers can be used. the second value indicates the cell instance.. It should be a iterable of 2-tuples or numpy.ndarray value." }, { "instruction": "What does the filter_id parameter do when creating a CellInstanceFilter?", "input": "OpenMC Python API CellInstanceFilter constructor parameter filter_id", "output": "When creating a CellInstanceFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a CellInstanceFilter?", "input": "OpenMC Python API CellInstanceFilter attribute bins", "output": "The bins attribute of a CellInstanceFilter contains 2d numpy array of cell ids and instances. It's a numpy.ndarray value that you can access after creating a CellInstanceFilter instance." }, { "instruction": "What is the id attribute of a CellInstanceFilter?", "input": "OpenMC Python API CellInstanceFilter attribute id", "output": "The id attribute of a CellInstanceFilter contains unique identifier for the filter. It's a int value that you can access after creating a CellInstanceFilter instance." }, { "instruction": "What is the num_bins attribute of a CellInstanceFilter?", "input": "OpenMC Python API CellInstanceFilter attribute num_bins", "output": "The num_bins attribute of a CellInstanceFilter contains the number of filter bins see also -------- distribcellfilter. It's a Integral value that you can access after creating a CellInstanceFilter instance." }, { "instruction": "How do you call the __init__() method in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, bins: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the bins() method in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.bins() method signature", "output": "To call the bins() method, use: @.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What does the get_pandas_dataframe() method do in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the filter's bins. this method constructs a pandas dataframe object for the filter with columns annotated by filter bin information. this is a helper method for :meth:`tally.get_pandas_dataframe`. It's used for cellinstancefilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API CellInstanceFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API CellInstanceFilter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter. It should be a int value." }, { "instruction": "What does the to_xml_element() method do in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for cellinstancefilter operations." }, { "instruction": "How do you call the to_xml_element() method in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the CellInstanceFilter class?", "input": "OpenMC Python API CellInstanceFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the SurfaceFilter class in OpenMC's Python API?", "input": "OpenMC Python API SurfaceFilter class", "output": "The SurfaceFilter class represents filters particles by surface crossing. It provides 0 methods and 0 properties for working with surfacefilter data in OpenMC." }, { "instruction": "What does the SurfaceFilter class do in OpenMC's Python API?", "input": "OpenMC Python API SurfaceFilter class description", "output": "The SurfaceFilter class filters particles by surface crossing. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a SurfaceFilter?", "input": "OpenMC Python API SurfaceFilter constructor parameter bins", "output": "When creating a SurfaceFilter, the bins parameter specifies the surfaces to tally over. either openmc.surface objects or their id numbers can be used.. It should be a openmc.Surface, int, or iterable of Integral value." }, { "instruction": "What does the filter_id parameter do when creating a SurfaceFilter?", "input": "OpenMC Python API SurfaceFilter constructor parameter filter_id", "output": "When creating a SurfaceFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a SurfaceFilter?", "input": "OpenMC Python API SurfaceFilter attribute bins", "output": "The bins attribute of a SurfaceFilter contains the surfaces to tally over. either openmc.surface objects or their id numbers can be used.. It's a Iterable of Integral value that you can access after creating a SurfaceFilter instance." }, { "instruction": "What is the id attribute of a SurfaceFilter?", "input": "OpenMC Python API SurfaceFilter attribute id", "output": "The id attribute of a SurfaceFilter contains unique identifier for the filter. It's a int value that you can access after creating a SurfaceFilter instance." }, { "instruction": "What is the num_bins attribute of a SurfaceFilter?", "input": "OpenMC Python API SurfaceFilter attribute num_bins", "output": "The num_bins attribute of a SurfaceFilter contains the number of filter bins. It's a Integral value that you can access after creating a SurfaceFilter instance." }, { "instruction": "What is the ParticleFilter class in OpenMC's Python API?", "input": "OpenMC Python API ParticleFilter class", "output": "The ParticleFilter class represents bins tally events based on the particle type. It provides 4 methods and 0 properties for working with particlefilter data in OpenMC." }, { "instruction": "What does the ParticleFilter class do in OpenMC's Python API?", "input": "OpenMC Python API ParticleFilter class description", "output": "The ParticleFilter class bins tally events based on the particle type. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a ParticleFilter?", "input": "OpenMC Python API ParticleFilter constructor parameter bins", "output": "When creating a ParticleFilter, the bins parameter specifies the particles to tally represented as strings ('neutron', 'photon', 'electron', 'positron').. It should be a str, or sequence of str value." }, { "instruction": "What does the filter_id parameter do when creating a ParticleFilter?", "input": "OpenMC Python API ParticleFilter constructor parameter filter_id", "output": "When creating a ParticleFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a ParticleFilter?", "input": "OpenMC Python API ParticleFilter attribute bins", "output": "The bins attribute of a ParticleFilter contains the particles to tally. It's a sequence of str value that you can access after creating a ParticleFilter instance." }, { "instruction": "What is the id attribute of a ParticleFilter?", "input": "OpenMC Python API ParticleFilter attribute id", "output": "The id attribute of a ParticleFilter contains unique identifier for the filter. It's a int value that you can access after creating a ParticleFilter instance." }, { "instruction": "What is the num_bins attribute of a ParticleFilter?", "input": "OpenMC Python API ParticleFilter attribute num_bins", "output": "The num_bins attribute of a ParticleFilter contains the number of filter bins. It's a Integral value that you can access after creating a ParticleFilter instance." }, { "instruction": "How do you call the __eq__() method in the ParticleFilter class?", "input": "OpenMC Python API ParticleFilter.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the bins() method in the ParticleFilter class?", "input": "OpenMC Python API ParticleFilter.bins() method signature", "output": "To call the bins() method, use: @.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_hdf5() method in the ParticleFilter class?", "input": "OpenMC Python API ParticleFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_xml_element() method in the ParticleFilter class?", "input": "OpenMC Python API ParticleFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the ParentNuclideFilter class in OpenMC's Python API?", "input": "OpenMC Python API ParentNuclideFilter class", "output": "The ParentNuclideFilter class represents bins tally events based on the parent nuclide. It provides 1 methods and 0 properties for working with parentnuclidefilter data in OpenMC." }, { "instruction": "What does the ParentNuclideFilter class do in OpenMC's Python API?", "input": "OpenMC Python API ParentNuclideFilter class description", "output": "The ParentNuclideFilter class bins tally events based on the parent nuclide. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a ParentNuclideFilter?", "input": "OpenMC Python API ParentNuclideFilter constructor parameter bins", "output": "When creating a ParentNuclideFilter, the bins parameter specifies names of nuclides (e.g., 'ni65'). It should be a str, or iterable of str value." }, { "instruction": "What does the filter_id parameter do when creating a ParentNuclideFilter?", "input": "OpenMC Python API ParentNuclideFilter constructor parameter filter_id", "output": "When creating a ParentNuclideFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a ParentNuclideFilter?", "input": "OpenMC Python API ParentNuclideFilter attribute bins", "output": "The bins attribute of a ParentNuclideFilter contains names of nuclides. It's a iterable of str value that you can access after creating a ParentNuclideFilter instance." }, { "instruction": "What is the id attribute of a ParentNuclideFilter?", "input": "OpenMC Python API ParentNuclideFilter attribute id", "output": "The id attribute of a ParentNuclideFilter contains unique identifier for the filter. It's a int value that you can access after creating a ParentNuclideFilter instance." }, { "instruction": "What is the num_bins attribute of a ParentNuclideFilter?", "input": "OpenMC Python API ParentNuclideFilter attribute num_bins", "output": "The num_bins attribute of a ParentNuclideFilter contains the number of filter bins. It's a Integral value that you can access after creating a ParentNuclideFilter instance." }, { "instruction": "How do you call the bins() method in the ParentNuclideFilter class?", "input": "OpenMC Python API ParentNuclideFilter.bins() method signature", "output": "To call the bins() method, use: @.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the MeshFilter class in OpenMC's Python API?", "input": "OpenMC Python API MeshFilter class", "output": "The MeshFilter class represents bins tally event locations by mesh elements. It provides 13 methods and 0 properties for working with meshfilter data in OpenMC." }, { "instruction": "What does the MeshFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MeshFilter class description", "output": "The MeshFilter class bins tally event locations by mesh elements. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshFilter?", "input": "OpenMC Python API MeshFilter constructor parameter mesh", "output": "When creating a MeshFilter, the mesh parameter specifies the mesh object that events will be tallied onto. It should be a openmc.MeshBase value." }, { "instruction": "What does the filter_id parameter do when creating a MeshFilter?", "input": "OpenMC Python API MeshFilter constructor parameter filter_id", "output": "When creating a MeshFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the mesh attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute mesh", "output": "The mesh attribute of a MeshFilter contains the mesh object that events will be tallied onto. It's a openmc.MeshBase value that you can access after creating a MeshFilter instance." }, { "instruction": "What is the id attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute id", "output": "The id attribute of a MeshFilter contains unique identifier for the filter. It's a int value that you can access after creating a MeshFilter instance." }, { "instruction": "What is the translation attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute translation", "output": "The translation attribute of a MeshFilter contains this array specifies a vector that is used to translate (shift) the mesh for this filter. It's a Iterable of float value that you can access after creating a MeshFilter instance." }, { "instruction": "What is the bins attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute bins", "output": "The bins attribute of a MeshFilter contains a list of mesh indices for each filter bin, e.g. [(1, 1, 1), (2, 1, 1), ...]. It's a list of tuple value that you can access after creating a MeshFilter instance." }, { "instruction": "What is the num_bins attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute num_bins", "output": "The num_bins attribute of a MeshFilter contains the number of filter bins. It's a Integral value that you can access after creating a MeshFilter instance." }, { "instruction": "How do you call the __init__() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the __hash__() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_hdf5() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "How do you call the mesh() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, mesh: Any). It takes 2 parameters." }, { "instruction": "How do you call the shape() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.shape() method signature", "output": "To call the shape() method, use: @property def shape(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the translation() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.translation() method signature", "output": "To call the translation() method, use: @property def translation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the translation() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.translation() method signature", "output": "To call the translation() method, use: @translation.setter def translation(self: Any, t: Any). It takes 2 parameters." }, { "instruction": "How do you call the can_merge() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the get_pandas_dataframe() method do in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the filter's bins. this method constructs a pandas dataframe object for the filter with columns annotated by filter bin information. this is a helper method for :meth:`tally.get_pandas_dataframe`. It's used for meshfilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshFilter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter. It should be a int value." }, { "instruction": "What does the to_xml_element() method do in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for meshfilter operations." }, { "instruction": "How do you call the to_xml_element() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What is the MeshBornFilter class in OpenMC's Python API?", "input": "OpenMC Python API MeshBornFilter class", "output": "The MeshBornFilter class represents filter events by the mesh cell a particle originated from. It provides 0 methods and 0 properties for working with meshbornfilter data in OpenMC." }, { "instruction": "What does the MeshBornFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MeshBornFilter class description", "output": "The MeshBornFilter class filter events by the mesh cell a particle originated from. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter constructor parameter mesh", "output": "When creating a MeshBornFilter, the mesh parameter specifies the mesh object that events will be tallied onto. It should be a openmc.MeshBase value." }, { "instruction": "What does the filter_id parameter do when creating a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter constructor parameter filter_id", "output": "When creating a MeshBornFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the mesh attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute mesh", "output": "The mesh attribute of a MeshBornFilter contains the mesh object that events will be tallied onto. It's a openmc.MeshBase value that you can access after creating a MeshBornFilter instance." }, { "instruction": "What is the id attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute id", "output": "The id attribute of a MeshBornFilter contains unique identifier for the filter. It's a int value that you can access after creating a MeshBornFilter instance." }, { "instruction": "What is the translation attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute translation", "output": "The translation attribute of a MeshBornFilter contains this array specifies a vector that is used to translate (shift) the mesh for this filter. It's a Iterable of float value that you can access after creating a MeshBornFilter instance." }, { "instruction": "What is the bins attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute bins", "output": "The bins attribute of a MeshBornFilter contains a list of mesh indices for each filter bin, e.g. [(1, 1, 1), (2, 1, 1), ...]. It's a list of tuple value that you can access after creating a MeshBornFilter instance." }, { "instruction": "What is the num_bins attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute num_bins", "output": "The num_bins attribute of a MeshBornFilter contains the number of filter bins. It's a Integral value that you can access after creating a MeshBornFilter instance." }, { "instruction": "What is the MeshSurfaceFilter class in OpenMC's Python API?", "input": "OpenMC Python API MeshSurfaceFilter class", "output": "The MeshSurfaceFilter class represents filter events by surface crossings on a mesh. It provides 2 methods and 0 properties for working with meshsurfacefilter data in OpenMC." }, { "instruction": "What does the MeshSurfaceFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MeshSurfaceFilter class description", "output": "The MeshSurfaceFilter class filter events by surface crossings on a mesh. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter constructor parameter mesh", "output": "When creating a MeshSurfaceFilter, the mesh parameter specifies the mesh object that events will be tallied onto. It should be a openmc.MeshBase value." }, { "instruction": "What does the filter_id parameter do when creating a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter constructor parameter filter_id", "output": "When creating a MeshSurfaceFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the mesh attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute mesh", "output": "The mesh attribute of a MeshSurfaceFilter contains the mesh object that events will be tallied onto. It's a openmc.MeshBase value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "What is the translation attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute translation", "output": "The translation attribute of a MeshSurfaceFilter contains this array specifies a vector that is used to translate (shift) the mesh for this filter. It's a Iterable of float value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "What is the id attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute id", "output": "The id attribute of a MeshSurfaceFilter contains unique identifier for the filter. It's a int value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "What is the bins attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute bins", "output": "The bins attribute of a MeshSurfaceFilter contains a list of mesh indices / surfaces for each filter bin, e.g. [(1, 1, 'x-min out'), (1, 1, 'x-min in'), ...]. It's a list of tuple value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "What is the num_bins attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute num_bins", "output": "The num_bins attribute of a MeshSurfaceFilter contains the number of filter bins. It's a Integral value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "How do you call the mesh() method in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.mesh() method signature", "output": "To call the mesh() method, use: @.setter def mesh(self: Any, mesh: Any). It takes 2 parameters." }, { "instruction": "What does the get_pandas_dataframe() method do in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the filter's bins. this method constructs a pandas dataframe object for the filter with columns annotated by filter bin information. this is a helper method for :meth:`tally.get_pandas_dataframe`. It's used for meshsurfacefilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshSurfaceFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshSurfaceFilter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter. It should be a int value." }, { "instruction": "What is the CollisionFilter class in OpenMC's Python API?", "input": "OpenMC Python API CollisionFilter class", "output": "The CollisionFilter class represents bins tally events based on the number of collisions. .. versionadded:: 0.12.2. It provides 2 methods and 0 properties for working with collisionfilter data in OpenMC." }, { "instruction": "What does the CollisionFilter class do in OpenMC's Python API?", "input": "OpenMC Python API CollisionFilter class description", "output": "The CollisionFilter class bins tally events based on the number of collisions. .. versionadded:: 0.12.2. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a CollisionFilter?", "input": "OpenMC Python API CollisionFilter constructor parameter bins", "output": "When creating a CollisionFilter, the bins parameter specifies a list or iterable of the number of collisions, as integer values. the events whose post-scattering collision number equals one of the provided values will be counted.. It should be a Iterable of int value." }, { "instruction": "What does the filter_id parameter do when creating a CollisionFilter?", "input": "OpenMC Python API CollisionFilter constructor parameter filter_id", "output": "When creating a CollisionFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the id attribute of a CollisionFilter?", "input": "OpenMC Python API CollisionFilter attribute id", "output": "The id attribute of a CollisionFilter contains unique identifier for the filter. It's a int value that you can access after creating a CollisionFilter instance." }, { "instruction": "What is the bins attribute of a CollisionFilter?", "input": "OpenMC Python API CollisionFilter attribute bins", "output": "The bins attribute of a CollisionFilter contains an array of integer values representing the number of collisions events by which to filter. It's a numpy.ndarray value that you can access after creating a CollisionFilter instance." }, { "instruction": "What is the num_bins attribute of a CollisionFilter?", "input": "OpenMC Python API CollisionFilter attribute num_bins", "output": "The num_bins attribute of a CollisionFilter contains the number of filter bins. It's a int value that you can access after creating a CollisionFilter instance." }, { "instruction": "How do you call the __init__() method in the CollisionFilter class?", "input": "OpenMC Python API CollisionFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, bins: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the check_bins() method in the CollisionFilter class?", "input": "OpenMC Python API CollisionFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the RealFilter class in OpenMC's Python API?", "input": "OpenMC Python API RealFilter class", "output": "The RealFilter class represents tally modifier that describes phase-space and other characteristics. It provides 12 methods and 0 properties for working with realfilter data in OpenMC." }, { "instruction": "What does the RealFilter class do in OpenMC's Python API?", "input": "OpenMC Python API RealFilter class description", "output": "The RealFilter class tally modifier that describes phase-space and other characteristics. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a RealFilter?", "input": "OpenMC Python API RealFilter constructor parameter values", "output": "When creating a RealFilter, the values parameter specifies a list of values for which each successive pair constitutes a range of values for a single bin. It should be a iterable of float value." }, { "instruction": "What does the filter_id parameter do when creating a RealFilter?", "input": "OpenMC Python API RealFilter constructor parameter filter_id", "output": "When creating a RealFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a RealFilter?", "input": "OpenMC Python API RealFilter attribute values", "output": "The values attribute of a RealFilter contains an array of values for which each successive pair constitutes a range of values for a single bin. It's a numpy.ndarray value that you can access after creating a RealFilter instance." }, { "instruction": "What is the id attribute of a RealFilter?", "input": "OpenMC Python API RealFilter attribute id", "output": "The id attribute of a RealFilter contains unique identifier for the filter. It's a int value that you can access after creating a RealFilter instance." }, { "instruction": "What is the bins attribute of a RealFilter?", "input": "OpenMC Python API RealFilter attribute bins", "output": "The bins attribute of a RealFilter contains an array of shape (n, 2) where each row is a pair of values indicating a filter bin range. It's a numpy.ndarray value that you can access after creating a RealFilter instance." }, { "instruction": "What is the num_bins attribute of a RealFilter?", "input": "OpenMC Python API RealFilter attribute num_bins", "output": "The num_bins attribute of a RealFilter contains the number of filter bins. It's a int value that you can access after creating a RealFilter instance." }, { "instruction": "How do you call the __init__() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, values: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the __gt__() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.__gt__() method signature", "output": "To call the __gt__() method, use: def __gt__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bins() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.bins() method signature", "output": "To call the bins() method, use: @.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the check_bins() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the can_merge() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the merge() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the is_subset() method do in the RealFilter class?", "input": "OpenMC Python API RealFilter.is_subset() method", "output": "The is_subset() method determine if another filter is a subset of this filter. if all of the bins in the other filter are included as bins in this filter, then it is a subset of this filter. It's used for realfilter operations." }, { "instruction": "How do you call the is_subset() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.is_subset() method signature", "output": "To call the is_subset() method, use: def is_subset(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the is_subset() method?", "input": "OpenMC Python API RealFilter.is_subset() parameter other", "output": "The other parameter the filter to query as a subset of this filter. It should be a openmc.Filter value." }, { "instruction": "How do you call the get_bin_index() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "What does the get_pandas_dataframe() method do in the RealFilter class?", "input": "OpenMC Python API RealFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the filter's bins. this method constructs a pandas dataframe object for the filter with columns annotated by filter bin information. this is a helper method for :meth:`tally.get_pandas_dataframe`. It's used for realfilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API RealFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API RealFilter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter. It should be a int value." }, { "instruction": "What does the to_xml_element() method do in the RealFilter class?", "input": "OpenMC Python API RealFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for realfilter operations." }, { "instruction": "How do you call the to_xml_element() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the RealFilter class?", "input": "OpenMC Python API RealFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the RealFilter class?", "input": "OpenMC Python API RealFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the EnergyFilter class in OpenMC's Python API?", "input": "OpenMC Python API EnergyFilter class", "output": "The EnergyFilter class represents bins tally events based on incident particle energy. It provides 6 methods and 0 properties for working with energyfilter data in OpenMC." }, { "instruction": "What does the EnergyFilter class do in OpenMC's Python API?", "input": "OpenMC Python API EnergyFilter class description", "output": "The EnergyFilter class bins tally events based on incident particle energy. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a EnergyFilter?", "input": "OpenMC Python API EnergyFilter constructor parameter values", "output": "When creating a EnergyFilter, the values parameter specifies a list of values for which each successive pair constitutes a range of energies in [ev] for a single bin. entries must be positive and ascending.. It should be a Iterable of Real value." }, { "instruction": "What does the filter_id parameter do when creating a EnergyFilter?", "input": "OpenMC Python API EnergyFilter constructor parameter filter_id", "output": "When creating a EnergyFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a EnergyFilter?", "input": "OpenMC Python API EnergyFilter attribute values", "output": "The values attribute of a EnergyFilter contains an array of values for which each successive pair constitutes a range of energies in [ev] for a single bin. It's a numpy.ndarray value that you can access after creating a EnergyFilter instance." }, { "instruction": "What is the id attribute of a EnergyFilter?", "input": "OpenMC Python API EnergyFilter attribute id", "output": "The id attribute of a EnergyFilter contains unique identifier for the filter. It's a int value that you can access after creating a EnergyFilter instance." }, { "instruction": "What is the bins attribute of a EnergyFilter?", "input": "OpenMC Python API EnergyFilter attribute bins", "output": "The bins attribute of a EnergyFilter contains an array of shape (n, 2) where each row is a pair of energies in [ev] for a single filter bin. It's a numpy.ndarray value that you can access after creating a EnergyFilter instance." }, { "instruction": "What is the num_bins attribute of a EnergyFilter?", "input": "OpenMC Python API EnergyFilter attribute num_bins", "output": "The num_bins attribute of a EnergyFilter contains the number of filter bins. It's a int value that you can access after creating a EnergyFilter instance." }, { "instruction": "How do you call the __init__() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, values: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the get_bin_index() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "How do you call the check_bins() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What does the get_tabular() method do in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.get_tabular() method", "output": "The get_tabular() method create a tabulated distribution based on tally results with an energy filter this method provides an easy way to create a distribution in energy (e.g., a source spectrum) based on tally results that were obtained from using an :class:`~openmc.energyfilter`. .. versionadded:: 0.13.3. It's used for energyfilter operations." }, { "instruction": "How do you call the get_tabular() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.get_tabular() method signature", "output": "To call the get_tabular() method, use: def get_tabular(self: Any, values: Any). It takes 2 parameters." }, { "instruction": "What does the values parameter do in the get_tabular() method?", "input": "OpenMC Python API EnergyFilter.get_tabular() parameter values", "output": "The values parameter array of numeric values, typically from a tally result **kwargs keyword arguments passed to :class:`openmc.stats.tabular`. It should be a iterable of float value." }, { "instruction": "What does the lethargy_bin_width() method do in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.lethargy_bin_width() method", "output": "The lethargy_bin_width() method calculates the base 10 log width of energy bins which is useful when plotting the normalized flux. It's used for energyfilter operations." }, { "instruction": "How do you call the lethargy_bin_width() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.lethargy_bin_width() method signature", "output": "To call the lethargy_bin_width() method, use: @property def lethargy_bin_width(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_group_structure() method do in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.from_group_structure() method", "output": "The from_group_structure() method construct an energyfilter instance from a standard group structure. .. versionadded:: 0.13.1. It's used for energyfilter operations." }, { "instruction": "How do you call the from_group_structure() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.from_group_structure() method signature", "output": "To call the from_group_structure() method, use: @classmethod def from_group_structure(cls: Any, group_structure: Any). It takes 2 parameters." }, { "instruction": "What does the group_structure parameter do in the from_group_structure() method?", "input": "OpenMC Python API EnergyFilter.from_group_structure() parameter group_structure", "output": "The group_structure parameter name of the group structure. must be a valid key of openmc.mgxs.group_structures dictionary.. It should be a str value." }, { "instruction": "What is the EnergyoutFilter class in OpenMC's Python API?", "input": "OpenMC Python API EnergyoutFilter class", "output": "The EnergyoutFilter class represents bins tally events based on outgoing particle energy. It provides 0 methods and 0 properties for working with energyoutfilter data in OpenMC." }, { "instruction": "What does the EnergyoutFilter class do in OpenMC's Python API?", "input": "OpenMC Python API EnergyoutFilter class description", "output": "The EnergyoutFilter class bins tally events based on outgoing particle energy. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a EnergyoutFilter?", "input": "OpenMC Python API EnergyoutFilter constructor parameter values", "output": "When creating a EnergyoutFilter, the values parameter specifies a list of values for which each successive pair constitutes a range of energies in [ev] for a single bin. It should be a Iterable of Real value." }, { "instruction": "What does the filter_id parameter do when creating a EnergyoutFilter?", "input": "OpenMC Python API EnergyoutFilter constructor parameter filter_id", "output": "When creating a EnergyoutFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a EnergyoutFilter?", "input": "OpenMC Python API EnergyoutFilter attribute values", "output": "The values attribute of a EnergyoutFilter contains an array of values for which each successive pair constitutes a range of energies in [ev] for a single bin. It's a numpy.ndarray value that you can access after creating a EnergyoutFilter instance." }, { "instruction": "What is the id attribute of a EnergyoutFilter?", "input": "OpenMC Python API EnergyoutFilter attribute id", "output": "The id attribute of a EnergyoutFilter contains unique identifier for the filter. It's a int value that you can access after creating a EnergyoutFilter instance." }, { "instruction": "What is the bins attribute of a EnergyoutFilter?", "input": "OpenMC Python API EnergyoutFilter attribute bins", "output": "The bins attribute of a EnergyoutFilter contains an array of shape (n, 2) where each row is a pair of energies in [ev] for a single filter bin. It's a numpy.ndarray value that you can access after creating a EnergyoutFilter instance." }, { "instruction": "What is the num_bins attribute of a EnergyoutFilter?", "input": "OpenMC Python API EnergyoutFilter attribute num_bins", "output": "The num_bins attribute of a EnergyoutFilter contains the number of filter bins. It's a int value that you can access after creating a EnergyoutFilter instance." }, { "instruction": "What is the TimeFilter class in OpenMC's Python API?", "input": "OpenMC Python API TimeFilter class", "output": "The TimeFilter class represents bins tally events based on the particle's time. .. versionadded:: 0.13.0. It provides 2 methods and 0 properties for working with timefilter data in OpenMC." }, { "instruction": "What does the TimeFilter class do in OpenMC's Python API?", "input": "OpenMC Python API TimeFilter class description", "output": "The TimeFilter class bins tally events based on the particle's time. .. versionadded:: 0.13.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a TimeFilter?", "input": "OpenMC Python API TimeFilter constructor parameter values", "output": "When creating a TimeFilter, the values parameter specifies a list of values for which each successive pair constitutes a range of time in [s] for a single bin. It should be a iterable of float value." }, { "instruction": "What does the filter_id parameter do when creating a TimeFilter?", "input": "OpenMC Python API TimeFilter constructor parameter filter_id", "output": "When creating a TimeFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a TimeFilter?", "input": "OpenMC Python API TimeFilter attribute values", "output": "The values attribute of a TimeFilter contains an array of values for which each successive pair constitutes a range of time in [s] for a single bin. It's a numpy.ndarray value that you can access after creating a TimeFilter instance." }, { "instruction": "What is the id attribute of a TimeFilter?", "input": "OpenMC Python API TimeFilter attribute id", "output": "The id attribute of a TimeFilter contains unique identifier for the filter. It's a int value that you can access after creating a TimeFilter instance." }, { "instruction": "What is the bins attribute of a TimeFilter?", "input": "OpenMC Python API TimeFilter attribute bins", "output": "The bins attribute of a TimeFilter contains an array of shape (n, 2) where each row is a pair of time in [s] for a single filter bin. It's a numpy.ndarray value that you can access after creating a TimeFilter instance." }, { "instruction": "What is the num_bins attribute of a TimeFilter?", "input": "OpenMC Python API TimeFilter attribute num_bins", "output": "The num_bins attribute of a TimeFilter contains the number of filter bins. It's a int value that you can access after creating a TimeFilter instance." }, { "instruction": "How do you call the get_bin_index() method in the TimeFilter class?", "input": "OpenMC Python API TimeFilter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "How do you call the check_bins() method in the TimeFilter class?", "input": "OpenMC Python API TimeFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the DistribcellFilter class in OpenMC's Python API?", "input": "OpenMC Python API DistribcellFilter class", "output": "The DistribcellFilter class represents bins tally event locations on instances of repeated cells. this filter provides a separate score for each unique instance of a repeated cell in a geometry. note that only one cell can be specified in this filter. the related :class:`cellinstancefilter` allows one to obtain scores for particular cell instances as well as instances from different cells. It provides 9 methods and 0 properties for working with distribcellfilter data in OpenMC." }, { "instruction": "What does the DistribcellFilter class do in OpenMC's Python API?", "input": "OpenMC Python API DistribcellFilter class description", "output": "The DistribcellFilter class bins tally event locations on instances of repeated cells. this filter provides a separate score for each unique instance of a repeated cell in a geometry. note that only one cell can be specified in this filter. the related :class:`cellinstancefilter` allows one to obtain scores for particular cell instances as well as instances from different cells. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the cell parameter do when creating a DistribcellFilter?", "input": "OpenMC Python API DistribcellFilter constructor parameter cell", "output": "When creating a DistribcellFilter, the cell parameter specifies the distributed cell to tally. either an openmc.cell or an integral cell id number can be used.. It should be a openmc.Cell or Integral value." }, { "instruction": "What does the filter_id parameter do when creating a DistribcellFilter?", "input": "OpenMC Python API DistribcellFilter constructor parameter filter_id", "output": "When creating a DistribcellFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a DistribcellFilter?", "input": "OpenMC Python API DistribcellFilter attribute bins", "output": "The bins attribute of a DistribcellFilter contains an iterable with one element---the id of the distributed cell.. It's a Iterable of Integral value that you can access after creating a DistribcellFilter instance." }, { "instruction": "What is the id attribute of a DistribcellFilter?", "input": "OpenMC Python API DistribcellFilter attribute id", "output": "The id attribute of a DistribcellFilter contains unique identifier for the filter. It's a int value that you can access after creating a DistribcellFilter instance." }, { "instruction": "What is the num_bins attribute of a DistribcellFilter?", "input": "OpenMC Python API DistribcellFilter attribute num_bins", "output": "The num_bins attribute of a DistribcellFilter contains the number of filter bins. It's a int value that you can access after creating a DistribcellFilter instance." }, { "instruction": "What is the paths attribute of a DistribcellFilter?", "input": "OpenMC Python API DistribcellFilter attribute paths", "output": "The paths attribute of a DistribcellFilter contains the paths traversed through the csg tree to reach each distribcell instance (for 'distribcell' filters only) see also -------- cellinstancefilter. It's a list of str value that you can access after creating a DistribcellFilter instance." }, { "instruction": "How do you call the __init__() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, cell: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the from_hdf5() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_bins() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.num_bins() method signature", "output": "To call the num_bins() method, use: @property def num_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the paths() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.paths() method signature", "output": "To call the paths() method, use: @property def paths(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the paths() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.paths() method signature", "output": "To call the paths() method, use: @paths.setter def paths(self: Any, paths: Any). It takes 2 parameters." }, { "instruction": "How do you call the bins() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.bins() method signature", "output": "To call the bins() method, use: @.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the can_merge() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the get_bin_index() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "What does the get_pandas_dataframe() method do in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the filter's bins. this method constructs a pandas dataframe object for the filter with columns annotated by filter bin information. this is a helper method for :meth:`tally.get_pandas_dataframe`. It's used for distribcellfilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the DistribcellFilter class?", "input": "OpenMC Python API DistribcellFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API DistribcellFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API DistribcellFilter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter keyword arguments -----------------. It should be a int value." }, { "instruction": "What does the paths parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API DistribcellFilter.get_pandas_dataframe() parameter paths", "output": "The paths parameter if true (default), expand distribcell indices into multi-index columns describing the path to that distribcell through the csg tree. note: this option assumes that all distribcell paths are of the same length and do not have the same universes and cells but different lattice cell indices.. It should be a bool value." }, { "instruction": "What is the MuFilter class in OpenMC's Python API?", "input": "OpenMC Python API MuFilter class", "output": "The MuFilter class represents bins tally events based on particle scattering angle. It provides 2 methods and 0 properties for working with mufilter data in OpenMC." }, { "instruction": "What does the MuFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MuFilter class description", "output": "The MuFilter class bins tally events based on particle scattering angle. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a MuFilter?", "input": "OpenMC Python API MuFilter constructor parameter values", "output": "When creating a MuFilter, the values parameter specifies a grid of scattering angles which events will binned into. values represent the cosine of the scattering angle. if an iterable is given, the values will be used explicitly as grid points. if a single int is given, the range [-1, 1] will be divided up equally into that number of bins.. It should be a int or Iterable of Real value." }, { "instruction": "What does the filter_id parameter do when creating a MuFilter?", "input": "OpenMC Python API MuFilter constructor parameter filter_id", "output": "When creating a MuFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a MuFilter?", "input": "OpenMC Python API MuFilter attribute values", "output": "The values attribute of a MuFilter contains an array of values for which each successive pair constitutes a range of scattering angle cosines for a single bin. It's a numpy.ndarray value that you can access after creating a MuFilter instance." }, { "instruction": "What is the id attribute of a MuFilter?", "input": "OpenMC Python API MuFilter attribute id", "output": "The id attribute of a MuFilter contains unique identifier for the filter. It's a int value that you can access after creating a MuFilter instance." }, { "instruction": "What is the bins attribute of a MuFilter?", "input": "OpenMC Python API MuFilter attribute bins", "output": "The bins attribute of a MuFilter contains an array of shape (n, 2) where each row is a pair of scattering angle cosines for a single filter bin. It's a numpy.ndarray value that you can access after creating a MuFilter instance." }, { "instruction": "What is the num_bins attribute of a MuFilter?", "input": "OpenMC Python API MuFilter attribute num_bins", "output": "The num_bins attribute of a MuFilter contains the number of filter bins. It's a Integral value that you can access after creating a MuFilter instance." }, { "instruction": "How do you call the __init__() method in the MuFilter class?", "input": "OpenMC Python API MuFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, values: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the check_bins() method in the MuFilter class?", "input": "OpenMC Python API MuFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the MuSurfaceFilter class in OpenMC's Python API?", "input": "OpenMC Python API MuSurfaceFilter class", "output": "The MuSurfaceFilter class represents bins tally events based on the angle of surface crossing. this filter bins events based on the cosine of the angle between the direction of the particle and the normal to the surface at the point it crosses. only used in conjunction with a surfacefilter and current score. .. versionadded:: 0.15.1. It provides 0 methods and 0 properties for working with musurfacefilter data in OpenMC." }, { "instruction": "What does the MuSurfaceFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MuSurfaceFilter class description", "output": "The MuSurfaceFilter class bins tally events based on the angle of surface crossing. this filter bins events based on the cosine of the angle between the direction of the particle and the normal to the surface at the point it crosses. only used in conjunction with a surfacefilter and current score. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a MuSurfaceFilter?", "input": "OpenMC Python API MuSurfaceFilter constructor parameter values", "output": "When creating a MuSurfaceFilter, the values parameter specifies a grid of surface crossing angles which the events will be divided into. values represent the cosine of the angle between the direction of the particle and the normal to the surface at the point it crosses. if an iterable is given, the values will be used explicitly as grid points. if a single int is given, the range [-1, 1] will be divided equally into that number of bins.. It should be a int or Iterable of Real value." }, { "instruction": "What does the filter_id parameter do when creating a MuSurfaceFilter?", "input": "OpenMC Python API MuSurfaceFilter constructor parameter filter_id", "output": "When creating a MuSurfaceFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a MuSurfaceFilter?", "input": "OpenMC Python API MuSurfaceFilter attribute values", "output": "The values attribute of a MuSurfaceFilter contains an array of values for which each successive pair constitutes a range of surface crossing angle cosines for a single bin.. It's a numpy.ndarray value that you can access after creating a MuSurfaceFilter instance." }, { "instruction": "What is the id attribute of a MuSurfaceFilter?", "input": "OpenMC Python API MuSurfaceFilter attribute id", "output": "The id attribute of a MuSurfaceFilter contains unique identifier for the filter. It's a int value that you can access after creating a MuSurfaceFilter instance." }, { "instruction": "What is the bins attribute of a MuSurfaceFilter?", "input": "OpenMC Python API MuSurfaceFilter attribute bins", "output": "The bins attribute of a MuSurfaceFilter contains an array of shape (n, 2) where each row is a pair of cosines of surface crossing angle for a single filter. It's a numpy.ndarray value that you can access after creating a MuSurfaceFilter instance." }, { "instruction": "What is the num_bins attribute of a MuSurfaceFilter?", "input": "OpenMC Python API MuSurfaceFilter attribute num_bins", "output": "The num_bins attribute of a MuSurfaceFilter contains the number of filter bins. It's a Integral value that you can access after creating a MuSurfaceFilter instance." }, { "instruction": "What is the PolarFilter class in OpenMC's Python API?", "input": "OpenMC Python API PolarFilter class", "output": "The PolarFilter class represents bins tally events based on the incident particle's direction. It provides 2 methods and 0 properties for working with polarfilter data in OpenMC." }, { "instruction": "What does the PolarFilter class do in OpenMC's Python API?", "input": "OpenMC Python API PolarFilter class description", "output": "The PolarFilter class bins tally events based on the incident particle's direction. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a PolarFilter?", "input": "OpenMC Python API PolarFilter constructor parameter values", "output": "When creating a PolarFilter, the values parameter specifies a grid of polar angles which events will binned into. values represent an angle in radians relative to the z-axis. if an iterable is given, the values will be used explicitly as grid points. if a single int is given, the range [0, pi] will be divided up equally into that number of bins.. It should be a int or Iterable of Real value." }, { "instruction": "What does the filter_id parameter do when creating a PolarFilter?", "input": "OpenMC Python API PolarFilter constructor parameter filter_id", "output": "When creating a PolarFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a PolarFilter?", "input": "OpenMC Python API PolarFilter attribute values", "output": "The values attribute of a PolarFilter contains an array of values for which each successive pair constitutes a range of polar angles in [rad] for a single bin. It's a numpy.ndarray value that you can access after creating a PolarFilter instance." }, { "instruction": "What is the id attribute of a PolarFilter?", "input": "OpenMC Python API PolarFilter attribute id", "output": "The id attribute of a PolarFilter contains unique identifier for the filter. It's a int value that you can access after creating a PolarFilter instance." }, { "instruction": "What is the bins attribute of a PolarFilter?", "input": "OpenMC Python API PolarFilter attribute bins", "output": "The bins attribute of a PolarFilter contains an array of shape (n, 2) where each row is a pair of polar angles for a single filter bin. It's a numpy.ndarray value that you can access after creating a PolarFilter instance." }, { "instruction": "What is the id attribute of a PolarFilter?", "input": "OpenMC Python API PolarFilter attribute id", "output": "The id attribute of a PolarFilter contains unique identifier for the filter. It's a int value that you can access after creating a PolarFilter instance." }, { "instruction": "What is the num_bins attribute of a PolarFilter?", "input": "OpenMC Python API PolarFilter attribute num_bins", "output": "The num_bins attribute of a PolarFilter contains the number of filter bins. It's a Integral value that you can access after creating a PolarFilter instance." }, { "instruction": "How do you call the __init__() method in the PolarFilter class?", "input": "OpenMC Python API PolarFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, values: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the check_bins() method in the PolarFilter class?", "input": "OpenMC Python API PolarFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the AzimuthalFilter class in OpenMC's Python API?", "input": "OpenMC Python API AzimuthalFilter class", "output": "The AzimuthalFilter class represents bins tally events based on the incident particle's direction. It provides 2 methods and 0 properties for working with azimuthalfilter data in OpenMC." }, { "instruction": "What does the AzimuthalFilter class do in OpenMC's Python API?", "input": "OpenMC Python API AzimuthalFilter class description", "output": "The AzimuthalFilter class bins tally events based on the incident particle's direction. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the values parameter do when creating a AzimuthalFilter?", "input": "OpenMC Python API AzimuthalFilter constructor parameter values", "output": "When creating a AzimuthalFilter, the values parameter specifies a grid of azimuthal angles which events will binned into. values represent an angle in radians relative to the x-axis and perpendicular to the z-axis. if an iterable is given, the values will be used explicitly as grid points. if a single int is given, the range [-pi, pi) will be divided up equally into that number of bins.. It should be a int or Iterable of Real value." }, { "instruction": "What does the filter_id parameter do when creating a AzimuthalFilter?", "input": "OpenMC Python API AzimuthalFilter constructor parameter filter_id", "output": "When creating a AzimuthalFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the values attribute of a AzimuthalFilter?", "input": "OpenMC Python API AzimuthalFilter attribute values", "output": "The values attribute of a AzimuthalFilter contains an array of values for which each successive pair constitutes a range of azimuthal angles in [rad] for a single bin. It's a numpy.ndarray value that you can access after creating a AzimuthalFilter instance." }, { "instruction": "What is the id attribute of a AzimuthalFilter?", "input": "OpenMC Python API AzimuthalFilter attribute id", "output": "The id attribute of a AzimuthalFilter contains unique identifier for the filter. It's a int value that you can access after creating a AzimuthalFilter instance." }, { "instruction": "What is the bins attribute of a AzimuthalFilter?", "input": "OpenMC Python API AzimuthalFilter attribute bins", "output": "The bins attribute of a AzimuthalFilter contains an array of shape (n, 2) where each row is a pair of azimuthal angles for a single filter bin. It's a numpy.ndarray value that you can access after creating a AzimuthalFilter instance." }, { "instruction": "What is the num_bins attribute of a AzimuthalFilter?", "input": "OpenMC Python API AzimuthalFilter attribute num_bins", "output": "The num_bins attribute of a AzimuthalFilter contains the number of filter bins. It's a Integral value that you can access after creating a AzimuthalFilter instance." }, { "instruction": "How do you call the __init__() method in the AzimuthalFilter class?", "input": "OpenMC Python API AzimuthalFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, values: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the check_bins() method in the AzimuthalFilter class?", "input": "OpenMC Python API AzimuthalFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the DelayedGroupFilter class in OpenMC's Python API?", "input": "OpenMC Python API DelayedGroupFilter class", "output": "The DelayedGroupFilter class represents bins fission events based on the produced neutron precursor groups. It provides 1 methods and 0 properties for working with delayedgroupfilter data in OpenMC." }, { "instruction": "What does the DelayedGroupFilter class do in OpenMC's Python API?", "input": "OpenMC Python API DelayedGroupFilter class description", "output": "The DelayedGroupFilter class bins fission events based on the produced neutron precursor groups. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the bins parameter do when creating a DelayedGroupFilter?", "input": "OpenMC Python API DelayedGroupFilter constructor parameter bins", "output": "When creating a DelayedGroupFilter, the bins parameter specifies the delayed neutron precursor groups. for example, endf/b-vii.1 uses 6 precursor groups so a tally with all groups will have bins = [1, 2, 3, 4, 5, 6].. It should be a iterable of int value." }, { "instruction": "What does the filter_id parameter do when creating a DelayedGroupFilter?", "input": "OpenMC Python API DelayedGroupFilter constructor parameter filter_id", "output": "When creating a DelayedGroupFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the bins attribute of a DelayedGroupFilter?", "input": "OpenMC Python API DelayedGroupFilter attribute bins", "output": "The bins attribute of a DelayedGroupFilter contains the delayed neutron precursor groups. for example, endf/b-vii.1 uses 6 precursor groups so a tally with all groups will have bins = [1, 2, 3, 4, 5, 6].. It's a iterable of int value that you can access after creating a DelayedGroupFilter instance." }, { "instruction": "What is the id attribute of a DelayedGroupFilter?", "input": "OpenMC Python API DelayedGroupFilter attribute id", "output": "The id attribute of a DelayedGroupFilter contains unique identifier for the filter. It's a int value that you can access after creating a DelayedGroupFilter instance." }, { "instruction": "What is the num_bins attribute of a DelayedGroupFilter?", "input": "OpenMC Python API DelayedGroupFilter attribute num_bins", "output": "The num_bins attribute of a DelayedGroupFilter contains the number of filter bins. It's a Integral value that you can access after creating a DelayedGroupFilter instance." }, { "instruction": "How do you call the check_bins() method in the DelayedGroupFilter class?", "input": "OpenMC Python API DelayedGroupFilter.check_bins() method signature", "output": "To call the check_bins() method, use: def check_bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "What is the EnergyFunctionFilter class in OpenMC's Python API?", "input": "OpenMC Python API EnergyFunctionFilter class", "output": "The EnergyFunctionFilter class represents multiplies tally scores by an arbitrary function of incident energy. the arbitrary function is described by a piecewise linear-linear interpolation of energy and y values. values outside of the given energy range will be evaluated as zero. It provides 23 methods and 0 properties for working with energyfunctionfilter data in OpenMC." }, { "instruction": "What does the EnergyFunctionFilter class do in OpenMC's Python API?", "input": "OpenMC Python API EnergyFunctionFilter class description", "output": "The EnergyFunctionFilter class multiplies tally scores by an arbitrary function of incident energy. the arbitrary function is described by a piecewise linear-linear interpolation of energy and y values. values outside of the given energy range will be evaluated as zero. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy parameter do when creating a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter constructor parameter energy", "output": "When creating a EnergyFunctionFilter, the energy parameter specifies a grid of energy values in [ev]. It should be a Iterable of Real value." }, { "instruction": "What does the y parameter do when creating a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter constructor parameter y", "output": "When creating a EnergyFunctionFilter, the y parameter specifies a grid of interpolant values in [ev]. It should be a iterable of Real value." }, { "instruction": "What does the interpolation parameter do when creating a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter constructor parameter interpolation", "output": "When creating a EnergyFunctionFilter, the interpolation parameter specifies interpolation scheme: {'histogram', 'linear-linear', 'linear-log', 'log-linear', 'log-log', 'quadratic', 'cubic'}. It should be a str value." }, { "instruction": "What does the filter_id parameter do when creating a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter constructor parameter filter_id", "output": "When creating a EnergyFunctionFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int value." }, { "instruction": "What is the energy attribute of a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter attribute energy", "output": "The energy attribute of a EnergyFunctionFilter contains a grid of energy values in [ev]. It's a Iterable of Real value that you can access after creating a EnergyFunctionFilter instance." }, { "instruction": "What is the y attribute of a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter attribute y", "output": "The y attribute of a EnergyFunctionFilter contains a grid of interpolant values in [ev]. It's a iterable of Real value that you can access after creating a EnergyFunctionFilter instance." }, { "instruction": "What is the interpolation attribute of a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter attribute interpolation", "output": "The interpolation attribute of a EnergyFunctionFilter contains interpolation scheme: {'histogram', 'linear-linear', 'linear-log', 'log-linear', 'log-log', 'quadratic', 'cubic'}. It's a str value that you can access after creating a EnergyFunctionFilter instance." }, { "instruction": "What is the id attribute of a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter attribute id", "output": "The id attribute of a EnergyFunctionFilter contains unique identifier for the filter. It's a int value that you can access after creating a EnergyFunctionFilter instance." }, { "instruction": "What is the num_bins attribute of a EnergyFunctionFilter?", "input": "OpenMC Python API EnergyFunctionFilter attribute num_bins", "output": "The num_bins attribute of a EnergyFunctionFilter contains the number of filter bins (always 1 for this filter). It's a Integral value that you can access after creating a EnergyFunctionFilter instance." }, { "instruction": "How do you call the __init__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy: Any, y: Any, interpolation: Any, filter_id: Any). It takes 5 parameters." }, { "instruction": "How do you call the __eq__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __gt__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__gt__() method signature", "output": "To call the __gt__() method, use: def __gt__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __lt__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__lt__() method signature", "output": "To call the __lt__() method, use: def __lt__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __hash__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_hdf5() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the from_tabulated1d() method do in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.from_tabulated1d() method", "output": "The from_tabulated1d() method construct a filter from a tabulated1d object. It's used for energyfunctionfilter operations." }, { "instruction": "How do you call the from_tabulated1d() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.from_tabulated1d() method signature", "output": "To call the from_tabulated1d() method, use: @classmethod def from_tabulated1d(cls: Any, tab1d: Any). It takes 2 parameters." }, { "instruction": "What does the tab1d parameter do in the from_tabulated1d() method?", "input": "OpenMC Python API EnergyFunctionFilter.from_tabulated1d() parameter tab1d", "output": "The tab1d parameter a linear-linear tabulated1d object with only a single interpolation region.. It should be a openmc.data.Tabulated1D value." }, { "instruction": "How do you call the energy() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the y() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.y() method signature", "output": "To call the y() method, use: @property def y(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the y() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.y() method signature", "output": "To call the y() method, use: @y.setter def y(self: Any, y: Any). It takes 2 parameters." }, { "instruction": "How do you call the interpolation() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, val: Any). It takes 2 parameters." }, { "instruction": "How do you call the bins() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bins() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.bins() method signature", "output": "To call the bins() method, use: @bins.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_bins() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.num_bins() method signature", "output": "To call the num_bins() method, use: @property def num_bins(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for energyfunctionfilter operations." }, { "instruction": "How do you call the to_xml_element() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "How do you call the can_merge() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the is_subset() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.is_subset() method signature", "output": "To call the is_subset() method, use: def is_subset(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the get_bin_index() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.get_bin_index() method signature", "output": "To call the get_bin_index() method, use: def get_bin_index(self: Any, filter_bin: Any). It takes 2 parameters." }, { "instruction": "What does the get_pandas_dataframe() method do in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method builds a pandas dataframe for the filter's bins. this method constructs a pandas dataframe object for the filter with columns annotated by filter bin information. this is a helper method for :meth:`tally.get_pandas_dataframe`. It's used for energyfunctionfilter operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, data_size: Any, stride: Any). It takes 3 parameters." }, { "instruction": "What does the data_size parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API EnergyFunctionFilter.get_pandas_dataframe() parameter data_size", "output": "The data_size parameter the total number of bins in the tally corresponding to this filter. It should be a int value." }, { "instruction": "What does the stride parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API EnergyFunctionFilter.get_pandas_dataframe() parameter stride", "output": "The stride parameter stride in memory for the filter. It should be a int value." }, { "instruction": "How do you call the _repeat_and_tile() function in OpenMC's Python API?", "input": "OpenMC Python API _repeat_and_tile() function signature", "output": "To call the _repeat_and_tile() function, use: def _repeat_and_tile(bins: Any, repeat_factor: Any, data_size: Any). It takes 3 parameters." }, { "instruction": "How do you call the CellbornFilter() function in OpenMC's Python API?", "input": "OpenMC Python API CellbornFilter() function signature", "output": "To call the CellbornFilter() function, use: def CellbornFilter(). It takes 0 parameters." }, { "instruction": "What does the _path_to_levels() function do in OpenMC's Python API?", "input": "OpenMC Python API _path_to_levels() function", "output": "The _path_to_levels() function convert distribcell path to list of levels. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _path_to_levels() function in OpenMC's Python API?", "input": "OpenMC Python API _path_to_levels() function purpose", "output": "The _path_to_levels() function convert distribcell path to list of levels. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _path_to_levels() function in OpenMC's Python API?", "input": "OpenMC Python API _path_to_levels() function signature", "output": "To call the _path_to_levels() function, use: def _path_to_levels(path: Any). It takes 1 parameters." }, { "instruction": "What does the path parameter do in the _path_to_levels() function?", "input": "OpenMC Python API _path_to_levels() parameter path", "output": "The path parameter distribcell path. It should be a str value." }, { "instruction": "What is the ExpansionFilter class in OpenMC's Python API?", "input": "OpenMC Python API ExpansionFilter class", "output": "The ExpansionFilter class represents abstract filter class for functional expansions.. It provides 7 methods and 0 properties for working with expansionfilter data in OpenMC." }, { "instruction": "What does the ExpansionFilter class do in OpenMC's Python API?", "input": "OpenMC Python API ExpansionFilter class description", "output": "The ExpansionFilter class abstract filter class for functional expansions.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the __eq__() method in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the order() method in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.order() method signature", "output": "To call the order() method, use: @order.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for expansionfilter operations." }, { "instruction": "How do you call the to_xml_element() method in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing legendre filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the merge() method do in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.merge() method", "output": "The merge() method merge this filter with another. this overrides the behavior of the parent filter class, since its merging technique is to take the union of the set of bins of each filter. that technique does not apply to expansion filters, since the argument should be the maximum filter order rather than the list of all bins. It's used for expansionfilter operations." }, { "instruction": "How do you call the merge() method in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API ExpansionFilter.merge() parameter other", "output": "The other parameter filter to merge with. It should be a openmc.Filter value." }, { "instruction": "What does the merge() method return in the ExpansionFilter class?", "input": "OpenMC Python API ExpansionFilter.merge() return value", "output": "The merge() method returns filter resulting from the merge. The return type is openmc.Filter." }, { "instruction": "What is the LegendreFilter class in OpenMC's Python API?", "input": "OpenMC Python API LegendreFilter class", "output": "The LegendreFilter class represents score legendre expansion moments up to specified order. this filter allows scores to be multiplied by legendre polynomials of the change in particle angle (:math:`\\mu`) up to a user-specified order. It provides 4 methods and 0 properties for working with legendrefilter data in OpenMC." }, { "instruction": "What does the LegendreFilter class do in OpenMC's Python API?", "input": "OpenMC Python API LegendreFilter class description", "output": "The LegendreFilter class score legendre expansion moments up to specified order. this filter allows scores to be multiplied by legendre polynomials of the change in particle angle (:math:`\\mu`) up to a user-specified order. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the order parameter do when creating a LegendreFilter?", "input": "OpenMC Python API LegendreFilter constructor parameter order", "output": "When creating a LegendreFilter, the order parameter specifies maximum legendre polynomial order. It should be a int value." }, { "instruction": "What does the filter_id parameter do when creating a LegendreFilter?", "input": "OpenMC Python API LegendreFilter constructor parameter filter_id", "output": "When creating a LegendreFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int or None value." }, { "instruction": "What is the order attribute of a LegendreFilter?", "input": "OpenMC Python API LegendreFilter attribute order", "output": "The order attribute of a LegendreFilter contains maximum legendre polynomial order. It's a int value that you can access after creating a LegendreFilter instance." }, { "instruction": "What is the id attribute of a LegendreFilter?", "input": "OpenMC Python API LegendreFilter attribute id", "output": "The id attribute of a LegendreFilter contains unique identifier for the filter. It's a int value that you can access after creating a LegendreFilter instance." }, { "instruction": "What is the num_bins attribute of a LegendreFilter?", "input": "OpenMC Python API LegendreFilter attribute num_bins", "output": "The num_bins attribute of a LegendreFilter contains the number of filter bins. It's a int value that you can access after creating a LegendreFilter instance." }, { "instruction": "How do you call the __hash__() method in the LegendreFilter class?", "input": "OpenMC Python API LegendreFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the LegendreFilter class?", "input": "OpenMC Python API LegendreFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the LegendreFilter class?", "input": "OpenMC Python API LegendreFilter.order() method signature", "output": "To call the order() method, use: @.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_hdf5() method in the LegendreFilter class?", "input": "OpenMC Python API LegendreFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What is the SpatialLegendreFilter class in OpenMC's Python API?", "input": "OpenMC Python API SpatialLegendreFilter class", "output": "The SpatialLegendreFilter class represents score legendre expansion moments in space up to specified order. this filter allows scores to be multiplied by legendre polynomials of the the particle's position along a particular axis, normalized to a given range, up to a user-specified order. It provides 13 methods and 0 properties for working with spatiallegendrefilter data in OpenMC." }, { "instruction": "What does the SpatialLegendreFilter class do in OpenMC's Python API?", "input": "OpenMC Python API SpatialLegendreFilter class description", "output": "The SpatialLegendreFilter class score legendre expansion moments in space up to specified order. this filter allows scores to be multiplied by legendre polynomials of the the particle's position along a particular axis, normalized to a given range, up to a user-specified order. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the order parameter do when creating a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter constructor parameter order", "output": "When creating a SpatialLegendreFilter, the order parameter specifies maximum legendre polynomial order. It should be a int value." }, { "instruction": "What does the axis parameter do when creating a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter constructor parameter axis", "output": "When creating a SpatialLegendreFilter, the axis parameter specifies axis along which to take the expansion. It should be a {'x', 'y', 'z'} value." }, { "instruction": "What does the minimum parameter do when creating a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter constructor parameter minimum", "output": "When creating a SpatialLegendreFilter, the minimum parameter specifies minimum value along selected axis. It should be a float value." }, { "instruction": "What does the maximum parameter do when creating a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter constructor parameter maximum", "output": "When creating a SpatialLegendreFilter, the maximum parameter specifies maximum value along selected axis. It should be a float value." }, { "instruction": "What does the filter_id parameter do when creating a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter constructor parameter filter_id", "output": "When creating a SpatialLegendreFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int or None value." }, { "instruction": "What is the order attribute of a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter attribute order", "output": "The order attribute of a SpatialLegendreFilter contains maximum legendre polynomial order. It's a int value that you can access after creating a SpatialLegendreFilter instance." }, { "instruction": "What is the axis attribute of a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter attribute axis", "output": "The axis attribute of a SpatialLegendreFilter contains axis along which to take the expansion. It's a {'x', 'y', 'z'} value that you can access after creating a SpatialLegendreFilter instance." }, { "instruction": "What is the minimum attribute of a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter attribute minimum", "output": "The minimum attribute of a SpatialLegendreFilter contains minimum value along selected axis. It's a float value that you can access after creating a SpatialLegendreFilter instance." }, { "instruction": "What is the maximum attribute of a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter attribute maximum", "output": "The maximum attribute of a SpatialLegendreFilter contains maximum value along selected axis. It's a float value that you can access after creating a SpatialLegendreFilter instance." }, { "instruction": "What is the id attribute of a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter attribute id", "output": "The id attribute of a SpatialLegendreFilter contains unique identifier for the filter. It's a int value that you can access after creating a SpatialLegendreFilter instance." }, { "instruction": "What is the num_bins attribute of a SpatialLegendreFilter?", "input": "OpenMC Python API SpatialLegendreFilter attribute num_bins", "output": "The num_bins attribute of a SpatialLegendreFilter contains the number of filter bins. It's a int value that you can access after creating a SpatialLegendreFilter instance." }, { "instruction": "How do you call the __init__() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, axis: Any, minimum: Any, maximum: Any, filter_id: Any). It takes 6 parameters." }, { "instruction": "How do you call the __hash__() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.order() method signature", "output": "To call the order() method, use: @.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the axis() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.axis() method signature", "output": "To call the axis() method, use: @property def axis(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the axis() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.axis() method signature", "output": "To call the axis() method, use: @axis.setter def axis(self: Any, axis: Any). It takes 2 parameters." }, { "instruction": "How do you call the minimum() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.minimum() method signature", "output": "To call the minimum() method, use: @property def minimum(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the minimum() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.minimum() method signature", "output": "To call the minimum() method, use: @minimum.setter def minimum(self: Any, minimum: Any). It takes 2 parameters." }, { "instruction": "How do you call the maximum() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.maximum() method signature", "output": "To call the maximum() method, use: @property def maximum(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the maximum() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.maximum() method signature", "output": "To call the maximum() method, use: @maximum.setter def maximum(self: Any, maximum: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_hdf5() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for spatiallegendrefilter operations." }, { "instruction": "How do you call the to_xml_element() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing legendre filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the SphericalHarmonicsFilter class in OpenMC's Python API?", "input": "OpenMC Python API SphericalHarmonicsFilter class", "output": "The SphericalHarmonicsFilter class represents score spherical harmonic expansion moments up to specified order. this filter allows you to obtain real spherical harmonic moments of either the particle's direction or the cosine of the scattering angle. specifying a filter with order :math:`\\ell` tallies moments for all orders from 0 to :math:`\\ell`. It provides 9 methods and 0 properties for working with sphericalharmonicsfilter data in OpenMC." }, { "instruction": "What does the SphericalHarmonicsFilter class do in OpenMC's Python API?", "input": "OpenMC Python API SphericalHarmonicsFilter class description", "output": "The SphericalHarmonicsFilter class score spherical harmonic expansion moments up to specified order. this filter allows you to obtain real spherical harmonic moments of either the particle's direction or the cosine of the scattering angle. specifying a filter with order :math:`\\ell` tallies moments for all orders from 0 to :math:`\\ell`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the order parameter do when creating a SphericalHarmonicsFilter?", "input": "OpenMC Python API SphericalHarmonicsFilter constructor parameter order", "output": "When creating a SphericalHarmonicsFilter, the order parameter specifies maximum spherical harmonics order, :math:`\\ell`. It should be a int value." }, { "instruction": "What does the filter_id parameter do when creating a SphericalHarmonicsFilter?", "input": "OpenMC Python API SphericalHarmonicsFilter constructor parameter filter_id", "output": "When creating a SphericalHarmonicsFilter, the filter_id parameter specifies unique identifier for the filter. It should be a int or None value." }, { "instruction": "What is the order attribute of a SphericalHarmonicsFilter?", "input": "OpenMC Python API SphericalHarmonicsFilter attribute order", "output": "The order attribute of a SphericalHarmonicsFilter contains maximum spherical harmonics order, :math:`\\ell`. It's a int value that you can access after creating a SphericalHarmonicsFilter instance." }, { "instruction": "What is the id attribute of a SphericalHarmonicsFilter?", "input": "OpenMC Python API SphericalHarmonicsFilter attribute id", "output": "The id attribute of a SphericalHarmonicsFilter contains unique identifier for the filter. It's a int value that you can access after creating a SphericalHarmonicsFilter instance." }, { "instruction": "What is the cosine attribute of a SphericalHarmonicsFilter?", "input": "OpenMC Python API SphericalHarmonicsFilter attribute cosine", "output": "The cosine attribute of a SphericalHarmonicsFilter contains how to handle the cosine term.. It's a {'scatter', 'particle'} value that you can access after creating a SphericalHarmonicsFilter instance." }, { "instruction": "What is the num_bins attribute of a SphericalHarmonicsFilter?", "input": "OpenMC Python API SphericalHarmonicsFilter attribute num_bins", "output": "The num_bins attribute of a SphericalHarmonicsFilter contains the number of filter bins. It's a int value that you can access after creating a SphericalHarmonicsFilter instance." }, { "instruction": "How do you call the __init__() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, filter_id: Any). It takes 3 parameters." }, { "instruction": "How do you call the __hash__() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.order() method signature", "output": "To call the order() method, use: @.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the cosine() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.cosine() method signature", "output": "To call the cosine() method, use: @property def cosine(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cosine() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.cosine() method signature", "output": "To call the cosine() method, use: @cosine.setter def cosine(self: Any, cosine: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_hdf5() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for sphericalharmonicsfilter operations." }, { "instruction": "How do you call the to_xml_element() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing spherical harmonics filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the ZernikeFilter class in OpenMC's Python API?", "input": "OpenMC Python API ZernikeFilter class", "output": "The ZernikeFilter class represents score zernike expansion moments in space up to specified order. this filter allows scores to be multiplied by zernike polynomials of the particle's position normalized to a given unit circle, up to a user-specified order. the standard zernike polynomials follow the definition by born and wolf, *principles of optics* and are defined as .. math:: z_n^m(\\rho, \\theta) = r_n^m(\\rho) \\cos (m\\theta), \\quad m > 0 z_n^{m}(\\rho, \\theta) = r_n^{m}(\\rho) \\sin (m\\theta), \\quad m < 0 z_n^{m}(\\rho, \\theta) = r_n^{m}(\\rho), \\quad m = 0 where the radial polynomials are .. math:: r_n^m(\\rho) = \\sum\\limits_{k=0}^{(n-m)/2} \\frac{(-1)^k (n-k)!}{k! ( \\frac{n+m}{2} - k)! (\\frac{n-m}{2} - k)!} \\rho^{n-2k}. with this definition, the integral of :math:`(z_n^m)^2` over the unit disk is :math:`\\frac{\\epsilon_m\\pi}{2n+2}` for each polynomial where :math:`\\epsilon_m` is 2 if :math:`m` equals 0 and 1 otherwise. specifying a filter with order n tallies moments for all :math:`n` from 0 to n and each value of :math:`m`. the ordering of the zernike polynomial moments follows the ansi z80.28 standard, where the one-dimensional index :math:`j` corresponds to the :math:`n` and :math:`m` by .. math:: j = \\frac{n(n + 2) + m}{2}. It provides 13 methods and 0 properties for working with zernikefilter data in OpenMC." }, { "instruction": "What does the ZernikeFilter class do in OpenMC's Python API?", "input": "OpenMC Python API ZernikeFilter class description", "output": "The ZernikeFilter class score zernike expansion moments in space up to specified order. this filter allows scores to be multiplied by zernike polynomials of the particle's position normalized to a given unit circle, up to a user-specified order. the standard zernike polynomials follow the definition by born and wolf, *principles of optics* and are defined as .. math:: z_n^m(\\rho, \\theta) = r_n^m(\\rho) \\cos (m\\theta), \\quad m > 0 z_n^{m}(\\rho, \\theta) = r_n^{m}(\\rho) \\sin (m\\theta), \\quad m < 0 z_n^{m}(\\rho, \\theta) = r_n^{m}(\\rho), \\quad m = 0 where the radial polynomials are .. math:: r_n^m(\\rho) = \\sum\\limits_{k=0}^{(n-m)/2} \\frac{(-1)^k (n-k)!}{k! ( \\frac{n+m}{2} - k)! (\\frac{n-m}{2} - k)!} \\rho^{n-2k}. with this definition, the integral of :math:`(z_n^m)^2` over the unit disk is :math:`\\frac{\\epsilon_m\\pi}{2n+2}` for each polynomial where :math:`\\epsilon_m` is 2 if :math:`m` equals 0 and 1 otherwise. specifying a filter with order n tallies moments for all :math:`n` from 0 to n and each value of :math:`m`. the ordering of the zernike polynomial moments follows the ansi z80.28 standard, where the one-dimensional index :math:`j` corresponds to the :math:`n` and :math:`m` by .. math:: j = \\frac{n(n + 2) + m}{2}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the order parameter do when creating a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter constructor parameter order", "output": "When creating a ZernikeFilter, the order parameter specifies maximum zernike polynomial order. It should be a int value." }, { "instruction": "What does the x parameter do when creating a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter constructor parameter x", "output": "When creating a ZernikeFilter, the x parameter specifies x-coordinate of center of circle for normalization. It should be a float value." }, { "instruction": "What does the y parameter do when creating a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter constructor parameter y", "output": "When creating a ZernikeFilter, the y parameter specifies y-coordinate of center of circle for normalization. It should be a float value." }, { "instruction": "What does the r parameter do when creating a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter constructor parameter r", "output": "When creating a ZernikeFilter, the r parameter specifies radius of circle for normalization. It should be a float value." }, { "instruction": "What is the order attribute of a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter attribute order", "output": "The order attribute of a ZernikeFilter contains maximum zernike polynomial order. It's a int value that you can access after creating a ZernikeFilter instance." }, { "instruction": "What is the x attribute of a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter attribute x", "output": "The x attribute of a ZernikeFilter contains x-coordinate of center of circle for normalization. It's a float value that you can access after creating a ZernikeFilter instance." }, { "instruction": "What is the y attribute of a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter attribute y", "output": "The y attribute of a ZernikeFilter contains y-coordinate of center of circle for normalization. It's a float value that you can access after creating a ZernikeFilter instance." }, { "instruction": "What is the r attribute of a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter attribute r", "output": "The r attribute of a ZernikeFilter contains radius of circle for normalization. It's a float value that you can access after creating a ZernikeFilter instance." }, { "instruction": "What is the id attribute of a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter attribute id", "output": "The id attribute of a ZernikeFilter contains unique identifier for the filter. It's a int value that you can access after creating a ZernikeFilter instance." }, { "instruction": "What is the num_bins attribute of a ZernikeFilter?", "input": "OpenMC Python API ZernikeFilter attribute num_bins", "output": "The num_bins attribute of a ZernikeFilter contains the number of filter bins. It's a int value that you can access after creating a ZernikeFilter instance." }, { "instruction": "How do you call the __init__() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, x: Any, y: Any, r: Any, filter_id: Any). It takes 6 parameters." }, { "instruction": "How do you call the __hash__() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.order() method signature", "output": "To call the order() method, use: @.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the x() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.x() method signature", "output": "To call the x() method, use: @property def x(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.x() method signature", "output": "To call the x() method, use: @x.setter def x(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the y() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.y() method signature", "output": "To call the y() method, use: @property def y(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the y() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.y() method signature", "output": "To call the y() method, use: @y.setter def y(self: Any, y: Any). It takes 2 parameters." }, { "instruction": "How do you call the r() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.r() method signature", "output": "To call the r() method, use: @property def r(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the r() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.r() method signature", "output": "To call the r() method, use: @r.setter def r(self: Any, r: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_hdf5() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.to_xml_element() method", "output": "The to_xml_element() method return xml element representing the filter. It's used for zernikefilter operations." }, { "instruction": "How do you call the to_xml_element() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing zernike filter data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the from_xml_element() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the ZernikeRadialFilter class in OpenMC's Python API?", "input": "OpenMC Python API ZernikeRadialFilter class", "output": "The ZernikeRadialFilter class represents score the :math:`m = 0` (radial variation only) zernike moments up to specified order. the zernike polynomials are defined the same as in :class:`zernikefilter`. .. math:: z_n^{0}(\\rho, \\theta) = r_n^{0}(\\rho) where the radial polynomials are .. math:: r_n^{0}(\\rho) = \\sum\\limits_{k=0}^{n/2} \\frac{(-1)^k (n-k)!}{k! (( \\frac{n}{2} - k)!)^{2}} \\rho^{n-2k}. with this definition, the integral of :math:`(z_n^0)^2` over the unit disk is :math:`\\frac{\\pi}{n+1}`. if there is only radial dependency, the polynomials are integrated over the azimuthal angles. the only terms left are :math:`z_n^{0}(\\rho, \\theta) = r_n^{0}(\\rho)`. note that :math:`n` could only be even orders. therefore, for a radial zernike polynomials up to order of :math:`n`, there are :math:`\\frac{n}{2} + 1` terms in total. the indexing is from the lowest even order (0) to highest even order. It provides 1 methods and 0 properties for working with zernikeradialfilter data in OpenMC." }, { "instruction": "What does the ZernikeRadialFilter class do in OpenMC's Python API?", "input": "OpenMC Python API ZernikeRadialFilter class description", "output": "The ZernikeRadialFilter class score the :math:`m = 0` (radial variation only) zernike moments up to specified order. the zernike polynomials are defined the same as in :class:`zernikefilter`. .. math:: z_n^{0}(\\rho, \\theta) = r_n^{0}(\\rho) where the radial polynomials are .. math:: r_n^{0}(\\rho) = \\sum\\limits_{k=0}^{n/2} \\frac{(-1)^k (n-k)!}{k! (( \\frac{n}{2} - k)!)^{2}} \\rho^{n-2k}. with this definition, the integral of :math:`(z_n^0)^2` over the unit disk is :math:`\\frac{\\pi}{n+1}`. if there is only radial dependency, the polynomials are integrated over the azimuthal angles. the only terms left are :math:`z_n^{0}(\\rho, \\theta) = r_n^{0}(\\rho)`. note that :math:`n` could only be even orders. therefore, for a radial zernike polynomials up to order of :math:`n`, there are :math:`\\frac{n}{2} + 1` terms in total. the indexing is from the lowest even order (0) to highest even order. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the order parameter do when creating a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter constructor parameter order", "output": "When creating a ZernikeRadialFilter, the order parameter specifies maximum radial zernike polynomial order. It should be a int value." }, { "instruction": "What does the x parameter do when creating a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter constructor parameter x", "output": "When creating a ZernikeRadialFilter, the x parameter specifies x-coordinate of center of circle for normalization. It should be a float value." }, { "instruction": "What does the y parameter do when creating a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter constructor parameter y", "output": "When creating a ZernikeRadialFilter, the y parameter specifies y-coordinate of center of circle for normalization. It should be a float value." }, { "instruction": "What does the r parameter do when creating a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter constructor parameter r", "output": "When creating a ZernikeRadialFilter, the r parameter specifies radius of circle for normalization. It should be a float value." }, { "instruction": "What is the order attribute of a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter attribute order", "output": "The order attribute of a ZernikeRadialFilter contains maximum radial zernike polynomial order. It's a int value that you can access after creating a ZernikeRadialFilter instance." }, { "instruction": "What is the x attribute of a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter attribute x", "output": "The x attribute of a ZernikeRadialFilter contains x-coordinate of center of circle for normalization. It's a float value that you can access after creating a ZernikeRadialFilter instance." }, { "instruction": "What is the y attribute of a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter attribute y", "output": "The y attribute of a ZernikeRadialFilter contains y-coordinate of center of circle for normalization. It's a float value that you can access after creating a ZernikeRadialFilter instance." }, { "instruction": "What is the r attribute of a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter attribute r", "output": "The r attribute of a ZernikeRadialFilter contains radius of circle for normalization. It's a float value that you can access after creating a ZernikeRadialFilter instance." }, { "instruction": "What is the id attribute of a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter attribute id", "output": "The id attribute of a ZernikeRadialFilter contains unique identifier for the filter. It's a int value that you can access after creating a ZernikeRadialFilter instance." }, { "instruction": "What is the num_bins attribute of a ZernikeRadialFilter?", "input": "OpenMC Python API ZernikeRadialFilter attribute num_bins", "output": "The num_bins attribute of a ZernikeRadialFilter contains the number of filter bins. It's a int value that you can access after creating a ZernikeRadialFilter instance." }, { "instruction": "How do you call the order() method in the ZernikeRadialFilter class?", "input": "OpenMC Python API ZernikeRadialFilter.order() method signature", "output": "To call the order() method, use: @.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "What is the Geometry class in OpenMC's Python API?", "input": "OpenMC Python API Geometry class", "output": "The Geometry class represents geometry representing a collection of surfaces, cells, and universes. It provides 34 methods and 0 properties for working with geometry data in OpenMC." }, { "instruction": "What does the Geometry class do in OpenMC's Python API?", "input": "OpenMC Python API Geometry class description", "output": "The Geometry class geometry representing a collection of surfaces, cells, and universes. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the root parameter do when creating a Geometry?", "input": "OpenMC Python API Geometry constructor parameter root", "output": "When creating a Geometry, the root parameter specifies root universe which contains all others, or an iterable of cells that should be used to create a root universe.. It should be a openmc.UniverseBase or Iterable of openmc.Cell, optional value." }, { "instruction": "What is the root_universe attribute of a Geometry?", "input": "OpenMC Python API Geometry attribute root_universe", "output": "The root_universe attribute of a Geometry contains root universe which contains all others. It's a openmc.UniverseBase value that you can access after creating a Geometry instance." }, { "instruction": "What is the bounding_box attribute of a Geometry?", "input": "OpenMC Python API Geometry attribute bounding_box", "output": "The bounding_box attribute of a Geometry contains lower-left and upper-right coordinates of an axis-aligned bounding box of the universe.. It's a openmc.BoundingBox value that you can access after creating a Geometry instance." }, { "instruction": "What is the merge_surfaces attribute of a Geometry?", "input": "OpenMC Python API Geometry attribute merge_surfaces", "output": "The merge_surfaces attribute of a Geometry contains whether to remove redundant surfaces when the geometry is exported.. It's a bool value that you can access after creating a Geometry instance." }, { "instruction": "What is the surface_precision attribute of a Geometry?", "input": "OpenMC Python API Geometry attribute surface_precision", "output": "The surface_precision attribute of a Geometry contains number of decimal places to round to for comparing the coefficients of surfaces for considering them topologically equivalent.. It's a int value that you can access after creating a Geometry instance." }, { "instruction": "How do you call the __init__() method in the Geometry class?", "input": "OpenMC Python API Geometry.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, root: Any, merge_surfaces: bool, surface_precision: int). It takes 4 parameters." }, { "instruction": "How do you call the root_universe() method in the Geometry class?", "input": "OpenMC Python API Geometry.root_universe() method signature", "output": "To call the root_universe() method, use: @property def root_universe(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the root_universe() method in the Geometry class?", "input": "OpenMC Python API Geometry.root_universe() method signature", "output": "To call the root_universe() method, use: @root_universe.setter def root_universe(self: Any, root_universe: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the Geometry class?", "input": "OpenMC Python API Geometry.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the merge_surfaces() method in the Geometry class?", "input": "OpenMC Python API Geometry.merge_surfaces() method signature", "output": "To call the merge_surfaces() method, use: @property def merge_surfaces(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the merge_surfaces() method in the Geometry class?", "input": "OpenMC Python API Geometry.merge_surfaces() method signature", "output": "To call the merge_surfaces() method, use: @merge_surfaces.setter def merge_surfaces(self: Any, merge_surfaces: Any). It takes 2 parameters." }, { "instruction": "How do you call the surface_precision() method in the Geometry class?", "input": "OpenMC Python API Geometry.surface_precision() method signature", "output": "To call the surface_precision() method, use: @property def surface_precision(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the surface_precision() method in the Geometry class?", "input": "OpenMC Python API Geometry.surface_precision() method signature", "output": "To call the surface_precision() method, use: @surface_precision.setter def surface_precision(self: Any, surface_precision: Any). It takes 2 parameters." }, { "instruction": "What does the add_volume_information() method do in the Geometry class?", "input": "OpenMC Python API Geometry.add_volume_information() method", "output": "The add_volume_information() method add volume information from a stochastic volume calculation. It's used for geometry operations." }, { "instruction": "How do you call the add_volume_information() method in the Geometry class?", "input": "OpenMC Python API Geometry.add_volume_information() method signature", "output": "To call the add_volume_information() method, use: def add_volume_information(self: Any, volume_calc: Any). It takes 2 parameters." }, { "instruction": "What does the volume_calc parameter do in the add_volume_information() method?", "input": "OpenMC Python API Geometry.add_volume_information() parameter volume_calc", "output": "The volume_calc parameter results from a stochastic volume calculation. It should be a openmc.VolumeCalculation value." }, { "instruction": "What does the to_xml_element() method do in the Geometry class?", "input": "OpenMC Python API Geometry.to_xml_element() method", "output": "The to_xml_element() method creates a 'geometry' element to be written to an xml file. It's used for geometry operations." }, { "instruction": "How do you call the to_xml_element() method in the Geometry class?", "input": "OpenMC Python API Geometry.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, remove_surfs: Any). It takes 2 parameters." }, { "instruction": "What does the remove_surfs parameter do in the to_xml_element() method?", "input": "OpenMC Python API Geometry.to_xml_element() parameter remove_surfs", "output": "The remove_surfs parameter whether or not to remove redundant surfaces from the geometry when exporting. It should be a bool value." }, { "instruction": "What does the export_to_xml() method do in the Geometry class?", "input": "OpenMC Python API Geometry.export_to_xml() method", "output": "The export_to_xml() method export geometry to an xml file. It's used for geometry operations." }, { "instruction": "How do you call the export_to_xml() method in the Geometry class?", "input": "OpenMC Python API Geometry.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, path: Any, remove_surfs: Any). It takes 3 parameters." }, { "instruction": "What does the path parameter do in the export_to_xml() method?", "input": "OpenMC Python API Geometry.export_to_xml() parameter path", "output": "The path parameter path to file to write. defaults to 'geometry.xml'.. It should be a str value." }, { "instruction": "What does the remove_surfs parameter do in the export_to_xml() method?", "input": "OpenMC Python API Geometry.export_to_xml() parameter remove_surfs", "output": "The remove_surfs parameter whether or not to remove redundant surfaces from the geometry when exporting .. versionadded:: 0.12. It should be a bool value." }, { "instruction": "What does the from_xml_element() method do in the Geometry class?", "input": "OpenMC Python API Geometry.from_xml_element() method", "output": "The from_xml_element() method generate geometry from an xml element. It's used for geometry operations." }, { "instruction": "How do you call the from_xml_element() method in the Geometry class?", "input": "OpenMC Python API Geometry.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, materials: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Geometry.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the materials parameter do in the from_xml_element() method?", "input": "OpenMC Python API Geometry.from_xml_element() parameter materials", "output": "The materials parameter materials used to assign to cells. if none, an attempt is made to generate it from the materials.xml file.. It should be a openmc.Materials or None value." }, { "instruction": "What does the from_xml() method do in the Geometry class?", "input": "OpenMC Python API Geometry.from_xml() method", "output": "The from_xml() method generate geometry from xml file. It's used for geometry operations." }, { "instruction": "How do you call the from_xml() method in the Geometry class?", "input": "OpenMC Python API Geometry.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, path: PathLike, materials: Any). It takes 3 parameters." }, { "instruction": "What does the path parameter do in the from_xml() method?", "input": "OpenMC Python API Geometry.from_xml() parameter path", "output": "The path parameter path to geometry xml file. It should be a PathLike, optional value." }, { "instruction": "What does the materials parameter do in the from_xml() method?", "input": "OpenMC Python API Geometry.from_xml() parameter materials", "output": "The materials parameter materials used to assign to cells. if pathlike, an attempt is made to generate materials from the provided xml file.. It should be a openmc.Materials or PathLike value." }, { "instruction": "What does the find() method do in the Geometry class?", "input": "OpenMC Python API Geometry.find() method", "output": "The find() method find cells/universes/lattices which contain a given point. It's used for geometry operations." }, { "instruction": "How do you call the find() method in the Geometry class?", "input": "OpenMC Python API Geometry.find() method signature", "output": "To call the find() method, use: def find(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the find() method?", "input": "OpenMC Python API Geometry.find() parameter point", "output": "The point parameter cartesian coordinates of the point. It should be a 3-tuple of float value." }, { "instruction": "What does the get_instances() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_instances() method", "output": "The get_instances() method return the instance number(s) for a cell/material in a geometry path. the instance numbers are used as indices into distributed material/temperature arrays and tally distribcell filter arrays. It's used for geometry operations." }, { "instruction": "How do you call the get_instances() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_instances() method signature", "output": "To call the get_instances() method, use: def get_instances(self: Any, paths: Any). It takes 2 parameters." }, { "instruction": "What does the paths parameter do in the get_instances() method?", "input": "OpenMC Python API Geometry.get_instances() parameter paths", "output": "The paths parameter the path traversed through the csg tree to reach a cell or material instance. for example, 'u0->c10->l20(2,2,1)->u5->c5' would indicate the cell instance whose first level is universe 0 and cell 10, second level is lattice 20 position (2,2,1), and third level is universe 5 and cell 5.. It should be a str or iterable of str value." }, { "instruction": "What does the get_all_cells() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_cells() method", "output": "The get_all_cells() method return all cells in the geometry. It's used for geometry operations." }, { "instruction": "How do you call the get_all_cells() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_cells() method signature", "output": "To call the get_all_cells() method, use: def get_all_cells(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_universes() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_universes() method", "output": "The get_all_universes() method return all universes in the geometry. It's used for geometry operations." }, { "instruction": "How do you call the get_all_universes() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_universes() method signature", "output": "To call the get_all_universes() method, use: def get_all_universes(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_nuclides() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_nuclides() method", "output": "The get_all_nuclides() method return all nuclides within the geometry. It's used for geometry operations." }, { "instruction": "How do you call the get_all_nuclides() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_nuclides() method signature", "output": "To call the get_all_nuclides() method, use: def get_all_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_materials() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_materials() method", "output": "The get_all_materials() method return all materials within the geometry. It's used for geometry operations." }, { "instruction": "How do you call the get_all_materials() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_materials() method signature", "output": "To call the get_all_materials() method, use: def get_all_materials(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_material_cells() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_material_cells() method", "output": "The get_all_material_cells() method return all cells filled by a material. It's used for geometry operations." }, { "instruction": "How do you call the get_all_material_cells() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_material_cells() method signature", "output": "To call the get_all_material_cells() method, use: def get_all_material_cells(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_material_universes() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_material_universes() method", "output": "The get_all_material_universes() method return all universes having at least one material-filled cell. this method can be used to find universes that have at least one cell that is filled with a material or is void. It's used for geometry operations." }, { "instruction": "How do you call the get_all_material_universes() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_material_universes() method signature", "output": "To call the get_all_material_universes() method, use: def get_all_material_universes(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_lattices() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_lattices() method", "output": "The get_all_lattices() method return all lattices defined. It's used for geometry operations." }, { "instruction": "How do you call the get_all_lattices() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_lattices() method signature", "output": "To call the get_all_lattices() method, use: def get_all_lattices(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_surfaces() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_surfaces() method", "output": "The get_all_surfaces() method return all surfaces used in the geometry. It's used for geometry operations." }, { "instruction": "How do you call the get_all_surfaces() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_all_surfaces() method signature", "output": "To call the get_all_surfaces() method, use: def get_all_surfaces(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_domains_by_name() method in the Geometry class?", "input": "OpenMC Python API Geometry._get_domains_by_name() method signature", "output": "To call the _get_domains_by_name() method, use: def _get_domains_by_name(self: Any, name: Any, case_sensitive: Any, matching: Any, domain_type: Any). It takes 5 parameters." }, { "instruction": "What does the get_materials_by_name() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_materials_by_name() method", "output": "The get_materials_by_name() method return a list of materials with matching names. It's used for geometry operations." }, { "instruction": "How do you call the get_materials_by_name() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_materials_by_name() method signature", "output": "To call the get_materials_by_name() method, use: def get_materials_by_name(self: Any, name: Any, case_sensitive: Any, matching: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the get_materials_by_name() method?", "input": "OpenMC Python API Geometry.get_materials_by_name() parameter name", "output": "The name parameter the name to match. It should be a str value." }, { "instruction": "What does the case_sensitive parameter do in the get_materials_by_name() method?", "input": "OpenMC Python API Geometry.get_materials_by_name() parameter case_sensitive", "output": "The case_sensitive parameter whether to distinguish upper and lower case letters in each material's name (default is false). It should be a bool value." }, { "instruction": "What does the matching parameter do in the get_materials_by_name() method?", "input": "OpenMC Python API Geometry.get_materials_by_name() parameter matching", "output": "The matching parameter whether the names must match completely (default is false). It should be a bool value." }, { "instruction": "What does the get_cells_by_name() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_cells_by_name() method", "output": "The get_cells_by_name() method return a list of cells with matching names. It's used for geometry operations." }, { "instruction": "How do you call the get_cells_by_name() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_cells_by_name() method signature", "output": "To call the get_cells_by_name() method, use: def get_cells_by_name(self: Any, name: Any, case_sensitive: Any, matching: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the get_cells_by_name() method?", "input": "OpenMC Python API Geometry.get_cells_by_name() parameter name", "output": "The name parameter the name to search match. It should be a str value." }, { "instruction": "What does the case_sensitive parameter do in the get_cells_by_name() method?", "input": "OpenMC Python API Geometry.get_cells_by_name() parameter case_sensitive", "output": "The case_sensitive parameter whether to distinguish upper and lower case letters in each cell's name (default is false). It should be a bool value." }, { "instruction": "What does the matching parameter do in the get_cells_by_name() method?", "input": "OpenMC Python API Geometry.get_cells_by_name() parameter matching", "output": "The matching parameter whether the names must match completely (default is false). It should be a bool value." }, { "instruction": "What does the get_surfaces_by_name() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_surfaces_by_name() method", "output": "The get_surfaces_by_name() method return a list of surfaces with matching names. .. versionadded:: 0.13.3. It's used for geometry operations." }, { "instruction": "How do you call the get_surfaces_by_name() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_surfaces_by_name() method signature", "output": "To call the get_surfaces_by_name() method, use: def get_surfaces_by_name(self: Any, name: Any, case_sensitive: Any, matching: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the get_surfaces_by_name() method?", "input": "OpenMC Python API Geometry.get_surfaces_by_name() parameter name", "output": "The name parameter the name to search match. It should be a str value." }, { "instruction": "What does the case_sensitive parameter do in the get_surfaces_by_name() method?", "input": "OpenMC Python API Geometry.get_surfaces_by_name() parameter case_sensitive", "output": "The case_sensitive parameter whether to distinguish upper and lower case letters in each surface's name (default is false). It should be a bool value." }, { "instruction": "What does the matching parameter do in the get_surfaces_by_name() method?", "input": "OpenMC Python API Geometry.get_surfaces_by_name() parameter matching", "output": "The matching parameter whether the names must match completely (default is false). It should be a bool value." }, { "instruction": "What does the get_cells_by_fill_name() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_cells_by_fill_name() method", "output": "The get_cells_by_fill_name() method return a list of cells with fills with matching names. It's used for geometry operations." }, { "instruction": "How do you call the get_cells_by_fill_name() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_cells_by_fill_name() method signature", "output": "To call the get_cells_by_fill_name() method, use: def get_cells_by_fill_name(self: Any, name: Any, case_sensitive: Any, matching: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the get_cells_by_fill_name() method?", "input": "OpenMC Python API Geometry.get_cells_by_fill_name() parameter name", "output": "The name parameter the name to match. It should be a str value." }, { "instruction": "What does the case_sensitive parameter do in the get_cells_by_fill_name() method?", "input": "OpenMC Python API Geometry.get_cells_by_fill_name() parameter case_sensitive", "output": "The case_sensitive parameter whether to distinguish upper and lower case letters in each cell's name (default is false). It should be a bool value." }, { "instruction": "What does the matching parameter do in the get_cells_by_fill_name() method?", "input": "OpenMC Python API Geometry.get_cells_by_fill_name() parameter matching", "output": "The matching parameter whether the names must match completely (default is false). It should be a bool value." }, { "instruction": "What does the get_universes_by_name() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_universes_by_name() method", "output": "The get_universes_by_name() method return a list of universes with matching names. It's used for geometry operations." }, { "instruction": "How do you call the get_universes_by_name() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_universes_by_name() method signature", "output": "To call the get_universes_by_name() method, use: def get_universes_by_name(self: Any, name: Any, case_sensitive: Any, matching: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the get_universes_by_name() method?", "input": "OpenMC Python API Geometry.get_universes_by_name() parameter name", "output": "The name parameter the name to match. It should be a str value." }, { "instruction": "What does the case_sensitive parameter do in the get_universes_by_name() method?", "input": "OpenMC Python API Geometry.get_universes_by_name() parameter case_sensitive", "output": "The case_sensitive parameter whether to distinguish upper and lower case letters in each universe's name (default is false). It should be a bool value." }, { "instruction": "What does the matching parameter do in the get_universes_by_name() method?", "input": "OpenMC Python API Geometry.get_universes_by_name() parameter matching", "output": "The matching parameter whether the names must match completely (default is false). It should be a bool value." }, { "instruction": "What does the get_lattices_by_name() method do in the Geometry class?", "input": "OpenMC Python API Geometry.get_lattices_by_name() method", "output": "The get_lattices_by_name() method return a list of lattices with matching names. It's used for geometry operations." }, { "instruction": "How do you call the get_lattices_by_name() method in the Geometry class?", "input": "OpenMC Python API Geometry.get_lattices_by_name() method signature", "output": "To call the get_lattices_by_name() method, use: def get_lattices_by_name(self: Any, name: Any, case_sensitive: Any, matching: Any). It takes 4 parameters." }, { "instruction": "What does the name parameter do in the get_lattices_by_name() method?", "input": "OpenMC Python API Geometry.get_lattices_by_name() parameter name", "output": "The name parameter the name to match. It should be a str value." }, { "instruction": "What does the case_sensitive parameter do in the get_lattices_by_name() method?", "input": "OpenMC Python API Geometry.get_lattices_by_name() parameter case_sensitive", "output": "The case_sensitive parameter whether to distinguish upper and lower case letters in each lattice's name (default is false). It should be a bool value." }, { "instruction": "What does the matching parameter do in the get_lattices_by_name() method?", "input": "OpenMC Python API Geometry.get_lattices_by_name() parameter matching", "output": "The matching parameter whether the names must match completely (default is false). It should be a bool value." }, { "instruction": "What does the remove_redundant_surfaces() method do in the Geometry class?", "input": "OpenMC Python API Geometry.remove_redundant_surfaces() method", "output": "The remove_redundant_surfaces() method remove and return all of the redundant surfaces. uses surface_precision attribute of geometry instance for rounding and comparing surface coefficients. .. versionadded:: 0.12. It's used for geometry operations." }, { "instruction": "How do you call the remove_redundant_surfaces() method in the Geometry class?", "input": "OpenMC Python API Geometry.remove_redundant_surfaces() method signature", "output": "To call the remove_redundant_surfaces() method, use: def remove_redundant_surfaces(self: Any). It takes 1 parameters." }, { "instruction": "What does the determine_paths() method do in the Geometry class?", "input": "OpenMC Python API Geometry.determine_paths() method", "output": "The determine_paths() method determine paths through csg tree for cells and materials. this method recursively traverses the csg tree to determine each unique path that reaches every cell and material. the paths are stored in the :attr:`cell.paths` and :attr:`material.paths` attributes. It's used for geometry operations." }, { "instruction": "How do you call the determine_paths() method in the Geometry class?", "input": "OpenMC Python API Geometry.determine_paths() method signature", "output": "To call the determine_paths() method, use: def determine_paths(self: Any, instances_only: Any). It takes 2 parameters." }, { "instruction": "What does the instances_only parameter do in the determine_paths() method?", "input": "OpenMC Python API Geometry.determine_paths() parameter instances_only", "output": "The instances_only parameter if true, this method will only determine the number of instances of each cell and material.. It should be a bool, optional value." }, { "instruction": "What does the clone() method do in the Geometry class?", "input": "OpenMC Python API Geometry.clone() method", "output": "The clone() method create a copy of this geometry with new unique ids for all of its\n enclosed materials, surfaces, cells, universes and lattices.. It's used for geometry operations." }, { "instruction": "How do you call the clone() method in the Geometry class?", "input": "OpenMC Python API Geometry.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any). It takes 1 parameters." }, { "instruction": "What does the plot() method do in the Geometry class?", "input": "OpenMC Python API Geometry.plot() method", "output": "The plot() method display a slice plot of the geometry.\n\n .. versionadded:: 0.14.0. It's used for geometry operations." }, { "instruction": "How do you call the plot() method in the Geometry class?", "input": "OpenMC Python API Geometry.plot() method signature", "output": "To call the plot() method, use: @add_plot_params def plot(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the get_universe() function in OpenMC's Python API?", "input": "OpenMC Python API get_universe() function signature", "output": "To call the get_universe() function, use: def get_universe(univ_id: Any). It takes 1 parameters." }, { "instruction": "What is the Lattice class in OpenMC's Python API?", "input": "OpenMC Python API Lattice class", "output": "The Lattice class represents a repeating structure wherein each element is a universe. It provides 16 methods and 0 properties for working with lattice data in OpenMC." }, { "instruction": "What does the Lattice class do in OpenMC's Python API?", "input": "OpenMC Python API Lattice class description", "output": "The Lattice class a repeating structure wherein each element is a universe. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the lattice_id parameter do when creating a Lattice?", "input": "OpenMC Python API Lattice constructor parameter lattice_id", "output": "When creating a Lattice, the lattice_id parameter specifies unique identifier for the lattice. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a Lattice?", "input": "OpenMC Python API Lattice constructor parameter name", "output": "When creating a Lattice, the name parameter specifies name of the lattice. if not specified, the name is the empty string.. It should be a str, optional value." }, { "instruction": "What is the id attribute of a Lattice?", "input": "OpenMC Python API Lattice attribute id", "output": "The id attribute of a Lattice contains unique identifier for the lattice. It's a int value that you can access after creating a Lattice instance." }, { "instruction": "What is the name attribute of a Lattice?", "input": "OpenMC Python API Lattice attribute name", "output": "The name attribute of a Lattice contains name of the lattice. It's a str value that you can access after creating a Lattice instance." }, { "instruction": "What is the pitch attribute of a Lattice?", "input": "OpenMC Python API Lattice attribute pitch", "output": "The pitch attribute of a Lattice contains pitch of the lattice in each direction in cm. It's a Iterable of float value that you can access after creating a Lattice instance." }, { "instruction": "What is the outer attribute of a Lattice?", "input": "OpenMC Python API Lattice attribute outer", "output": "The outer attribute of a Lattice contains a universe to fill all space outside the lattice. It's a openmc.UniverseBase value that you can access after creating a Lattice instance." }, { "instruction": "What is the universes attribute of a Lattice?", "input": "OpenMC Python API Lattice attribute universes", "output": "The universes attribute of a Lattice contains a two-or three-dimensional list/array of universes filling each element of the lattice. It's a Iterable of Iterable of openmc.UniverseBase value that you can access after creating a Lattice instance." }, { "instruction": "How do you call the __init__() method in the Lattice class?", "input": "OpenMC Python API Lattice.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, lattice_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the name() method in the Lattice class?", "input": "OpenMC Python API Lattice.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Lattice class?", "input": "OpenMC Python API Lattice.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the pitch() method in the Lattice class?", "input": "OpenMC Python API Lattice.pitch() method signature", "output": "To call the pitch() method, use: @property def pitch(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the outer() method in the Lattice class?", "input": "OpenMC Python API Lattice.outer() method signature", "output": "To call the outer() method, use: @property def outer(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the outer() method in the Lattice class?", "input": "OpenMC Python API Lattice.outer() method signature", "output": "To call the outer() method, use: @outer.setter def outer(self: Any, outer: Any). It takes 2 parameters." }, { "instruction": "How do you call the universes() method in the Lattice class?", "input": "OpenMC Python API Lattice.universes() method signature", "output": "To call the universes() method, use: @property def universes(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_hdf5() method do in the Lattice class?", "input": "OpenMC Python API Lattice.from_hdf5() method", "output": "The from_hdf5() method create lattice from hdf5 group. It's used for lattice operations." }, { "instruction": "How do you call the from_hdf5() method in the Lattice class?", "input": "OpenMC Python API Lattice.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @staticmethod def from_hdf5(group: Any, universes: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Lattice.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the universes parameter do in the from_hdf5() method?", "input": "OpenMC Python API Lattice.from_hdf5() parameter universes", "output": "The universes parameter dictionary mapping universe ids to instances of :class:`openmc.universebase`.. It should be a dict value." }, { "instruction": "What does the get_unique_universes() method do in the Lattice class?", "input": "OpenMC Python API Lattice.get_unique_universes() method", "output": "The get_unique_universes() method determine all unique universes in the lattice. It's used for lattice operations." }, { "instruction": "How do you call the get_unique_universes() method in the Lattice class?", "input": "OpenMC Python API Lattice.get_unique_universes() method signature", "output": "To call the get_unique_universes() method, use: def get_unique_universes(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_unique_universes() method return in the Lattice class?", "input": "OpenMC Python API Lattice.get_unique_universes() return value", "output": "The get_unique_universes() method returns dictionary whose keys are universe ids and values are :class:`openmc.universebase` instances. The return type is dict." }, { "instruction": "What does the get_nuclides() method do in the Lattice class?", "input": "OpenMC Python API Lattice.get_nuclides() method", "output": "The get_nuclides() method returns all nuclides in the lattice. It's used for lattice operations." }, { "instruction": "How do you call the get_nuclides() method in the Lattice class?", "input": "OpenMC Python API Lattice.get_nuclides() method signature", "output": "To call the get_nuclides() method, use: def get_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclides() method return in the Lattice class?", "input": "OpenMC Python API Lattice.get_nuclides() return value", "output": "The get_nuclides() method returns list of nuclide names. The return type is list of str." }, { "instruction": "What does the get_all_cells() method do in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_cells() method", "output": "The get_all_cells() method return all cells that are contained within the lattice. It's used for lattice operations." }, { "instruction": "How do you call the get_all_cells() method in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_cells() method signature", "output": "To call the get_all_cells() method, use: def get_all_cells(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_cells() method return in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_cells() return value", "output": "The get_all_cells() method returns dictionary whose keys are cell ids and values are :class:`cell` instances. The return type is dict." }, { "instruction": "What does the get_all_materials() method do in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_materials() method", "output": "The get_all_materials() method return all materials that are contained within the lattice. It's used for lattice operations." }, { "instruction": "How do you call the get_all_materials() method in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_materials() method signature", "output": "To call the get_all_materials() method, use: def get_all_materials(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_materials() method return in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_materials() return value", "output": "The get_all_materials() method returns dictionary whose keys are material ids and values are :class:`material` instances. The return type is dict." }, { "instruction": "What does the get_all_universes() method do in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_universes() method", "output": "The get_all_universes() method return all universes that are contained within the lattice. It's used for lattice operations." }, { "instruction": "How do you call the get_all_universes() method in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_universes() method signature", "output": "To call the get_all_universes() method, use: def get_all_universes(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_universes() method return in the Lattice class?", "input": "OpenMC Python API Lattice.get_all_universes() return value", "output": "The get_all_universes() method returns dictionary whose keys are universe ids and values are :class:`universe` instances. The return type is dict." }, { "instruction": "What does the get_universe() method do in the Lattice class?", "input": "OpenMC Python API Lattice.get_universe() method", "output": "The get_universe() method return universe corresponding to a lattice element index. It's used for lattice operations." }, { "instruction": "How do you call the get_universe() method in the Lattice class?", "input": "OpenMC Python API Lattice.get_universe() method signature", "output": "To call the get_universe() method, use: def get_universe(self: Any, idx: Any). It takes 2 parameters." }, { "instruction": "What does the idx parameter do in the get_universe() method?", "input": "OpenMC Python API Lattice.get_universe() parameter idx", "output": "The idx parameter lattice element indices. for a rectangular lattice, the indices are given in the :math:`(x,y)` or :math:`(x,y,z)` coordinate system. for hexagonal lattices, they are given in the :math:`x,\\alpha` or :math:`x,\\alpha,z` coordinate systems for \"y\" orientations and :math:`\\alpha,y` or :math:`\\alpha,y,z` coordinate systems for \"x\" orientations.. It should be a Iterable of int value." }, { "instruction": "What does the find() method do in the Lattice class?", "input": "OpenMC Python API Lattice.find() method", "output": "The find() method find cells/universes/lattices which contain a given point. It's used for lattice operations." }, { "instruction": "How do you call the find() method in the Lattice class?", "input": "OpenMC Python API Lattice.find() method signature", "output": "To call the find() method, use: def find(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the find() method?", "input": "OpenMC Python API Lattice.find() parameter point", "output": "The point parameter cartesian coordinates of the point. It should be a 3-tuple of float value." }, { "instruction": "What does the clone() method do in the Lattice class?", "input": "OpenMC Python API Lattice.clone() method", "output": "The clone() method create a copy of this lattice with a new unique id, and clones all universes within this lattice. It's used for lattice operations." }, { "instruction": "How do you call the clone() method in the Lattice class?", "input": "OpenMC Python API Lattice.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, clone_materials: Any, clone_regions: Any, memo: Any). It takes 4 parameters." }, { "instruction": "What does the clone_materials parameter do in the clone() method?", "input": "OpenMC Python API Lattice.clone() parameter clone_materials", "output": "The clone_materials parameter whether to create separate copies of the materials filling cells contained in this lattice and its outer universe.. It should be a bool value." }, { "instruction": "What does the clone_regions parameter do in the clone() method?", "input": "OpenMC Python API Lattice.clone() parameter clone_regions", "output": "The clone_regions parameter whether to create separate copies of the regions bounding cells contained in this lattice and its outer universe.. It should be a bool value." }, { "instruction": "What does the memo parameter do in the clone() method?", "input": "OpenMC Python API Lattice.clone() parameter memo", "output": "The memo parameter a nested dictionary of previously cloned objects. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the clone() method return in the Lattice class?", "input": "OpenMC Python API Lattice.clone() return value", "output": "The clone() method returns the clone of this lattice. The return type is openmc.Lattice." }, { "instruction": "What is the RectLattice class in OpenMC's Python API?", "input": "OpenMC Python API RectLattice class", "output": "The RectLattice class represents a lattice consisting of rectangular prisms. to completely define a rectangular lattice, the :attr:`rectlattice.lower_left` :attr:`rectlattice.pitch`, :attr:`rectlattice.outer`, and :attr:`rectlattice.universes` properties need to be set. most methods for this class use a natural indexing scheme wherein elements are assigned an index corresponding to their position relative to the (x,y,z) axes in a cartesian coordinate system, i.e., an index of (0,0,0) in the lattice gives the element whose x, y, and z coordinates are the smallest. however, note that when universes are assigned to lattice elements using the :attr:`rectlattice.universes` property, the array indices do not correspond to natural indices. It provides 18 methods and 0 properties for working with rectlattice data in OpenMC." }, { "instruction": "What does the RectLattice class do in OpenMC's Python API?", "input": "OpenMC Python API RectLattice class description", "output": "The RectLattice class a lattice consisting of rectangular prisms. to completely define a rectangular lattice, the :attr:`rectlattice.lower_left` :attr:`rectlattice.pitch`, :attr:`rectlattice.outer`, and :attr:`rectlattice.universes` properties need to be set. most methods for this class use a natural indexing scheme wherein elements are assigned an index corresponding to their position relative to the (x,y,z) axes in a cartesian coordinate system, i.e., an index of (0,0,0) in the lattice gives the element whose x, y, and z coordinates are the smallest. however, note that when universes are assigned to lattice elements using the :attr:`rectlattice.universes` property, the array indices do not correspond to natural indices. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the lattice_id parameter do when creating a RectLattice?", "input": "OpenMC Python API RectLattice constructor parameter lattice_id", "output": "When creating a RectLattice, the lattice_id parameter specifies unique identifier for the lattice. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a RectLattice?", "input": "OpenMC Python API RectLattice constructor parameter name", "output": "When creating a RectLattice, the name parameter specifies name of the lattice. if not specified, the name is the empty string.. It should be a str, optional value." }, { "instruction": "What is the id attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute id", "output": "The id attribute of a RectLattice contains unique identifier for the lattice. It's a int value that you can access after creating a RectLattice instance." }, { "instruction": "What is the name attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute name", "output": "The name attribute of a RectLattice contains name of the lattice. It's a str value that you can access after creating a RectLattice instance." }, { "instruction": "What is the pitch attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute pitch", "output": "The pitch attribute of a RectLattice contains pitch of the lattice in the x, y, and (if applicable) z directions in cm.. It's a Iterable of float value that you can access after creating a RectLattice instance." }, { "instruction": "What is the outer attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute outer", "output": "The outer attribute of a RectLattice contains a universe to fill all space outside the lattice. It's a openmc.UniverseBase value that you can access after creating a RectLattice instance." }, { "instruction": "What is the universes attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute universes", "output": "The universes attribute of a RectLattice contains a two- or three-dimensional list/array of universes filling each element of the lattice. the first dimension corresponds to the z-direction (if applicable), the second dimension corresponds to the y-direction, and the third dimension corresponds to the x-direction. note that for the y-direction, a higher index corresponds to a lower physical y-value. each z-slice in the array can be thought of as a top-down view of the lattice.. It's a Iterable of Iterable of openmc.UniverseBase value that you can access after creating a RectLattice instance." }, { "instruction": "What is the lower_left attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute lower_left", "output": "The lower_left attribute of a RectLattice contains the cartesian coordinates of the lower-left corner of the lattice. if the lattice is two-dimensional, only the x- and y-coordinates are specified.. It's a Iterable of float value that you can access after creating a RectLattice instance." }, { "instruction": "What is the indices attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute indices", "output": "The indices attribute of a RectLattice contains a list of all possible (z,y,x) or (y,x) lattice element indices. these indices correspond to indices in the :attr:`rectlattice.universes` property.. It's a list of tuple value that you can access after creating a RectLattice instance." }, { "instruction": "What is the ndim attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute ndim", "output": "The ndim attribute of a RectLattice contains the number of dimensions of the lattice. It's a int value that you can access after creating a RectLattice instance." }, { "instruction": "What is the shape attribute of a RectLattice?", "input": "OpenMC Python API RectLattice attribute shape", "output": "The shape attribute of a RectLattice contains an array of two or three integers representing the number of lattice cells in the x- and y- (and z-) directions, respectively.. It's a Iterable of int value that you can access after creating a RectLattice instance." }, { "instruction": "How do you call the __init__() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, lattice_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the __repr__() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.indices() method signature", "output": "To call the indices() method, use: @property def indices(self: Any). It takes 1 parameters." }, { "instruction": "What does the _natural_indices() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice._natural_indices() method", "output": "The _natural_indices() method iterate over all possible (x,y) or (x,y,z) lattice element indices.\n\n this property is used when constructing distributed cell and material\n paths. most importantly, the iteration order matches that used on the\n fortran side.. It's used for rectlattice operations." }, { "instruction": "How do you call the _natural_indices() method in the RectLattice class?", "input": "OpenMC Python API RectLattice._natural_indices() method signature", "output": "To call the _natural_indices() method, use: @property def _natural_indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.lower_left() method signature", "output": "To call the lower_left() method, use: @lower_left.setter def lower_left(self: Any, lower_left: Any). It takes 2 parameters." }, { "instruction": "How do you call the ndim() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.ndim() method signature", "output": "To call the ndim() method, use: @property def ndim(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the shape() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.shape() method signature", "output": "To call the shape() method, use: @property def shape(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the pitch() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.pitch() method signature", "output": "To call the pitch() method, use: @.setter def pitch(self: Any, pitch: Any). It takes 2 parameters." }, { "instruction": "How do you call the universes() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.universes() method signature", "output": "To call the universes() method, use: @.setter def universes(self: Any, universes: Any). It takes 2 parameters." }, { "instruction": "What does the find_element() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.find_element() method", "output": "The find_element() method determine index of lattice element and local coordinates for a point. It's used for rectlattice operations." }, { "instruction": "How do you call the find_element() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.find_element() method signature", "output": "To call the find_element() method, use: def find_element(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the find_element() method?", "input": "OpenMC Python API RectLattice.find_element() parameter point", "output": "The point parameter cartesian coordinates of point. It should be a Iterable of float value." }, { "instruction": "What does the get_local_coordinates() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.get_local_coordinates() method", "output": "The get_local_coordinates() method determine local coordinates of a point within a lattice element. It's used for rectlattice operations." }, { "instruction": "How do you call the get_local_coordinates() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.get_local_coordinates() method signature", "output": "To call the get_local_coordinates() method, use: def get_local_coordinates(self: Any, point: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the point parameter do in the get_local_coordinates() method?", "input": "OpenMC Python API RectLattice.get_local_coordinates() parameter point", "output": "The point parameter cartesian coordinates of point. It should be a Iterable of float value." }, { "instruction": "What does the idx parameter do in the get_local_coordinates() method?", "input": "OpenMC Python API RectLattice.get_local_coordinates() parameter idx", "output": "The idx parameter (x,y,z) indices of lattice element. if the lattice is 2d, the z index can be omitted.. It should be a Iterable of int value." }, { "instruction": "What does the get_universe_index() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.get_universe_index() method", "output": "The get_universe_index() method return index in the universes array corresponding to a lattice element index. It's used for rectlattice operations." }, { "instruction": "How do you call the get_universe_index() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.get_universe_index() method signature", "output": "To call the get_universe_index() method, use: def get_universe_index(self: Any, idx: Any). It takes 2 parameters." }, { "instruction": "What does the idx parameter do in the get_universe_index() method?", "input": "OpenMC Python API RectLattice.get_universe_index() parameter idx", "output": "The idx parameter lattice element indices in the :math:`(x,y,z)` coordinate system. It should be a Iterable of int value." }, { "instruction": "What does the is_valid_index() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.is_valid_index() method", "output": "The is_valid_index() method determine whether lattice element index is within defined range. It's used for rectlattice operations." }, { "instruction": "How do you call the is_valid_index() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.is_valid_index() method signature", "output": "To call the is_valid_index() method, use: def is_valid_index(self: Any, idx: Any). It takes 2 parameters." }, { "instruction": "What does the idx parameter do in the is_valid_index() method?", "input": "OpenMC Python API RectLattice.is_valid_index() parameter idx", "output": "The idx parameter lattice element indices in the :math:`(x,y,z)` coordinate system. It should be a Iterable of int value." }, { "instruction": "What does the discretize() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.discretize() method", "output": "The discretize() method discretize the lattice with either a degenerate or a local neighbor symmetry strategy 'degenerate' clones every universe in the lattice, thus making them all uniquely defined. this is typically required if depletion or thermal hydraulics will make every universe's environment unique. 'local neighbor symmetry' groups universes with similar neighborhoods. these clusters of cells and materials provide increased convergence speed to multi-group cross sections tallies. the user can specify the lattice's neighbors to discriminate between two sides of a lattice for example. It's used for rectlattice operations." }, { "instruction": "How do you call the discretize() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.discretize() method signature", "output": "To call the discretize() method, use: def discretize(self: Any, strategy: Any, universes_to_ignore: Any, materials_to_clone: Any, lattice_neighbors: Any, key: Any). It takes 6 parameters." }, { "instruction": "What does the strategy parameter do in the discretize() method?", "input": "OpenMC Python API RectLattice.discretize() parameter strategy", "output": "The strategy parameter which strategy to adopt when discretizing the lattice. It should be a {'degenerate', 'lns'} value." }, { "instruction": "What does the universes_to_ignore parameter do in the discretize() method?", "input": "OpenMC Python API RectLattice.discretize() parameter universes_to_ignore", "output": "The universes_to_ignore parameter lattice universes that need not be discretized. It should be a Iterable of Universe value." }, { "instruction": "What does the materials_to_clone parameter do in the discretize() method?", "input": "OpenMC Python API RectLattice.discretize() parameter materials_to_clone", "output": "The materials_to_clone parameter list of materials that should be cloned when discretizing. It should be a Iterable of Material value." }, { "instruction": "What does the lattice_neighbors parameter do in the discretize() method?", "input": "OpenMC Python API RectLattice.discretize() parameter lattice_neighbors", "output": "The lattice_neighbors parameter list of the lattice's neighbors. by default, if present, the lattice outer universe will be used. the neighbors should be ordered as follows [top left, top, top right, left, right, bottom left, bottom, bottom right]. It should be a Iterable of Universe value." }, { "instruction": "What does the key parameter do in the discretize() method?", "input": "OpenMC Python API RectLattice.discretize() parameter key", "output": "The key parameter function of argument a universe that is used to extract a comparison key. this function will be called on each universe's neighbors in the lattice to form a neighbor pattern. this pattern is then used to identify unique neighbor symmetries.. It should be a function value." }, { "instruction": "What does the create_xml_subelement() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.create_xml_subelement() method", "output": "The create_xml_subelement() method add the lattice xml representation to an incoming xml element. It's used for rectlattice operations." }, { "instruction": "How do you call the create_xml_subelement() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.create_xml_subelement() method signature", "output": "To call the create_xml_subelement() method, use: def create_xml_subelement(self: Any, xml_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "What does the xml_element parameter do in the create_xml_subelement() method?", "input": "OpenMC Python API RectLattice.create_xml_subelement() parameter xml_element", "output": "The xml_element parameter xml element to be added to. It should be a lxml.etree._Element value." }, { "instruction": "What does the memo parameter do in the create_xml_subelement() method?", "input": "OpenMC Python API RectLattice.create_xml_subelement() parameter memo", "output": "The memo parameter a set of object id's representing geometry entities already written to the xml_element. this parameter is used internally and should not be specified by users.. It should be a set or None value." }, { "instruction": "What does the from_xml_element() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.from_xml_element() method", "output": "The from_xml_element() method generate rectangular lattice from xml element. It's used for rectlattice operations." }, { "instruction": "How do you call the from_xml_element() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, get_universe: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API RectLattice.from_xml_element() parameter elem", "output": "The elem parameter `` element. It should be a lxml.etree._Element value." }, { "instruction": "What does the get_universe parameter do in the from_xml_element() method?", "input": "OpenMC Python API RectLattice.from_xml_element() parameter get_universe", "output": "The get_universe parameter function returning universe (defined in :meth:`openmc.geometry.from_xml`). It should be a function value." }, { "instruction": "What does the from_hdf5() method do in the RectLattice class?", "input": "OpenMC Python API RectLattice.from_hdf5() method", "output": "The from_hdf5() method create rectangular lattice from hdf5 group. It's used for rectlattice operations." }, { "instruction": "How do you call the from_hdf5() method in the RectLattice class?", "input": "OpenMC Python API RectLattice.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any, universes: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API RectLattice.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the universes parameter do in the from_hdf5() method?", "input": "OpenMC Python API RectLattice.from_hdf5() parameter universes", "output": "The universes parameter dictionary mapping universe ids to instances of :class:`openmc.universebase`.. It should be a dict value." }, { "instruction": "What is the HexLattice class in OpenMC's Python API?", "input": "OpenMC Python API HexLattice class", "output": "The HexLattice class represents a lattice consisting of hexagonal prisms. to completely define a hexagonal lattice, the :attr:`hexlattice.center`, :attr:`hexlattice.pitch`, :attr:`hexlattice.universes`, and :attr:`hexlattice.outer` properties need to be set. most methods for this class use a natural indexing scheme wherein elements are assigned an index corresponding to their position relative to skewed :math:`(x,\\alpha,z)` or :math:`(\\alpha,y,z)` bases, depending on the lattice orientation, as described fully in :ref:`hexagonal_indexing`. however, note that when universes are assigned to lattice elements using the :attr:`hexlattice.universes` property, the array indices do not correspond to natural indices. .. versionchanged:: 0.11 the orientation of the lattice can now be changed with the :attr:`orientation` attribute. It provides 26 methods and 0 properties for working with hexlattice data in OpenMC." }, { "instruction": "What does the HexLattice class do in OpenMC's Python API?", "input": "OpenMC Python API HexLattice class description", "output": "The HexLattice class a lattice consisting of hexagonal prisms. to completely define a hexagonal lattice, the :attr:`hexlattice.center`, :attr:`hexlattice.pitch`, :attr:`hexlattice.universes`, and :attr:`hexlattice.outer` properties need to be set. most methods for this class use a natural indexing scheme wherein elements are assigned an index corresponding to their position relative to skewed :math:`(x,\\alpha,z)` or :math:`(\\alpha,y,z)` bases, depending on the lattice orientation, as described fully in :ref:`hexagonal_indexing`. however, note that when universes are assigned to lattice elements using the :attr:`hexlattice.universes` property, the array indices do not correspond to natural indices. .. versionchanged:: 0.11 the orientation of the lattice can now be changed with the :attr:`orientation` attribute. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the lattice_id parameter do when creating a HexLattice?", "input": "OpenMC Python API HexLattice constructor parameter lattice_id", "output": "When creating a HexLattice, the lattice_id parameter specifies unique identifier for the lattice. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a HexLattice?", "input": "OpenMC Python API HexLattice constructor parameter name", "output": "When creating a HexLattice, the name parameter specifies name of the lattice. if not specified, the name is the empty string.. It should be a str, optional value." }, { "instruction": "What is the id attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute id", "output": "The id attribute of a HexLattice contains unique identifier for the lattice. It's a int value that you can access after creating a HexLattice instance." }, { "instruction": "What is the name attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute name", "output": "The name attribute of a HexLattice contains name of the lattice. It's a str value that you can access after creating a HexLattice instance." }, { "instruction": "What is the pitch attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute pitch", "output": "The pitch attribute of a HexLattice contains pitch of the lattice in cm. the first item in the iterable specifies the pitch in the radial direction and, if the lattice is 3d, the second item in the iterable specifies the pitch in the axial direction.. It's a Iterable of float value that you can access after creating a HexLattice instance." }, { "instruction": "What is the outer attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute outer", "output": "The outer attribute of a HexLattice contains a universe to fill all space outside the lattice. It's a openmc.UniverseBase value that you can access after creating a HexLattice instance." }, { "instruction": "What is the universes attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute universes", "output": "The universes attribute of a HexLattice contains a two- or three-dimensional list/array of universes filling each element of the lattice. each sub-list corresponds to one ring of universes and should be ordered from outermost ring to innermost ring. the universes within each sub-list are ordered from the \"top\" and proceed in a clockwise fashion. the :meth:`hexlattice.show_indices` method can be used to help figure out indices for this property.. It's a Nested Iterable of openmc.UniverseBase value that you can access after creating a HexLattice instance." }, { "instruction": "What is the center attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute center", "output": "The center attribute of a HexLattice contains coordinates of the center of the lattice. if the lattice does not have axial sections then only the x- and y-coordinates are specified. It's a Iterable of float value that you can access after creating a HexLattice instance." }, { "instruction": "What is the indices attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute indices", "output": "The indices attribute of a HexLattice contains a list of all possible (z,r,i) or (r,i) lattice element indices that are possible, where z is the axial index, r is in the ring index (starting from the outermost ring), and i is the index with a ring starting from the top and proceeding clockwise.. It's a list of tuple value that you can access after creating a HexLattice instance." }, { "instruction": "What is the orientation attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute orientation", "output": "The orientation attribute of a HexLattice contains str by default 'y' orientation of main lattice diagonal another option - 'x'. It's a {'x', 'y'} value that you can access after creating a HexLattice instance." }, { "instruction": "What is the num_rings attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute num_rings", "output": "The num_rings attribute of a HexLattice contains number of radial ring positions in the xy-plane. It's a int value that you can access after creating a HexLattice instance." }, { "instruction": "What is the num_axial attribute of a HexLattice?", "input": "OpenMC Python API HexLattice attribute num_axial", "output": "The num_axial attribute of a HexLattice contains number of positions along the z-axis.. It's a int value that you can access after creating a HexLattice instance." }, { "instruction": "How do you call the __init__() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, lattice_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the __repr__() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_rings() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.num_rings() method signature", "output": "To call the num_rings() method, use: @property def num_rings(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the orientation() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.orientation() method signature", "output": "To call the orientation() method, use: @property def orientation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the orientation() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.orientation() method signature", "output": "To call the orientation() method, use: @orientation.setter def orientation(self: Any, orientation: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_axial() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.num_axial() method signature", "output": "To call the num_axial() method, use: @property def num_axial(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the center() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.center() method signature", "output": "To call the center() method, use: @property def center(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the center() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.center() method signature", "output": "To call the center() method, use: @center.setter def center(self: Any, center: Any). It takes 2 parameters." }, { "instruction": "How do you call the indices() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.indices() method signature", "output": "To call the indices() method, use: @property def indices(self: Any). It takes 1 parameters." }, { "instruction": "What does the _natural_indices() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice._natural_indices() method", "output": "The _natural_indices() method iterate over all possible (x,alpha) or (x,alpha,z) lattice element\n indices.\n\n this property is used when constructing distributed cell and material\n paths. most importantly, the iteration order matches that used on the\n fortran side.. It's used for hexlattice operations." }, { "instruction": "How do you call the _natural_indices() method in the HexLattice class?", "input": "OpenMC Python API HexLattice._natural_indices() method signature", "output": "To call the _natural_indices() method, use: @property def _natural_indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ndim() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.ndim() method signature", "output": "To call the ndim() method, use: @property def ndim(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the pitch() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.pitch() method signature", "output": "To call the pitch() method, use: @.setter def pitch(self: Any, pitch: Any). It takes 2 parameters." }, { "instruction": "How do you call the universes() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.universes() method signature", "output": "To call the universes() method, use: @.setter def universes(self: Any, universes: Any). It takes 2 parameters." }, { "instruction": "What does the find_element() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice.find_element() method", "output": "The find_element() method determine index of lattice element and local coordinates for a point. It's used for hexlattice operations." }, { "instruction": "How do you call the find_element() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.find_element() method signature", "output": "To call the find_element() method, use: def find_element(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the find_element() method?", "input": "OpenMC Python API HexLattice.find_element() parameter point", "output": "The point parameter cartesian coordinates of point. It should be a Iterable of float value." }, { "instruction": "What does the find_element() method return in the HexLattice class?", "input": "OpenMC Python API HexLattice.find_element() return value", "output": "The find_element() method returns numpy.ndarray carestian coordinates of the point in the corresponding lattice element coordinate system. The return type is math:`(\\alpha,y,z)` bases." }, { "instruction": "What does the get_local_coordinates() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice.get_local_coordinates() method", "output": "The get_local_coordinates() method determine local coordinates of a point within a lattice element. It's used for hexlattice operations." }, { "instruction": "How do you call the get_local_coordinates() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.get_local_coordinates() method signature", "output": "To call the get_local_coordinates() method, use: def get_local_coordinates(self: Any, point: Any, idx: Any). It takes 3 parameters." }, { "instruction": "What does the point parameter do in the get_local_coordinates() method?", "input": "OpenMC Python API HexLattice.get_local_coordinates() parameter point", "output": "The point parameter cartesian coordinates of point. It should be a Iterable of float value." }, { "instruction": "What does the idx parameter do in the get_local_coordinates() method?", "input": "OpenMC Python API HexLattice.get_local_coordinates() parameter idx", "output": "The idx parameter indices of lattice element in :math:`(x,\\alpha,z)`. It should be a Iterable of int value." }, { "instruction": "What does the or parameter do in the get_local_coordinates() method?", "input": "OpenMC Python API HexLattice.get_local_coordinates() parameter or", "output": "The or parameter . It should be a math:`(\\alpha,y,z)` bases value." }, { "instruction": "What does the get_universe_index() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice.get_universe_index() method", "output": "The get_universe_index() method return index in the universes array corresponding to a lattice element index. It's used for hexlattice operations." }, { "instruction": "How do you call the get_universe_index() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.get_universe_index() method signature", "output": "To call the get_universe_index() method, use: def get_universe_index(self: Any, idx: Any). It takes 2 parameters." }, { "instruction": "What does the idx parameter do in the get_universe_index() method?", "input": "OpenMC Python API HexLattice.get_universe_index() parameter idx", "output": "The idx parameter lattice element indices in the :math:`(x,\\alpha,z)` coordinate system in 'y' orientation case, or indices in the :math:`(\\alpha,y,z)` coordinate system in 'x' one. It should be a Iterable of int value." }, { "instruction": "What does the is_valid_index() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice.is_valid_index() method", "output": "The is_valid_index() method determine whether lattice element index is within defined range. It's used for hexlattice operations." }, { "instruction": "How do you call the is_valid_index() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.is_valid_index() method signature", "output": "To call the is_valid_index() method, use: def is_valid_index(self: Any, idx: Any). It takes 2 parameters." }, { "instruction": "What does the idx parameter do in the is_valid_index() method?", "input": "OpenMC Python API HexLattice.is_valid_index() parameter idx", "output": "The idx parameter lattice element indices in the both :math:`(x,\\alpha,z)`. It should be a Iterable of int value." }, { "instruction": "What does the and parameter do in the is_valid_index() method?", "input": "OpenMC Python API HexLattice.is_valid_index() parameter and", "output": "The and parameter . It should be a math:`(\\alpha,y,z)` coordinate system value." }, { "instruction": "How do you call the create_xml_subelement() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.create_xml_subelement() method signature", "output": "To call the create_xml_subelement() method, use: def create_xml_subelement(self: Any, xml_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "What does the from_xml_element() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice.from_xml_element() method", "output": "The from_xml_element() method generate hexagonal lattice from xml element. It's used for hexlattice operations." }, { "instruction": "How do you call the from_xml_element() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, get_universe: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API HexLattice.from_xml_element() parameter elem", "output": "The elem parameter `` element. It should be a lxml.etree._Element value." }, { "instruction": "What does the get_universe parameter do in the from_xml_element() method?", "input": "OpenMC Python API HexLattice.from_xml_element() parameter get_universe", "output": "The get_universe parameter function returning universe (defined in :meth:`openmc.geometry.from_xml`). It should be a function value." }, { "instruction": "What does the _repr_axial_slice() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice._repr_axial_slice() method", "output": "The _repr_axial_slice() method return string representation for the given 2d group of universes.\n\n the 'universes' argument should be a list of lists of universes where\n each sub-list represents a single ring. the first list should be the\n outer ring.. It's used for hexlattice operations." }, { "instruction": "How do you call the _repr_axial_slice() method in the HexLattice class?", "input": "OpenMC Python API HexLattice._repr_axial_slice() method signature", "output": "To call the _repr_axial_slice() method, use: def _repr_axial_slice(self: Any, universes: Any). It takes 2 parameters." }, { "instruction": "What does the _repr_axial_slice_x() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice._repr_axial_slice_x() method", "output": "The _repr_axial_slice_x() method return string representation for the given 2d group of universes\n in 'x' orientation case.\n\n the 'universes' argument should be a list of lists of universes where\n each sub-list represents a single ring. the first list should be the\n outer ring.. It's used for hexlattice operations." }, { "instruction": "How do you call the _repr_axial_slice_x() method in the HexLattice class?", "input": "OpenMC Python API HexLattice._repr_axial_slice_x() method signature", "output": "To call the _repr_axial_slice_x() method, use: def _repr_axial_slice_x(self: Any, universes: Any). It takes 2 parameters." }, { "instruction": "What does the _repr_axial_slice_y() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice._repr_axial_slice_y() method", "output": "The _repr_axial_slice_y() method return string representation for the given 2d group of universes in\n 'y' orientation case..\n\n the 'universes' argument should be a list of lists of universes where\n each sub-list represents a single ring. the first list should be the\n outer ring.. It's used for hexlattice operations." }, { "instruction": "How do you call the _repr_axial_slice_y() method in the HexLattice class?", "input": "OpenMC Python API HexLattice._repr_axial_slice_y() method signature", "output": "To call the _repr_axial_slice_y() method, use: def _repr_axial_slice_y(self: Any, universes: Any). It takes 2 parameters." }, { "instruction": "What does the _show_indices_y() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice._show_indices_y() method", "output": "The _show_indices_y() method return a diagram of the hexagonal lattice layout with indices. this method can be used to show the proper indices to be used when setting the :attr:`hexlattice.universes` property. for example, running this method with num_rings=3 will return the following diagram:: (0, 0) (0,11) (0, 1) (0,10) (1, 0) (0, 2) (1, 5) (1, 1) (0, 9) (2, 0) (0, 3) (1, 4) (1, 2) (0, 8) (1, 3) (0, 4) (0, 7) (0, 5) (0, 6). It's used for hexlattice operations." }, { "instruction": "How do you call the _show_indices_y() method in the HexLattice class?", "input": "OpenMC Python API HexLattice._show_indices_y() method signature", "output": "To call the _show_indices_y() method, use: @staticmethod def _show_indices_y(num_rings: Any). It takes 1 parameters." }, { "instruction": "What does the num_rings parameter do in the _show_indices_y() method?", "input": "OpenMC Python API HexLattice._show_indices_y() parameter num_rings", "output": "The num_rings parameter number of rings in the hexagonal lattice. It should be a int value." }, { "instruction": "What does the _show_indices_x() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice._show_indices_x() method", "output": "The _show_indices_x() method return a diagram of the hexagonal lattice with x orientation layout with indices. this method can be used to show the proper indices to be used when setting the :attr:`hexlattice.universes` property. for example,running this method with num_rings=3 will return the similar diagram:: (0, 8) (0, 9) (0,10) (0, 7) (1, 4) (1, 5) (0,11) (0, 6) (1, 3) (2, 0) (1, 0) (0, 0) (0, 5) (1, 2) (1, 1) (0, 1) (0, 4) (0, 3) (0, 2). It's used for hexlattice operations." }, { "instruction": "How do you call the _show_indices_x() method in the HexLattice class?", "input": "OpenMC Python API HexLattice._show_indices_x() method signature", "output": "To call the _show_indices_x() method, use: @staticmethod def _show_indices_x(num_rings: Any). It takes 1 parameters." }, { "instruction": "What does the num_rings parameter do in the _show_indices_x() method?", "input": "OpenMC Python API HexLattice._show_indices_x() parameter num_rings", "output": "The num_rings parameter number of rings in the hexagonal lattice. It should be a int value." }, { "instruction": "What does the show_indices() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice.show_indices() method", "output": "The show_indices() method return a diagram of the hexagonal lattice layout with indices. It's used for hexlattice operations." }, { "instruction": "How do you call the show_indices() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.show_indices() method signature", "output": "To call the show_indices() method, use: @staticmethod def show_indices(num_rings: Any, orientation: Any). It takes 2 parameters." }, { "instruction": "What does the num_rings parameter do in the show_indices() method?", "input": "OpenMC Python API HexLattice.show_indices() parameter num_rings", "output": "The num_rings parameter number of rings in the hexagonal lattice. It should be a int value." }, { "instruction": "What does the orientation parameter do in the show_indices() method?", "input": "OpenMC Python API HexLattice.show_indices() parameter orientation", "output": "The orientation parameter orientation of the hexagonal lattice. It should be a {\"x\", \"y\"} value." }, { "instruction": "What does the from_hdf5() method do in the HexLattice class?", "input": "OpenMC Python API HexLattice.from_hdf5() method", "output": "The from_hdf5() method create rectangular lattice from hdf5 group. It's used for hexlattice operations." }, { "instruction": "How do you call the from_hdf5() method in the HexLattice class?", "input": "OpenMC Python API HexLattice.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any, universes: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API HexLattice.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the universes parameter do in the from_hdf5() method?", "input": "OpenMC Python API HexLattice.from_hdf5() parameter universes", "output": "The universes parameter dictionary mapping universe ids to instances of :class:`openmc.universebase`.. It should be a dict value." }, { "instruction": "How do you call the find_edge_neighbors() function in OpenMC's Python API?", "input": "OpenMC Python API find_edge_neighbors() function signature", "output": "To call the find_edge_neighbors() function, use: def find_edge_neighbors(pattern: Any, i: Any, j: Any). It takes 3 parameters." }, { "instruction": "How do you call the find_lattice_neighbors() function in OpenMC's Python API?", "input": "OpenMC Python API find_lattice_neighbors() function signature", "output": "To call the find_lattice_neighbors() function, use: def find_lattice_neighbors(pattern: Any, i: Any, j: Any). It takes 3 parameters." }, { "instruction": "How do you call the _dagmc_enabled() function in OpenMC's Python API?", "input": "OpenMC Python API _dagmc_enabled() function signature", "output": "To call the _dagmc_enabled() function, use: def _dagmc_enabled(). It takes 0 parameters." }, { "instruction": "How do you call the _coord_levels() function in OpenMC's Python API?", "input": "OpenMC Python API _coord_levels() function signature", "output": "To call the _coord_levels() function, use: def _coord_levels(). It takes 0 parameters." }, { "instruction": "How do you call the _libmesh_enabled() function in OpenMC's Python API?", "input": "OpenMC Python API _libmesh_enabled() function signature", "output": "To call the _libmesh_enabled() function, use: def _libmesh_enabled(). It takes 0 parameters." }, { "instruction": "How do you call the _mcpl_enabled() function in OpenMC's Python API?", "input": "OpenMC Python API _mcpl_enabled() function signature", "output": "To call the _mcpl_enabled() function, use: def _mcpl_enabled(). It takes 0 parameters." }, { "instruction": "How do you call the _uwuw_enabled() function in OpenMC's Python API?", "input": "OpenMC Python API _uwuw_enabled() function signature", "output": "To call the _uwuw_enabled() function, use: def _uwuw_enabled(). It takes 0 parameters." }, { "instruction": "What is the Cell class in OpenMC's Python API?", "input": "OpenMC Python API Cell class", "output": "The Cell class represents cell stored internally. this class exposes a cell that is stored internally in the openmc library. to obtain a view of a cell with a given id, use the :data:`openmc.lib.cells` mapping. It provides 15 methods and 0 properties for working with cell data in OpenMC." }, { "instruction": "What does the Cell class do in OpenMC's Python API?", "input": "OpenMC Python API Cell class description", "output": "The Cell class cell stored internally. this class exposes a cell that is stored internally in the openmc library. to obtain a view of a cell with a given id, use the :data:`openmc.lib.cells` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the uid parameter do when creating a Cell?", "input": "OpenMC Python API Cell constructor parameter uid", "output": "When creating a Cell, the uid parameter specifies unique id of the cell. It should be a int or None value." }, { "instruction": "What does the new parameter do when creating a Cell?", "input": "OpenMC Python API Cell constructor parameter new", "output": "When creating a Cell, the new parameter specifies when `index` is none, this argument controls whether a new object is created or a view to an existing object is returned.. It should be a bool value." }, { "instruction": "What does the index parameter do when creating a Cell?", "input": "OpenMC Python API Cell constructor parameter index", "output": "When creating a Cell, the index parameter specifies index in the `cells` array.. It should be a int value." }, { "instruction": "What is the id attribute of a Cell?", "input": "OpenMC Python API Cell attribute id", "output": "The id attribute of a Cell contains id of the cell. It's a int value that you can access after creating a Cell instance." }, { "instruction": "What is the fill attribute of a Cell?", "input": "OpenMC Python API Cell attribute fill", "output": "The fill attribute of a Cell contains indicates what the region of space is filled with. It's a openmc.lib.Material or list of openmc.lib.Material value that you can access after creating a Cell instance." }, { "instruction": "What is the name attribute of a Cell?", "input": "OpenMC Python API Cell attribute name", "output": "The name attribute of a Cell contains name of the cell. It's a str value that you can access after creating a Cell instance." }, { "instruction": "What is the num_instances attribute of a Cell?", "input": "OpenMC Python API Cell attribute num_instances", "output": "The num_instances attribute of a Cell contains number of unique cell instances. It's a int value that you can access after creating a Cell instance." }, { "instruction": "What is the bounding_box attribute of a Cell?", "input": "OpenMC Python API Cell attribute bounding_box", "output": "The bounding_box attribute of a Cell contains axis-aligned bounding box of the cell. It's a openmc.BoundingBox value that you can access after creating a Cell instance." }, { "instruction": "What is the translation attribute of a Cell?", "input": "OpenMC Python API Cell attribute translation", "output": "The translation attribute of a Cell contains 3-d coordinates of the translation vector. It's a Iterable of float value that you can access after creating a Cell instance." }, { "instruction": "What is the rotation attribute of a Cell?", "input": "OpenMC Python API Cell attribute rotation", "output": "The rotation attribute of a Cell contains the rotation matrix or angles of the universe filling the cell. this can either be a fully specified 3 x 3 rotation matrix or an iterable of length 3 with the angles in degrees about the x, y, and z axes, respectively.. It's a Iterable of float value that you can access after creating a Cell instance." }, { "instruction": "How do you call the __new__() method in the Cell class?", "input": "OpenMC Python API Cell.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the id() method in the Cell class?", "input": "OpenMC Python API Cell.id() method signature", "output": "To call the id() method, use: @property def id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the id() method in the Cell class?", "input": "OpenMC Python API Cell.id() method signature", "output": "To call the id() method, use: @id.setter def id(self: Any, cell_id: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the Cell class?", "input": "OpenMC Python API Cell.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Cell class?", "input": "OpenMC Python API Cell.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the fill() method in the Cell class?", "input": "OpenMC Python API Cell.fill() method signature", "output": "To call the fill() method, use: @property def fill(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fill() method in the Cell class?", "input": "OpenMC Python API Cell.fill() method signature", "output": "To call the fill() method, use: @fill.setter def fill(self: Any, fill: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_instances() method in the Cell class?", "input": "OpenMC Python API Cell.num_instances() method signature", "output": "To call the num_instances() method, use: @property def num_instances(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_temperature() method do in the Cell class?", "input": "OpenMC Python API Cell.get_temperature() method", "output": "The get_temperature() method get the temperature of a cell. It's used for cell operations." }, { "instruction": "How do you call the get_temperature() method in the Cell class?", "input": "OpenMC Python API Cell.get_temperature() method signature", "output": "To call the get_temperature() method, use: def get_temperature(self: Any, instance: Any). It takes 2 parameters." }, { "instruction": "What does the instance parameter do in the get_temperature() method?", "input": "OpenMC Python API Cell.get_temperature() parameter instance", "output": "The instance parameter which instance of the cell. It should be a int or None value." }, { "instruction": "What does the set_temperature() method do in the Cell class?", "input": "OpenMC Python API Cell.set_temperature() method", "output": "The set_temperature() method set the temperature of a cell. It's used for cell operations." }, { "instruction": "How do you call the set_temperature() method in the Cell class?", "input": "OpenMC Python API Cell.set_temperature() method signature", "output": "To call the set_temperature() method, use: def set_temperature(self: Any, T: Any, instance: Any, set_contained: Any). It takes 4 parameters." }, { "instruction": "What does the T parameter do in the set_temperature() method?", "input": "OpenMC Python API Cell.set_temperature() parameter T", "output": "The T parameter temperature in k. It should be a float value." }, { "instruction": "What does the instance parameter do in the set_temperature() method?", "input": "OpenMC Python API Cell.set_temperature() parameter instance", "output": "The instance parameter which instance of the cell. It should be a int or None value." }, { "instruction": "What does the set_contained parameter do in the set_temperature() method?", "input": "OpenMC Python API Cell.set_temperature() parameter set_contained", "output": "The set_contained parameter if cell is not filled by a material, whether to set the temperature of all filled cells. It should be a bool value." }, { "instruction": "How do you call the translation() method in the Cell class?", "input": "OpenMC Python API Cell.translation() method signature", "output": "To call the translation() method, use: @property def translation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the translation() method in the Cell class?", "input": "OpenMC Python API Cell.translation() method signature", "output": "To call the translation() method, use: @translation.setter def translation(self: Any, translation_vec: Any). It takes 2 parameters." }, { "instruction": "How do you call the rotation() method in the Cell class?", "input": "OpenMC Python API Cell.rotation() method signature", "output": "To call the rotation() method, use: @property def rotation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rotation() method in the Cell class?", "input": "OpenMC Python API Cell.rotation() method signature", "output": "To call the rotation() method, use: @rotation.setter def rotation(self: Any, rotation_data: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the Cell class?", "input": "OpenMC Python API Cell.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getitem__() method in the _CellMapping class?", "input": "OpenMC Python API _CellMapping.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the _CellMapping class?", "input": "OpenMC Python API _CellMapping.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _CellMapping class?", "input": "OpenMC Python API _CellMapping.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _CellMapping class?", "input": "OpenMC Python API _CellMapping.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What is the _DLLGlobal class in OpenMC's Python API?", "input": "OpenMC Python API _DLLGlobal class", "output": "The _DLLGlobal class represents data descriptor that exposes global variables from libopenmc.. It provides 3 methods and 0 properties for working with _dllglobal data in OpenMC." }, { "instruction": "What does the _DLLGlobal class do in OpenMC's Python API?", "input": "OpenMC Python API _DLLGlobal class description", "output": "The _DLLGlobal class data descriptor that exposes global variables from libopenmc.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the _DLLGlobal class?", "input": "OpenMC Python API _DLLGlobal.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, ctype: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the __get__() method in the _DLLGlobal class?", "input": "OpenMC Python API _DLLGlobal.__get__() method signature", "output": "To call the __get__() method, use: def __get__(self: Any, instance: Any, owner: Any). It takes 3 parameters." }, { "instruction": "How do you call the __set__() method in the _DLLGlobal class?", "input": "OpenMC Python API _DLLGlobal.__set__() method signature", "output": "To call the __set__() method, use: def __set__(self: Any, instance: Any, value: Any). It takes 3 parameters." }, { "instruction": "How do you call the __repr__() method in the _FortranObject class?", "input": "OpenMC Python API _FortranObject.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __init__() method in the _FortranObjectWithID class?", "input": "OpenMC Python API _FortranObjectWithID.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the __repr__() method in the _FortranObjectWithID class?", "input": "OpenMC Python API _FortranObjectWithID.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the global_bounding_box() function do in OpenMC's Python API?", "input": "OpenMC Python API global_bounding_box() function", "output": "The global_bounding_box() function calculate a global bounding box for the model. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the global_bounding_box() function in OpenMC's Python API?", "input": "OpenMC Python API global_bounding_box() function purpose", "output": "The global_bounding_box() function calculate a global bounding box for the model. It's part of OpenMC's Python API." }, { "instruction": "How do you call the global_bounding_box() function in OpenMC's Python API?", "input": "OpenMC Python API global_bounding_box() function signature", "output": "To call the global_bounding_box() function, use: def global_bounding_box(). It takes 0 parameters." }, { "instruction": "What does the calculate_volumes() function do in OpenMC's Python API?", "input": "OpenMC Python API calculate_volumes() function", "output": "The calculate_volumes() function run stochastic volume calculation .. versionchanged:: 0.13.0 the *output* argument was added. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the calculate_volumes() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_volumes() function purpose", "output": "The calculate_volumes() function run stochastic volume calculation .. versionchanged:: 0.13.0 the *output* argument was added. It's part of OpenMC's Python API." }, { "instruction": "How do you call the calculate_volumes() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_volumes() function signature", "output": "To call the calculate_volumes() function, use: def calculate_volumes(output: Any). It takes 1 parameters." }, { "instruction": "What does the output parameter do in the calculate_volumes() function?", "input": "OpenMC Python API calculate_volumes() parameter output", "output": "The output parameter whether or not to show output. defaults to showing output. It should be a bool, optional value." }, { "instruction": "What does the current_batch() function do in OpenMC's Python API?", "input": "OpenMC Python API current_batch() function", "output": "The current_batch() function return the current batch of the simulation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the current_batch() function in OpenMC's Python API?", "input": "OpenMC Python API current_batch() function purpose", "output": "The current_batch() function return the current batch of the simulation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the current_batch() function in OpenMC's Python API?", "input": "OpenMC Python API current_batch() function signature", "output": "To call the current_batch() function, use: def current_batch(). It takes 0 parameters." }, { "instruction": "What does the export_properties() function do in OpenMC's Python API?", "input": "OpenMC Python API export_properties() function", "output": "The export_properties() function export physical properties. .. versionadded:: 0.13.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the export_properties() function in OpenMC's Python API?", "input": "OpenMC Python API export_properties() function purpose", "output": "The export_properties() function export physical properties. .. versionadded:: 0.13.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the export_properties() function in OpenMC's Python API?", "input": "OpenMC Python API export_properties() function signature", "output": "To call the export_properties() function, use: def export_properties(filename: Any, output: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the export_properties() function?", "input": "OpenMC Python API export_properties() parameter filename", "output": "The filename parameter filename to export properties to (defaults to \"properties.h5\"). It should be a str or None value." }, { "instruction": "What does the output parameter do in the export_properties() function?", "input": "OpenMC Python API export_properties() parameter output", "output": "The output parameter whether or not to show output. defaults to showing output see also -------- openmc.lib.import_properties. It should be a bool, optional value." }, { "instruction": "What does the export_weight_windows() function do in OpenMC's Python API?", "input": "OpenMC Python API export_weight_windows() function", "output": "The export_weight_windows() function export weight windows. .. versionadded:: 0.14.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the export_weight_windows() function in OpenMC's Python API?", "input": "OpenMC Python API export_weight_windows() function purpose", "output": "The export_weight_windows() function export weight windows. .. versionadded:: 0.14.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the export_weight_windows() function in OpenMC's Python API?", "input": "OpenMC Python API export_weight_windows() function signature", "output": "To call the export_weight_windows() function, use: def export_weight_windows(filename: Any, output: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the export_weight_windows() function?", "input": "OpenMC Python API export_weight_windows() parameter filename", "output": "The filename parameter filename to export weight windows to. It should be a PathLike or None value." }, { "instruction": "What does the output parameter do in the export_weight_windows() function?", "input": "OpenMC Python API export_weight_windows() parameter output", "output": "The output parameter whether or not to show output. see also -------- openmc.lib.import_weight_windows. It should be a bool, optional value." }, { "instruction": "What does the import_weight_windows() function do in OpenMC's Python API?", "input": "OpenMC Python API import_weight_windows() function", "output": "The import_weight_windows() function import weight windows. .. versionadded:: 0.14.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the import_weight_windows() function in OpenMC's Python API?", "input": "OpenMC Python API import_weight_windows() function purpose", "output": "The import_weight_windows() function import weight windows. .. versionadded:: 0.14.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the import_weight_windows() function in OpenMC's Python API?", "input": "OpenMC Python API import_weight_windows() function signature", "output": "To call the import_weight_windows() function, use: def import_weight_windows(filename: Any, output: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the import_weight_windows() function?", "input": "OpenMC Python API import_weight_windows() parameter filename", "output": "The filename parameter filename to import weight windows from. It should be a PathLike or None value." }, { "instruction": "What does the output parameter do in the import_weight_windows() function?", "input": "OpenMC Python API import_weight_windows() parameter output", "output": "The output parameter whether or not to show output. see also -------- openmc.lib.export_weight_windows. It should be a bool, optional value." }, { "instruction": "What does the finalize() function do in OpenMC's Python API?", "input": "OpenMC Python API finalize() function", "output": "The finalize() function finalize simulation and free memory. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the finalize() function in OpenMC's Python API?", "input": "OpenMC Python API finalize() function purpose", "output": "The finalize() function finalize simulation and free memory. It's part of OpenMC's Python API." }, { "instruction": "How do you call the finalize() function in OpenMC's Python API?", "input": "OpenMC Python API finalize() function signature", "output": "To call the finalize() function, use: def finalize(). It takes 0 parameters." }, { "instruction": "What does the find_cell() function do in OpenMC's Python API?", "input": "OpenMC Python API find_cell() function", "output": "The find_cell() function find the cell at a given point. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the find_cell() function in OpenMC's Python API?", "input": "OpenMC Python API find_cell() function purpose", "output": "The find_cell() function find the cell at a given point. It's part of OpenMC's Python API." }, { "instruction": "How do you call the find_cell() function in OpenMC's Python API?", "input": "OpenMC Python API find_cell() function signature", "output": "To call the find_cell() function, use: def find_cell(xyz: Any). It takes 1 parameters." }, { "instruction": "What does the xyz parameter do in the find_cell() function?", "input": "OpenMC Python API find_cell() parameter xyz", "output": "The xyz parameter cartesian coordinates of position. It should be a iterable of float value." }, { "instruction": "What does the find_material() function do in OpenMC's Python API?", "input": "OpenMC Python API find_material() function", "output": "The find_material() function find the material at a given point. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the find_material() function in OpenMC's Python API?", "input": "OpenMC Python API find_material() function purpose", "output": "The find_material() function find the material at a given point. It's part of OpenMC's Python API." }, { "instruction": "How do you call the find_material() function in OpenMC's Python API?", "input": "OpenMC Python API find_material() function signature", "output": "To call the find_material() function, use: def find_material(xyz: Any). It takes 1 parameters." }, { "instruction": "What does the xyz parameter do in the find_material() function?", "input": "OpenMC Python API find_material() parameter xyz", "output": "The xyz parameter cartesian coordinates of position. It should be a iterable of float value." }, { "instruction": "What does the hard_reset() function do in OpenMC's Python API?", "input": "OpenMC Python API hard_reset() function", "output": "The hard_reset() function reset tallies, timers, and pseudo-random number generator state.. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the hard_reset() function in OpenMC's Python API?", "input": "OpenMC Python API hard_reset() function purpose", "output": "The hard_reset() function reset tallies, timers, and pseudo-random number generator state.. It's part of OpenMC's Python API." }, { "instruction": "How do you call the hard_reset() function in OpenMC's Python API?", "input": "OpenMC Python API hard_reset() function signature", "output": "To call the hard_reset() function, use: def hard_reset(). It takes 0 parameters." }, { "instruction": "What does the import_properties() function do in OpenMC's Python API?", "input": "OpenMC Python API import_properties() function", "output": "The import_properties() function import physical properties. .. versionadded:: 0.13.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the import_properties() function in OpenMC's Python API?", "input": "OpenMC Python API import_properties() function purpose", "output": "The import_properties() function import physical properties. .. versionadded:: 0.13.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the import_properties() function in OpenMC's Python API?", "input": "OpenMC Python API import_properties() function signature", "output": "To call the import_properties() function, use: def import_properties(filename: Any). It takes 1 parameters." }, { "instruction": "What does the filename parameter do in the import_properties() function?", "input": "OpenMC Python API import_properties() parameter filename", "output": "The filename parameter filename to import properties from see also -------- openmc.lib.export_properties. It should be a str value." }, { "instruction": "What does the init() function do in OpenMC's Python API?", "input": "OpenMC Python API init() function", "output": "The init() function initialize openmc .. versionchanged:: 0.13.0 the *output* argument was added. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the init() function in OpenMC's Python API?", "input": "OpenMC Python API init() function purpose", "output": "The init() function initialize openmc .. versionchanged:: 0.13.0 the *output* argument was added. It's part of OpenMC's Python API." }, { "instruction": "How do you call the init() function in OpenMC's Python API?", "input": "OpenMC Python API init() function signature", "output": "To call the init() function, use: def init(args: Any, intracomm: Any, output: Any). It takes 3 parameters." }, { "instruction": "What does the args parameter do in the init() function?", "input": "OpenMC Python API init() parameter args", "output": "The args parameter command-line arguments. It should be a list of str, optional value." }, { "instruction": "What does the intracomm parameter do in the init() function?", "input": "OpenMC Python API init() parameter intracomm", "output": "The intracomm parameter mpi intracommunicator. It should be a mpi4py.MPI.Intracomm or None, optional value." }, { "instruction": "What does the output parameter do in the init() function?", "input": "OpenMC Python API init() parameter output", "output": "The output parameter whether or not to show output. defaults to showing output. It should be a bool, optional value." }, { "instruction": "What does the is_statepoint_batch() function do in OpenMC's Python API?", "input": "OpenMC Python API is_statepoint_batch() function", "output": "The is_statepoint_batch() function return whether statepoint will be written in current batch or not. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the is_statepoint_batch() function in OpenMC's Python API?", "input": "OpenMC Python API is_statepoint_batch() function purpose", "output": "The is_statepoint_batch() function return whether statepoint will be written in current batch or not. It's part of OpenMC's Python API." }, { "instruction": "How do you call the is_statepoint_batch() function in OpenMC's Python API?", "input": "OpenMC Python API is_statepoint_batch() function signature", "output": "To call the is_statepoint_batch() function, use: def is_statepoint_batch(). It takes 0 parameters." }, { "instruction": "What does the iter_batches() function do in OpenMC's Python API?", "input": "OpenMC Python API iter_batches() function", "output": "The iter_batches() function iterator over batches.\n\n this function returns a generator-iterator that allows python code to be run\n between batches in an openmc simulation. it should be used in conjunction\n with :func:`openmc.lib.simulation_init` and\n :func:`openmc.lib.simulation_finalize`. for example:\n\n .. code-block:: python\n\n with openmc.lib.run_in_memory():\n openmc.lib.simulation_init()\n for _ in openmc.lib.iter_batches():\n # look at convergence of tallies, for example\n ...\n openmc.lib.simulation_finalize()\n\n see also\n --------\n openmc.lib.next_batch. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the iter_batches() function in OpenMC's Python API?", "input": "OpenMC Python API iter_batches() function purpose", "output": "The iter_batches() function iterator over batches.\n\n this function returns a generator-iterator that allows python code to be run\n between batches in an openmc simulation. it should be used in conjunction\n with :func:`openmc.lib.simulation_init` and\n :func:`openmc.lib.simulation_finalize`. for example:\n\n .. code-block:: python\n\n with openmc.lib.run_in_memory():\n openmc.lib.simulation_init()\n for _ in openmc.lib.iter_batches():\n # look at convergence of tallies, for example\n ...\n openmc.lib.simulation_finalize()\n\n see also\n --------\n openmc.lib.next_batch. It's part of OpenMC's Python API." }, { "instruction": "How do you call the iter_batches() function in OpenMC's Python API?", "input": "OpenMC Python API iter_batches() function signature", "output": "To call the iter_batches() function, use: def iter_batches(). It takes 0 parameters." }, { "instruction": "What does the keff() function do in OpenMC's Python API?", "input": "OpenMC Python API keff() function", "output": "The keff() function return the calculated k-eigenvalue and its standard deviation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the keff() function in OpenMC's Python API?", "input": "OpenMC Python API keff() function purpose", "output": "The keff() function return the calculated k-eigenvalue and its standard deviation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the keff() function in OpenMC's Python API?", "input": "OpenMC Python API keff() function signature", "output": "To call the keff() function, use: def keff(). It takes 0 parameters." }, { "instruction": "What does the master() function do in OpenMC's Python API?", "input": "OpenMC Python API master() function", "output": "The master() function return whether processor is master processor or not. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the master() function in OpenMC's Python API?", "input": "OpenMC Python API master() function purpose", "output": "The master() function return whether processor is master processor or not. It's part of OpenMC's Python API." }, { "instruction": "How do you call the master() function in OpenMC's Python API?", "input": "OpenMC Python API master() function signature", "output": "To call the master() function, use: def master(). It takes 0 parameters." }, { "instruction": "What does the next_batch() function do in OpenMC's Python API?", "input": "OpenMC Python API next_batch() function", "output": "The next_batch() function run next batch. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the next_batch() function in OpenMC's Python API?", "input": "OpenMC Python API next_batch() function purpose", "output": "The next_batch() function run next batch. It's part of OpenMC's Python API." }, { "instruction": "How do you call the next_batch() function in OpenMC's Python API?", "input": "OpenMC Python API next_batch() function signature", "output": "To call the next_batch() function, use: def next_batch(). It takes 0 parameters." }, { "instruction": "What does the plot_geometry() function do in OpenMC's Python API?", "input": "OpenMC Python API plot_geometry() function", "output": "The plot_geometry() function plot geometry .. versionchanged:: 0.13.0 the *output* argument was added. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the plot_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API plot_geometry() function purpose", "output": "The plot_geometry() function plot geometry .. versionchanged:: 0.13.0 the *output* argument was added. It's part of OpenMC's Python API." }, { "instruction": "How do you call the plot_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API plot_geometry() function signature", "output": "To call the plot_geometry() function, use: def plot_geometry(output: Any). It takes 1 parameters." }, { "instruction": "What does the output parameter do in the plot_geometry() function?", "input": "OpenMC Python API plot_geometry() parameter output", "output": "The output parameter whether or not to show output. defaults to showing output. It should be a bool, optional value." }, { "instruction": "What does the reset() function do in OpenMC's Python API?", "input": "OpenMC Python API reset() function", "output": "The reset() function reset tally results. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the reset() function in OpenMC's Python API?", "input": "OpenMC Python API reset() function purpose", "output": "The reset() function reset tally results. It's part of OpenMC's Python API." }, { "instruction": "How do you call the reset() function in OpenMC's Python API?", "input": "OpenMC Python API reset() function signature", "output": "To call the reset() function, use: def reset(). It takes 0 parameters." }, { "instruction": "What does the reset_timers() function do in OpenMC's Python API?", "input": "OpenMC Python API reset_timers() function", "output": "The reset_timers() function reset timers.. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the reset_timers() function in OpenMC's Python API?", "input": "OpenMC Python API reset_timers() function purpose", "output": "The reset_timers() function reset timers.. It's part of OpenMC's Python API." }, { "instruction": "How do you call the reset_timers() function in OpenMC's Python API?", "input": "OpenMC Python API reset_timers() function signature", "output": "To call the reset_timers() function, use: def reset_timers(). It takes 0 parameters." }, { "instruction": "What does the run() function do in OpenMC's Python API?", "input": "OpenMC Python API run() function", "output": "The run() function run simulation .. versionchanged:: 0.13.0 the *output* argument was added. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the run() function in OpenMC's Python API?", "input": "OpenMC Python API run() function purpose", "output": "The run() function run simulation .. versionchanged:: 0.13.0 the *output* argument was added. It's part of OpenMC's Python API." }, { "instruction": "How do you call the run() function in OpenMC's Python API?", "input": "OpenMC Python API run() function signature", "output": "To call the run() function, use: def run(output: Any). It takes 1 parameters." }, { "instruction": "What does the output parameter do in the run() function?", "input": "OpenMC Python API run() parameter output", "output": "The output parameter whether or not to show output. defaults to showing output. It should be a bool, optional value." }, { "instruction": "What does the sample_external_source() function do in OpenMC's Python API?", "input": "OpenMC Python API sample_external_source() function", "output": "The sample_external_source() function sample external source and return source particles. .. versionadded:: 0.13.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the sample_external_source() function in OpenMC's Python API?", "input": "OpenMC Python API sample_external_source() function purpose", "output": "The sample_external_source() function sample external source and return source particles. .. versionadded:: 0.13.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the sample_external_source() function in OpenMC's Python API?", "input": "OpenMC Python API sample_external_source() function signature", "output": "To call the sample_external_source() function, use: def sample_external_source(n_samples: int, prn_seed: Any). It takes 2 parameters." }, { "instruction": "What does the n_samples parameter do in the sample_external_source() function?", "input": "OpenMC Python API sample_external_source() parameter n_samples", "output": "The n_samples parameter number of samples. It should be a int value." }, { "instruction": "What does the prn_seed parameter do in the sample_external_source() function?", "input": "OpenMC Python API sample_external_source() parameter prn_seed", "output": "The prn_seed parameter pseudorandom number generator (prng) seed; if none, one will be generated randomly.. It should be a int value." }, { "instruction": "What does the simulation_init() function do in OpenMC's Python API?", "input": "OpenMC Python API simulation_init() function", "output": "The simulation_init() function initialize simulation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the simulation_init() function in OpenMC's Python API?", "input": "OpenMC Python API simulation_init() function purpose", "output": "The simulation_init() function initialize simulation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the simulation_init() function in OpenMC's Python API?", "input": "OpenMC Python API simulation_init() function signature", "output": "To call the simulation_init() function, use: def simulation_init(). It takes 0 parameters." }, { "instruction": "What does the simulation_finalize() function do in OpenMC's Python API?", "input": "OpenMC Python API simulation_finalize() function", "output": "The simulation_finalize() function finalize simulation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the simulation_finalize() function in OpenMC's Python API?", "input": "OpenMC Python API simulation_finalize() function purpose", "output": "The simulation_finalize() function finalize simulation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the simulation_finalize() function in OpenMC's Python API?", "input": "OpenMC Python API simulation_finalize() function signature", "output": "To call the simulation_finalize() function, use: def simulation_finalize(). It takes 0 parameters." }, { "instruction": "What does the source_bank() function do in OpenMC's Python API?", "input": "OpenMC Python API source_bank() function", "output": "The source_bank() function return source bank as numpy array. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the source_bank() function in OpenMC's Python API?", "input": "OpenMC Python API source_bank() function purpose", "output": "The source_bank() function return source bank as numpy array. It's part of OpenMC's Python API." }, { "instruction": "How do you call the source_bank() function in OpenMC's Python API?", "input": "OpenMC Python API source_bank() function signature", "output": "To call the source_bank() function, use: def source_bank(). It takes 0 parameters." }, { "instruction": "What does the statepoint_write() function do in OpenMC's Python API?", "input": "OpenMC Python API statepoint_write() function", "output": "The statepoint_write() function write a statepoint file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the statepoint_write() function in OpenMC's Python API?", "input": "OpenMC Python API statepoint_write() function purpose", "output": "The statepoint_write() function write a statepoint file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the statepoint_write() function in OpenMC's Python API?", "input": "OpenMC Python API statepoint_write() function signature", "output": "To call the statepoint_write() function, use: def statepoint_write(filename: Any, write_source: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the statepoint_write() function?", "input": "OpenMC Python API statepoint_write() parameter filename", "output": "The filename parameter path to the statepoint to write. if none is passed, a default name that contains the current batch will be written.. It should be a str or None value." }, { "instruction": "What does the write_source parameter do in the statepoint_write() function?", "input": "OpenMC Python API statepoint_write() parameter write_source", "output": "The write_source parameter whether or not to include the source bank in the statepoint.. It should be a bool value." }, { "instruction": "What does the statepoint_load() function do in OpenMC's Python API?", "input": "OpenMC Python API statepoint_load() function", "output": "The statepoint_load() function load a statepoint file. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the statepoint_load() function in OpenMC's Python API?", "input": "OpenMC Python API statepoint_load() function purpose", "output": "The statepoint_load() function load a statepoint file. It's part of OpenMC's Python API." }, { "instruction": "How do you call the statepoint_load() function in OpenMC's Python API?", "input": "OpenMC Python API statepoint_load() function signature", "output": "To call the statepoint_load() function, use: def statepoint_load(filename: PathLike). It takes 1 parameters." }, { "instruction": "What does the filename parameter do in the statepoint_load() function?", "input": "OpenMC Python API statepoint_load() parameter filename", "output": "The filename parameter path to the statepoint to load.. It should be a path-like value." }, { "instruction": "What does the run_in_memory() function do in OpenMC's Python API?", "input": "OpenMC Python API run_in_memory() function", "output": "The run_in_memory() function provides context manager for calling openmc shared library functions. this function is intended to be used in a 'with' statement and ensures that openmc is properly initialized/finalized. at the completion of the 'with' block, all memory that was allocated during the block is freed. for example:: with openmc.lib.run_in_memory(): for i in range(n_iters): openmc.lib.reset() do_stuff() openmc.lib.run(). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the run_in_memory() function in OpenMC's Python API?", "input": "OpenMC Python API run_in_memory() function purpose", "output": "The run_in_memory() function provides context manager for calling openmc shared library functions. this function is intended to be used in a 'with' statement and ensures that openmc is properly initialized/finalized. at the completion of the 'with' block, all memory that was allocated during the block is freed. for example:: with openmc.lib.run_in_memory(): for i in range(n_iters): openmc.lib.reset() do_stuff() openmc.lib.run(). It's part of OpenMC's Python API." }, { "instruction": "How do you call the run_in_memory() function in OpenMC's Python API?", "input": "OpenMC Python API run_in_memory() function signature", "output": "To call the run_in_memory() function, use: @contextmanager def run_in_memory(). It takes 0 parameters." }, { "instruction": "What does the quiet_dll() function do in OpenMC's Python API?", "input": "OpenMC Python API quiet_dll() function", "output": "The quiet_dll() function this context manager allows us to suppress standard output from dlls. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the quiet_dll() function in OpenMC's Python API?", "input": "OpenMC Python API quiet_dll() function purpose", "output": "The quiet_dll() function this context manager allows us to suppress standard output from dlls. It's part of OpenMC's Python API." }, { "instruction": "How do you call the quiet_dll() function in OpenMC's Python API?", "input": "OpenMC Python API quiet_dll() function signature", "output": "To call the quiet_dll() function, use: @contextmanager def quiet_dll(output: Any). It takes 1 parameters." }, { "instruction": "What does the output parameter do in the quiet_dll() function?", "input": "OpenMC Python API quiet_dll() parameter output", "output": "The output parameter denotes whether the output should be displayed (true) or not (false) .. versionadded:: 0.13.0. It should be a bool value." }, { "instruction": "What does the dagmc_universe_cell_ids() function do in OpenMC's Python API?", "input": "OpenMC Python API dagmc_universe_cell_ids() function", "output": "The dagmc_universe_cell_ids() function return an array of cell ids for a dagmc universe. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the dagmc_universe_cell_ids() function in OpenMC's Python API?", "input": "OpenMC Python API dagmc_universe_cell_ids() function purpose", "output": "The dagmc_universe_cell_ids() function return an array of cell ids for a dagmc universe. It's part of OpenMC's Python API." }, { "instruction": "How do you call the dagmc_universe_cell_ids() function in OpenMC's Python API?", "input": "OpenMC Python API dagmc_universe_cell_ids() function signature", "output": "To call the dagmc_universe_cell_ids() function, use: def dagmc_universe_cell_ids(universe_id: int). It takes 1 parameters." }, { "instruction": "What does the dagmc_id parameter do in the dagmc_universe_cell_ids() function?", "input": "OpenMC Python API dagmc_universe_cell_ids() parameter dagmc_id", "output": "The dagmc_id parameter id of the dagmc universe to get cell ids from.. It should be a int value." }, { "instruction": "What does the _error_handler() function do in OpenMC's Python API?", "input": "OpenMC Python API _error_handler() function", "output": "The _error_handler() function raise exception according to error code.. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _error_handler() function in OpenMC's Python API?", "input": "OpenMC Python API _error_handler() function purpose", "output": "The _error_handler() function raise exception according to error code.. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _error_handler() function in OpenMC's Python API?", "input": "OpenMC Python API _error_handler() function signature", "output": "To call the _error_handler() function, use: def _error_handler(err: Any, func: Any, args: Any). It takes 3 parameters." }, { "instruction": "How do you call the errcode() function in OpenMC's Python API?", "input": "OpenMC Python API errcode() function signature", "output": "To call the errcode() function, use: def errcode(s: Any). It takes 1 parameters." }, { "instruction": "How do you call the __new__() method in the Filter class?", "input": "OpenMC Python API Filter.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, obj: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the id() method in the Filter class?", "input": "OpenMC Python API Filter.id() method signature", "output": "To call the id() method, use: @property def id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the id() method in the Filter class?", "input": "OpenMC Python API Filter.id() method signature", "output": "To call the id() method, use: @id.setter def id(self: Any, filter_id: Any). It takes 2 parameters." }, { "instruction": "How do you call the n_bins() method in the Filter class?", "input": "OpenMC Python API Filter.n_bins() method signature", "output": "To call the n_bins() method, use: @property def n_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __init__() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, bins: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the bins() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bins() method in the EnergyFilter class?", "input": "OpenMC Python API EnergyFilter.bins() method signature", "output": "To call the bins() method, use: @bins.setter def bins(self: Any, bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the bins() method in the CellFilter class?", "input": "OpenMC Python API CellFilter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __new__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, energy: Any, y: Any, uid: Any, new: Any, index: Any). It takes 6 parameters." }, { "instruction": "How do you call the __init__() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy: Any, y: Any, uid: Any, new: Any, index: Any). It takes 6 parameters." }, { "instruction": "What does the set_data() method do in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.set_data() method", "output": "The set_data() method set the interpolation information for the filter. It's used for energyfunctionfilter operations." }, { "instruction": "How do you call the set_data() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.set_data() method signature", "output": "To call the set_data() method, use: def set_data(self: Any, energy: Any, y: Any). It takes 3 parameters." }, { "instruction": "What does the energy parameter do in the set_data() method?", "input": "OpenMC Python API EnergyFunctionFilter.set_data() parameter energy", "output": "The energy parameter independent variable for the interpolation. It should be a numpy.ndarray value." }, { "instruction": "What does the y parameter do in the set_data() method?", "input": "OpenMC Python API EnergyFunctionFilter.set_data() parameter y", "output": "The y parameter dependent variable for the interpolation. It should be a numpy.ndarray value." }, { "instruction": "What does the interpolation parameter do in the set_data() method?", "input": "OpenMC Python API EnergyFunctionFilter.set_data() parameter interpolation", "output": "The interpolation parameter interpolation scheme. It should be a {'histogram', 'linear-linear', 'linear-log', 'log-linear', 'log-log', 'quadratic', 'cubic'} value." }, { "instruction": "How do you call the energy() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the y() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.y() method signature", "output": "To call the y() method, use: @property def y(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interp: str). It takes 2 parameters." }, { "instruction": "How do you call the _get_attr() method in the EnergyFunctionFilter class?", "input": "OpenMC Python API EnergyFunctionFilter._get_attr() method signature", "output": "To call the _get_attr() method, use: def _get_attr(self: Any, cfunc: Any). It takes 2 parameters." }, { "instruction": "How do you call the __init__() method in the LegendreFilter class?", "input": "OpenMC Python API LegendreFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the order() method in the LegendreFilter class?", "input": "OpenMC Python API LegendreFilter.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the LegendreFilter class?", "input": "OpenMC Python API LegendreFilter.order() method signature", "output": "To call the order() method, use: @order.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the __init__() method in the MaterialFilter class?", "input": "OpenMC Python API MaterialFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, bins: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the bins() method in the MaterialFilter class?", "input": "OpenMC Python API MaterialFilter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bins() method in the MaterialFilter class?", "input": "OpenMC Python API MaterialFilter.bins() method signature", "output": "To call the bins() method, use: @bins.setter def bins(self: Any, materials: Any). It takes 2 parameters." }, { "instruction": "What is the MeshFilter class in OpenMC's Python API?", "input": "OpenMC Python API MeshFilter class", "output": "The MeshFilter class represents mesh filter stored internally. this class exposes a mesh filter that is stored internally in the openmc library. to obtain a view of a mesh filter with a given id, use the :data:`openmc.lib.filters` mapping. It provides 5 methods and 0 properties for working with meshfilter data in OpenMC." }, { "instruction": "What does the MeshFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MeshFilter class description", "output": "The MeshFilter class mesh filter stored internally. this class exposes a mesh filter that is stored internally in the openmc library. to obtain a view of a mesh filter with a given id, use the :data:`openmc.lib.filters` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshFilter?", "input": "OpenMC Python API MeshFilter constructor parameter mesh", "output": "When creating a MeshFilter, the mesh parameter specifies mesh to use for the filter. It should be a openmc.lib.Mesh value." }, { "instruction": "What does the uid parameter do when creating a MeshFilter?", "input": "OpenMC Python API MeshFilter constructor parameter uid", "output": "When creating a MeshFilter, the uid parameter specifies unique id of the mesh filter. It should be a int or None value." }, { "instruction": "What does the new parameter do when creating a MeshFilter?", "input": "OpenMC Python API MeshFilter constructor parameter new", "output": "When creating a MeshFilter, the new parameter specifies when `index` is none, this argument controls whether a new object is created or a view of an existing object is returned.. It should be a bool value." }, { "instruction": "What does the index parameter do when creating a MeshFilter?", "input": "OpenMC Python API MeshFilter constructor parameter index", "output": "When creating a MeshFilter, the index parameter specifies index in the `filters` array.. It should be a int value." }, { "instruction": "What is the filter_type attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute filter_type", "output": "The filter_type attribute of a MeshFilter contains type of filter. It's a str value that you can access after creating a MeshFilter instance." }, { "instruction": "What is the mesh attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute mesh", "output": "The mesh attribute of a MeshFilter contains mesh used for the filter. It's a openmc.lib.Mesh value that you can access after creating a MeshFilter instance." }, { "instruction": "What is the translation attribute of a MeshFilter?", "input": "OpenMC Python API MeshFilter attribute translation", "output": "The translation attribute of a MeshFilter contains 3-d coordinates of the translation vector. It's a Iterable of float value that you can access after creating a MeshFilter instance." }, { "instruction": "How do you call the __init__() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the mesh() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, mesh: Any). It takes 2 parameters." }, { "instruction": "How do you call the translation() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.translation() method signature", "output": "To call the translation() method, use: @property def translation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the translation() method in the MeshFilter class?", "input": "OpenMC Python API MeshFilter.translation() method signature", "output": "To call the translation() method, use: @translation.setter def translation(self: Any, translation: Any). It takes 2 parameters." }, { "instruction": "What is the MeshBornFilter class in OpenMC's Python API?", "input": "OpenMC Python API MeshBornFilter class", "output": "The MeshBornFilter class represents meshborn filter stored internally. this class exposes a meshborn filter that is stored internally in the openmc library. to obtain a view of a meshborn filter with a given id, use the :data:`openmc.lib.filters` mapping. It provides 5 methods and 0 properties for working with meshbornfilter data in OpenMC." }, { "instruction": "What does the MeshBornFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MeshBornFilter class description", "output": "The MeshBornFilter class meshborn filter stored internally. this class exposes a meshborn filter that is stored internally in the openmc library. to obtain a view of a meshborn filter with a given id, use the :data:`openmc.lib.filters` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter constructor parameter mesh", "output": "When creating a MeshBornFilter, the mesh parameter specifies mesh to use for the filter. It should be a openmc.lib.Mesh value." }, { "instruction": "What does the uid parameter do when creating a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter constructor parameter uid", "output": "When creating a MeshBornFilter, the uid parameter specifies unique id of the meshborn filter. It should be a int or None value." }, { "instruction": "What does the new parameter do when creating a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter constructor parameter new", "output": "When creating a MeshBornFilter, the new parameter specifies when `index` is none, this argument controls whether a new object is created or a view of an existing object is returned.. It should be a bool value." }, { "instruction": "What does the index parameter do when creating a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter constructor parameter index", "output": "When creating a MeshBornFilter, the index parameter specifies index in the `filters` array.. It should be a int value." }, { "instruction": "What is the filter_type attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute filter_type", "output": "The filter_type attribute of a MeshBornFilter contains type of filter. It's a str value that you can access after creating a MeshBornFilter instance." }, { "instruction": "What is the mesh attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute mesh", "output": "The mesh attribute of a MeshBornFilter contains mesh used for the filter. It's a openmc.lib.Mesh value that you can access after creating a MeshBornFilter instance." }, { "instruction": "What is the translation attribute of a MeshBornFilter?", "input": "OpenMC Python API MeshBornFilter attribute translation", "output": "The translation attribute of a MeshBornFilter contains 3-d coordinates of the translation vector. It's a Iterable of float value that you can access after creating a MeshBornFilter instance." }, { "instruction": "How do you call the __init__() method in the MeshBornFilter class?", "input": "OpenMC Python API MeshBornFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the mesh() method in the MeshBornFilter class?", "input": "OpenMC Python API MeshBornFilter.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the MeshBornFilter class?", "input": "OpenMC Python API MeshBornFilter.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, mesh: Any). It takes 2 parameters." }, { "instruction": "How do you call the translation() method in the MeshBornFilter class?", "input": "OpenMC Python API MeshBornFilter.translation() method signature", "output": "To call the translation() method, use: @property def translation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the translation() method in the MeshBornFilter class?", "input": "OpenMC Python API MeshBornFilter.translation() method signature", "output": "To call the translation() method, use: @translation.setter def translation(self: Any, translation: Any). It takes 2 parameters." }, { "instruction": "What is the MeshSurfaceFilter class in OpenMC's Python API?", "input": "OpenMC Python API MeshSurfaceFilter class", "output": "The MeshSurfaceFilter class represents meshsurface filter stored internally. this class exposes a meshsurface filter that is stored internally in the openmc library. to obtain a view of a meshsurface filter with a given id, use the :data:`openmc.lib.filters` mapping. It provides 5 methods and 0 properties for working with meshsurfacefilter data in OpenMC." }, { "instruction": "What does the MeshSurfaceFilter class do in OpenMC's Python API?", "input": "OpenMC Python API MeshSurfaceFilter class description", "output": "The MeshSurfaceFilter class meshsurface filter stored internally. this class exposes a meshsurface filter that is stored internally in the openmc library. to obtain a view of a meshsurface filter with a given id, use the :data:`openmc.lib.filters` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter constructor parameter mesh", "output": "When creating a MeshSurfaceFilter, the mesh parameter specifies mesh to use for the filter. It should be a openmc.lib.Mesh value." }, { "instruction": "What does the uid parameter do when creating a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter constructor parameter uid", "output": "When creating a MeshSurfaceFilter, the uid parameter specifies unique id of the meshsurface filter. It should be a int or None value." }, { "instruction": "What does the new parameter do when creating a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter constructor parameter new", "output": "When creating a MeshSurfaceFilter, the new parameter specifies when `index` is none, this argument controls whether a new object is created or a view of an existing object is returned.. It should be a bool value." }, { "instruction": "What does the index parameter do when creating a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter constructor parameter index", "output": "When creating a MeshSurfaceFilter, the index parameter specifies index in the `filters` array.. It should be a int value." }, { "instruction": "What is the filter_type attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute filter_type", "output": "The filter_type attribute of a MeshSurfaceFilter contains type of filter. It's a str value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "What is the mesh attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute mesh", "output": "The mesh attribute of a MeshSurfaceFilter contains mesh used for the filter. It's a openmc.lib.Mesh value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "What is the translation attribute of a MeshSurfaceFilter?", "input": "OpenMC Python API MeshSurfaceFilter attribute translation", "output": "The translation attribute of a MeshSurfaceFilter contains 3-d coordinates of the translation vector. It's a Iterable of float value that you can access after creating a MeshSurfaceFilter instance." }, { "instruction": "How do you call the __init__() method in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the mesh() method in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, mesh: Any). It takes 2 parameters." }, { "instruction": "How do you call the translation() method in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.translation() method signature", "output": "To call the translation() method, use: @property def translation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the translation() method in the MeshSurfaceFilter class?", "input": "OpenMC Python API MeshSurfaceFilter.translation() method signature", "output": "To call the translation() method, use: @translation.setter def translation(self: Any, translation: Any). It takes 2 parameters." }, { "instruction": "How do you call the bins() method in the ParticleFilter class?", "input": "OpenMC Python API ParticleFilter.bins() method signature", "output": "To call the bins() method, use: @property def bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __init__() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the order() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the SphericalHarmonicsFilter class?", "input": "OpenMC Python API SphericalHarmonicsFilter.order() method signature", "output": "To call the order() method, use: @order.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the __init__() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the order() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the SpatialLegendreFilter class?", "input": "OpenMC Python API SpatialLegendreFilter.order() method signature", "output": "To call the order() method, use: @order.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the __init__() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, order: Any, uid: Any, new: Any, index: Any). It takes 5 parameters." }, { "instruction": "How do you call the order() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the ZernikeFilter class?", "input": "OpenMC Python API ZernikeFilter.order() method signature", "output": "To call the order() method, use: @order.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the __getitem__() method in the _FilterMapping class?", "input": "OpenMC Python API _FilterMapping.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the _FilterMapping class?", "input": "OpenMC Python API _FilterMapping.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _FilterMapping class?", "input": "OpenMC Python API _FilterMapping.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _FilterMapping class?", "input": "OpenMC Python API _FilterMapping.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_filter() function in OpenMC's Python API?", "input": "OpenMC Python API _get_filter() function signature", "output": "To call the _get_filter() function, use: def _get_filter(index: Any). It takes 1 parameters." }, { "instruction": "What is the Material class in OpenMC's Python API?", "input": "OpenMC Python API Material class", "output": "The Material class represents material stored internally. this class exposes a material that is stored internally in the openmc library. to obtain a view of a material with a given id, use the :data:`openmc.lib.materials` mapping. It provides 17 methods and 0 properties for working with material data in OpenMC." }, { "instruction": "What does the Material class do in OpenMC's Python API?", "input": "OpenMC Python API Material class description", "output": "The Material class material stored internally. this class exposes a material that is stored internally in the openmc library. to obtain a view of a material with a given id, use the :data:`openmc.lib.materials` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the uid parameter do when creating a Material?", "input": "OpenMC Python API Material constructor parameter uid", "output": "When creating a Material, the uid parameter specifies unique id of the material. It should be a int or None value." }, { "instruction": "What does the new parameter do when creating a Material?", "input": "OpenMC Python API Material constructor parameter new", "output": "When creating a Material, the new parameter specifies when `index` is none, this argument controls whether a new object is created or a view to an existing object is returned.. It should be a bool value." }, { "instruction": "What does the index parameter do when creating a Material?", "input": "OpenMC Python API Material constructor parameter index", "output": "When creating a Material, the index parameter specifies index in the `materials` array.. It should be a int or None value." }, { "instruction": "What is the id attribute of a Material?", "input": "OpenMC Python API Material attribute id", "output": "The id attribute of a Material contains id of the material. It's a int value that you can access after creating a Material instance." }, { "instruction": "What is the nuclides attribute of a Material?", "input": "OpenMC Python API Material attribute nuclides", "output": "The nuclides attribute of a Material contains list of nuclides in the material. It's a list of str value that you can access after creating a Material instance." }, { "instruction": "What is the densities attribute of a Material?", "input": "OpenMC Python API Material attribute densities", "output": "The densities attribute of a Material contains array of densities in atom/b-cm. It's a numpy.ndarray value that you can access after creating a Material instance." }, { "instruction": "What is the depletable attribute of a Material?", "input": "OpenMC Python API Material attribute depletable", "output": "The depletable attribute of a Material contains whether this material is marked as depletable. It's a bool value that you can access after creating a Material instance." }, { "instruction": "What is the name attribute of a Material?", "input": "OpenMC Python API Material attribute name", "output": "The name attribute of a Material contains name of the material. It's a str value that you can access after creating a Material instance." }, { "instruction": "What is the temperature attribute of a Material?", "input": "OpenMC Python API Material attribute temperature", "output": "The temperature attribute of a Material contains temperature of the material in [k]. It's a float value that you can access after creating a Material instance." }, { "instruction": "What is the volume attribute of a Material?", "input": "OpenMC Python API Material attribute volume", "output": "The volume attribute of a Material contains volume of the material in [cm^3]. It's a float value that you can access after creating a Material instance." }, { "instruction": "How do you call the __new__() method in the Material class?", "input": "OpenMC Python API Material.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the id() method in the Material class?", "input": "OpenMC Python API Material.id() method signature", "output": "To call the id() method, use: @property def id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the id() method in the Material class?", "input": "OpenMC Python API Material.id() method signature", "output": "To call the id() method, use: @id.setter def id(self: Any, mat_id: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the Material class?", "input": "OpenMC Python API Material.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Material class?", "input": "OpenMC Python API Material.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the temperature() method in the Material class?", "input": "OpenMC Python API Material.temperature() method signature", "output": "To call the temperature() method, use: @property def temperature(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the Material class?", "input": "OpenMC Python API Material.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the Material class?", "input": "OpenMC Python API Material.volume() method signature", "output": "To call the volume() method, use: @volume.setter def volume(self: Any, volume: Any). It takes 2 parameters." }, { "instruction": "How do you call the depletable() method in the Material class?", "input": "OpenMC Python API Material.depletable() method signature", "output": "To call the depletable() method, use: @property def depletable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the depletable() method in the Material class?", "input": "OpenMC Python API Material.depletable() method signature", "output": "To call the depletable() method, use: @depletable.setter def depletable(self: Any, depletable: Any). It takes 2 parameters." }, { "instruction": "How do you call the nuclides() method in the Material class?", "input": "OpenMC Python API Material.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the densities() method in the Material class?", "input": "OpenMC Python API Material.densities() method signature", "output": "To call the densities() method, use: @property def densities(self: Any). It takes 1 parameters." }, { "instruction": "What does the _get_densities() method do in the Material class?", "input": "OpenMC Python API Material._get_densities() method", "output": "The _get_densities() method get atom densities in a material. It's used for material operations." }, { "instruction": "How do you call the _get_densities() method in the Material class?", "input": "OpenMC Python API Material._get_densities() method signature", "output": "To call the _get_densities() method, use: def _get_densities(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_nuclide() method do in the Material class?", "input": "OpenMC Python API Material.add_nuclide() method", "output": "The add_nuclide() method add a nuclide to a material. It's used for material operations." }, { "instruction": "How do you call the add_nuclide() method in the Material class?", "input": "OpenMC Python API Material.add_nuclide() method signature", "output": "To call the add_nuclide() method, use: def add_nuclide(self: Any, name: Any, density: Any). It takes 3 parameters." }, { "instruction": "What does the name parameter do in the add_nuclide() method?", "input": "OpenMC Python API Material.add_nuclide() parameter name", "output": "The name parameter name of nuclide, e.g. 'u235'. It should be a str value." }, { "instruction": "What does the density parameter do in the add_nuclide() method?", "input": "OpenMC Python API Material.add_nuclide() parameter density", "output": "The density parameter density in atom/b-cm. It should be a float value." }, { "instruction": "What does the get_density() method do in the Material class?", "input": "OpenMC Python API Material.get_density() method", "output": "The get_density() method get density of a material. It's used for material operations." }, { "instruction": "How do you call the get_density() method in the Material class?", "input": "OpenMC Python API Material.get_density() method signature", "output": "To call the get_density() method, use: def get_density(self: Any, units: Any). It takes 2 parameters." }, { "instruction": "What does the units parameter do in the get_density() method?", "input": "OpenMC Python API Material.get_density() parameter units", "output": "The units parameter units for density. It should be a {'atom/b-cm', 'g/cm3'} value." }, { "instruction": "What does the set_density() method do in the Material class?", "input": "OpenMC Python API Material.set_density() method", "output": "The set_density() method set density of a material. It's used for material operations." }, { "instruction": "How do you call the set_density() method in the Material class?", "input": "OpenMC Python API Material.set_density() method signature", "output": "To call the set_density() method, use: def set_density(self: Any, density: Any, units: Any). It takes 3 parameters." }, { "instruction": "What does the density parameter do in the set_density() method?", "input": "OpenMC Python API Material.set_density() parameter density", "output": "The density parameter density. It should be a float value." }, { "instruction": "What does the units parameter do in the set_density() method?", "input": "OpenMC Python API Material.set_density() parameter units", "output": "The units parameter units for density. It should be a {'atom/b-cm', 'g/cm3'} value." }, { "instruction": "What does the set_densities() method do in the Material class?", "input": "OpenMC Python API Material.set_densities() method", "output": "The set_densities() method set the densities of a list of nuclides in a material. It's used for material operations." }, { "instruction": "How do you call the set_densities() method in the Material class?", "input": "OpenMC Python API Material.set_densities() method signature", "output": "To call the set_densities() method, use: def set_densities(self: Any, nuclides: Any, densities: Any). It takes 3 parameters." }, { "instruction": "What does the nuclides parameter do in the set_densities() method?", "input": "OpenMC Python API Material.set_densities() parameter nuclides", "output": "The nuclides parameter nuclide names. It should be a iterable of str value." }, { "instruction": "What does the densities parameter do in the set_densities() method?", "input": "OpenMC Python API Material.set_densities() parameter densities", "output": "The densities parameter corresponding densities in atom/b-cm. It should be a iterable of float value." }, { "instruction": "How do you call the __getitem__() method in the _MaterialMapping class?", "input": "OpenMC Python API _MaterialMapping.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the _MaterialMapping class?", "input": "OpenMC Python API _MaterialMapping.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _MaterialMapping class?", "input": "OpenMC Python API _MaterialMapping.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _MaterialMapping class?", "input": "OpenMC Python API _MaterialMapping.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the calc_zn() function do in OpenMC's Python API?", "input": "OpenMC Python API calc_zn() function", "output": "The calc_zn() function calculate the n-th order modified zernike polynomial moment for a given angle (rho, theta) location in the unit disk. the normalization of the polynomials is such that the integral of z_pq*z_pq over the unit disk is exactly pi. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the calc_zn() function in OpenMC's Python API?", "input": "OpenMC Python API calc_zn() function purpose", "output": "The calc_zn() function calculate the n-th order modified zernike polynomial moment for a given angle (rho, theta) location in the unit disk. the normalization of the polynomials is such that the integral of z_pq*z_pq over the unit disk is exactly pi. It's part of OpenMC's Python API." }, { "instruction": "How do you call the calc_zn() function in OpenMC's Python API?", "input": "OpenMC Python API calc_zn() function signature", "output": "To call the calc_zn() function, use: def calc_zn(n: Any, rho: Any, phi: Any). It takes 3 parameters." }, { "instruction": "What does the n parameter do in the calc_zn() function?", "input": "OpenMC Python API calc_zn() parameter n", "output": "The n parameter maximum order. It should be a int value." }, { "instruction": "What does the rho parameter do in the calc_zn() function?", "input": "OpenMC Python API calc_zn() parameter rho", "output": "The rho parameter radial location in the unit disk. It should be a float value." }, { "instruction": "What does the phi parameter do in the calc_zn() function?", "input": "OpenMC Python API calc_zn() parameter phi", "output": "The phi parameter theta (radians) location in the unit disk. It should be a float value." }, { "instruction": "What does the calc_zn_rad() function do in OpenMC's Python API?", "input": "OpenMC Python API calc_zn_rad() function", "output": "The calc_zn_rad() function calculate the even orders in n-th order modified zernike polynomial moment with no azimuthal dependency (m=0) for a given radial location in the unit disk. the normalization of the polynomials is such that the integral of z_pq*z_pq over the unit disk is exactly pi. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the calc_zn_rad() function in OpenMC's Python API?", "input": "OpenMC Python API calc_zn_rad() function purpose", "output": "The calc_zn_rad() function calculate the even orders in n-th order modified zernike polynomial moment with no azimuthal dependency (m=0) for a given radial location in the unit disk. the normalization of the polynomials is such that the integral of z_pq*z_pq over the unit disk is exactly pi. It's part of OpenMC's Python API." }, { "instruction": "How do you call the calc_zn_rad() function in OpenMC's Python API?", "input": "OpenMC Python API calc_zn_rad() function signature", "output": "To call the calc_zn_rad() function, use: def calc_zn_rad(n: Any, rho: Any). It takes 2 parameters." }, { "instruction": "What does the n parameter do in the calc_zn_rad() function?", "input": "OpenMC Python API calc_zn_rad() parameter n", "output": "The n parameter maximum order. It should be a int value." }, { "instruction": "What does the rho parameter do in the calc_zn_rad() function?", "input": "OpenMC Python API calc_zn_rad() parameter rho", "output": "The rho parameter radial location in the unit disk. It should be a float value." }, { "instruction": "What is the Mesh class in OpenMC's Python API?", "input": "OpenMC Python API Mesh class", "output": "The Mesh class represents base class to represent mesh objects. It provides 8 methods and 0 properties for working with mesh data in OpenMC." }, { "instruction": "What does the Mesh class do in OpenMC's Python API?", "input": "OpenMC Python API Mesh class description", "output": "The Mesh class base class to represent mesh objects. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __new__() method in the Mesh class?", "input": "OpenMC Python API Mesh.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the id() method in the Mesh class?", "input": "OpenMC Python API Mesh.id() method signature", "output": "To call the id() method, use: @property def id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the id() method in the Mesh class?", "input": "OpenMC Python API Mesh.id() method signature", "output": "To call the id() method, use: @id.setter def id(self: Any, mesh_id: Any). It takes 2 parameters." }, { "instruction": "How do you call the n_elements() method in the Mesh class?", "input": "OpenMC Python API Mesh.n_elements() method signature", "output": "To call the n_elements() method, use: @property def n_elements(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volumes() method in the Mesh class?", "input": "OpenMC Python API Mesh.volumes() method signature", "output": "To call the volumes() method, use: @property def volumes(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the Mesh class?", "input": "OpenMC Python API Mesh.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "What does the material_volumes() method do in the Mesh class?", "input": "OpenMC Python API Mesh.material_volumes() method", "output": "The material_volumes() method determine volume of materials in each mesh element. this method works by raytracing repeatedly through the mesh to count the estimated volume of each material in all mesh elements. three sets of rays are used: one set parallel to the x-axis, one parallel to the y-axis, and one parallel to the z-axis. .. versionadded:: 0.15.0 .. versionchanged:: 0.15.1 material volumes are now determined by raytracing rather than by point sampling. It's used for mesh operations." }, { "instruction": "How do you call the material_volumes() method in the Mesh class?", "input": "OpenMC Python API Mesh.material_volumes() method signature", "output": "To call the material_volumes() method, use: def material_volumes(self: Any, n_samples: Any, max_materials: int, output: bool). It takes 4 parameters." }, { "instruction": "What does the n_samples parameter do in the material_volumes() method?", "input": "OpenMC Python API Mesh.material_volumes() parameter n_samples", "output": "The n_samples parameter total number of rays to sample. the number of rays in each direction is determined by the aspect ratio of the mesh bounding box. when specified as a 3-tuple, it is interpreted as the number of rays in the x, y, and z dimensions.. It should be a int or 3-tuple of int value." }, { "instruction": "What does the max_materials parameter do in the material_volumes() method?", "input": "OpenMC Python API Mesh.material_volumes() parameter max_materials", "output": "The max_materials parameter estimated maximum number of materials in any given mesh element.. It should be a int, optional value." }, { "instruction": "What does the output parameter do in the material_volumes() method?", "input": "OpenMC Python API Mesh.material_volumes() parameter output", "output": "The output parameter whether or not to show output.. It should be a bool, optional value." }, { "instruction": "What does the get_plot_bins() method do in the Mesh class?", "input": "OpenMC Python API Mesh.get_plot_bins() method", "output": "The get_plot_bins() method get mesh bin indices for a rasterized plot. .. versionadded:: 0.15.0. It's used for mesh operations." }, { "instruction": "How do you call the get_plot_bins() method in the Mesh class?", "input": "OpenMC Python API Mesh.get_plot_bins() method signature", "output": "To call the get_plot_bins() method, use: def get_plot_bins(self: Any, origin: Any, width: Any, basis: str, pixels: Any). It takes 5 parameters." }, { "instruction": "What does the origin parameter do in the get_plot_bins() method?", "input": "OpenMC Python API Mesh.get_plot_bins() parameter origin", "output": "The origin parameter origin of the plotting view. should have length 3.. It should be a iterable of float value." }, { "instruction": "What does the width parameter do in the get_plot_bins() method?", "input": "OpenMC Python API Mesh.get_plot_bins() parameter width", "output": "The width parameter width of the plotting view. should have length 2.. It should be a iterable of float value." }, { "instruction": "What does the basis parameter do in the get_plot_bins() method?", "input": "OpenMC Python API Mesh.get_plot_bins() parameter basis", "output": "The basis parameter plotting basis.. It should be a {'xy', 'xz', 'yz'} value." }, { "instruction": "What does the pixels parameter do in the get_plot_bins() method?", "input": "OpenMC Python API Mesh.get_plot_bins() parameter pixels", "output": "The pixels parameter number of pixels in each direction. should have length 2.. It should be a iterable of int value." }, { "instruction": "What is the RegularMesh class in OpenMC's Python API?", "input": "OpenMC Python API RegularMesh class", "output": "The RegularMesh class represents regularmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It provides 8 methods and 0 properties for working with regularmesh data in OpenMC." }, { "instruction": "What does the RegularMesh class do in OpenMC's Python API?", "input": "OpenMC Python API RegularMesh class description", "output": "The RegularMesh class regularmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the index parameter do when creating a RegularMesh?", "input": "OpenMC Python API RegularMesh constructor parameter index", "output": "When creating a RegularMesh, the index parameter specifies index in the `meshes` array.. It should be a int value." }, { "instruction": "What is the id attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute id", "output": "The id attribute of a RegularMesh contains id of the mesh. It's a int value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the dimension attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute dimension", "output": "The dimension attribute of a RegularMesh contains the number of mesh cells in each direction.. It's a iterable of int value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the lower_left attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute lower_left", "output": "The lower_left attribute of a RegularMesh contains the lower-left corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a numpy.ndarray value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the upper_right attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute upper_right", "output": "The upper_right attribute of a RegularMesh contains the upper-right corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a numpy.ndarray value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the width attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute width", "output": "The width attribute of a RegularMesh contains the width of mesh cells in each direction.. It's a numpy.ndarray value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the n_elements attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute n_elements", "output": "The n_elements attribute of a RegularMesh contains total number of mesh elements.. It's a int value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the volumes attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute volumes", "output": "The volumes attribute of a RegularMesh contains volume of each mesh element in [cm^3]. It's a numpy.ndarray value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the bounding_box attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute bounding_box", "output": "The bounding_box attribute of a RegularMesh contains axis-aligned bounding box of the mesh. It's a openmc.BoundingBox value that you can access after creating a RegularMesh instance." }, { "instruction": "How do you call the __init__() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the dimension() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dimension() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.dimension() method signature", "output": "To call the dimension() method, use: @dimension.setter def dimension(self: Any, dimension: Any). It takes 2 parameters." }, { "instruction": "How do you call the lower_left() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_parameters() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh._get_parameters() method signature", "output": "To call the _get_parameters() method, use: def _get_parameters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the set_parameters() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.set_parameters() method signature", "output": "To call the set_parameters() method, use: def set_parameters(self: Any, lower_left: Any, upper_right: Any, width: Any). It takes 4 parameters." }, { "instruction": "What is the RectilinearMesh class in OpenMC's Python API?", "input": "OpenMC Python API RectilinearMesh class", "output": "The RectilinearMesh class represents rectilinearmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It provides 7 methods and 0 properties for working with rectilinearmesh data in OpenMC." }, { "instruction": "What does the RectilinearMesh class do in OpenMC's Python API?", "input": "OpenMC Python API RectilinearMesh class description", "output": "The RectilinearMesh class rectilinearmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the index parameter do when creating a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh constructor parameter index", "output": "When creating a RectilinearMesh, the index parameter specifies index in the `meshes` array.. It should be a int value." }, { "instruction": "What is the id attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute id", "output": "The id attribute of a RectilinearMesh contains id of the mesh. It's a int value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the dimension attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute dimension", "output": "The dimension attribute of a RectilinearMesh contains the number of mesh cells in each direction.. It's a iterable of int value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the lower_left attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute lower_left", "output": "The lower_left attribute of a RectilinearMesh contains the lower-left corner of the structured mesh.. It's a numpy.ndarray value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the upper_right attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute upper_right", "output": "The upper_right attribute of a RectilinearMesh contains the upper-right corner of the structured mesh.. It's a numpy.ndarray value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the width attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute width", "output": "The width attribute of a RectilinearMesh contains the width of mesh cells in each direction.. It's a numpy.ndarray value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the n_elements attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute n_elements", "output": "The n_elements attribute of a RectilinearMesh contains total number of mesh elements.. It's a int value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the volumes attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute volumes", "output": "The volumes attribute of a RectilinearMesh contains volume of each mesh element in [cm^3]. It's a numpy.ndarray value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the bounding_box attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute bounding_box", "output": "The bounding_box attribute of a RectilinearMesh contains axis-aligned bounding box of the mesh. It's a openmc.BoundingBox value that you can access after creating a RectilinearMesh instance." }, { "instruction": "How do you call the __init__() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the lower_left() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dimension() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_parameters() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh._get_parameters() method signature", "output": "To call the _get_parameters() method, use: def _get_parameters(self: Any). It takes 1 parameters." }, { "instruction": "What does the set_grid() method do in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.set_grid() method", "output": "The set_grid() method set grid values. It's used for rectilinearmesh operations." }, { "instruction": "How do you call the set_grid() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.set_grid() method signature", "output": "To call the set_grid() method, use: def set_grid(self: Any, x_grid: Any, y_grid: Any, z_grid: Any). It takes 4 parameters." }, { "instruction": "What does the x_grid parameter do in the set_grid() method?", "input": "OpenMC Python API RectilinearMesh.set_grid() parameter x_grid", "output": "The x_grid parameter mesh boundary points along the x-axis. It should be a iterable of float value." }, { "instruction": "What does the y_grid parameter do in the set_grid() method?", "input": "OpenMC Python API RectilinearMesh.set_grid() parameter y_grid", "output": "The y_grid parameter mesh boundary points along the y-axis. It should be a iterable of float value." }, { "instruction": "What does the z_grid parameter do in the set_grid() method?", "input": "OpenMC Python API RectilinearMesh.set_grid() parameter z_grid", "output": "The z_grid parameter mesh boundary points along the z-axis. It should be a iterable of float value." }, { "instruction": "What is the CylindricalMesh class in OpenMC's Python API?", "input": "OpenMC Python API CylindricalMesh class", "output": "The CylindricalMesh class represents cylindricalmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It provides 7 methods and 0 properties for working with cylindricalmesh data in OpenMC." }, { "instruction": "What does the CylindricalMesh class do in OpenMC's Python API?", "input": "OpenMC Python API CylindricalMesh class description", "output": "The CylindricalMesh class cylindricalmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the index parameter do when creating a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh constructor parameter index", "output": "When creating a CylindricalMesh, the index parameter specifies index in the `meshes` array.. It should be a int value." }, { "instruction": "What is the id attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute id", "output": "The id attribute of a CylindricalMesh contains id of the mesh. It's a int value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the dimension attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute dimension", "output": "The dimension attribute of a CylindricalMesh contains the number of mesh cells in each direction.. It's a iterable of int value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the lower_left attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute lower_left", "output": "The lower_left attribute of a CylindricalMesh contains the lower-left corner of the structured mesh.. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the upper_right attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute upper_right", "output": "The upper_right attribute of a CylindricalMesh contains the upper-right corner of the structured mesh.. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the width attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute width", "output": "The width attribute of a CylindricalMesh contains the width of mesh cells in each direction.. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the n_elements attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute n_elements", "output": "The n_elements attribute of a CylindricalMesh contains total number of mesh elements.. It's a int value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the volumes attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute volumes", "output": "The volumes attribute of a CylindricalMesh contains volume of each mesh element in [cm^3]. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the bounding_box attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute bounding_box", "output": "The bounding_box attribute of a CylindricalMesh contains axis-aligned bounding box of the mesh. It's a openmc.BoundingBox value that you can access after creating a CylindricalMesh instance." }, { "instruction": "How do you call the __init__() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the lower_left() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dimension() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_parameters() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh._get_parameters() method signature", "output": "To call the _get_parameters() method, use: def _get_parameters(self: Any). It takes 1 parameters." }, { "instruction": "What does the set_grid() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.set_grid() method", "output": "The set_grid() method set grid values. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the set_grid() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.set_grid() method signature", "output": "To call the set_grid() method, use: def set_grid(self: Any, r_grid: Any, phi_grid: Any, z_grid: Any). It takes 4 parameters." }, { "instruction": "What does the r_grid parameter do in the set_grid() method?", "input": "OpenMC Python API CylindricalMesh.set_grid() parameter r_grid", "output": "The r_grid parameter mesh boundary points along the r-axis. It should be a iterable of float value." }, { "instruction": "What does the phi_grid parameter do in the set_grid() method?", "input": "OpenMC Python API CylindricalMesh.set_grid() parameter phi_grid", "output": "The phi_grid parameter mesh boundary points along the phi-axis. It should be a Iterable of float value." }, { "instruction": "What does the z_grid parameter do in the set_grid() method?", "input": "OpenMC Python API CylindricalMesh.set_grid() parameter z_grid", "output": "The z_grid parameter mesh boundary points along the z-axis. It should be a Iterable of float value." }, { "instruction": "What is the SphericalMesh class in OpenMC's Python API?", "input": "OpenMC Python API SphericalMesh class", "output": "The SphericalMesh class represents sphericalmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It provides 7 methods and 0 properties for working with sphericalmesh data in OpenMC." }, { "instruction": "What does the SphericalMesh class do in OpenMC's Python API?", "input": "OpenMC Python API SphericalMesh class description", "output": "The SphericalMesh class sphericalmesh stored internally. this class exposes a mesh that is stored internally in the openmc library. to obtain a view of a mesh with a given id, use the :data:`openmc.lib.meshes` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the index parameter do when creating a SphericalMesh?", "input": "OpenMC Python API SphericalMesh constructor parameter index", "output": "When creating a SphericalMesh, the index parameter specifies index in the `meshes` array.. It should be a int value." }, { "instruction": "What is the id attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute id", "output": "The id attribute of a SphericalMesh contains id of the mesh. It's a int value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the dimension attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute dimension", "output": "The dimension attribute of a SphericalMesh contains the number of mesh cells in each direction.. It's a iterable of int value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the lower_left attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute lower_left", "output": "The lower_left attribute of a SphericalMesh contains the lower-left corner of the structured mesh.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the upper_right attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute upper_right", "output": "The upper_right attribute of a SphericalMesh contains the upper-right corner of the structured mesh.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the width attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute width", "output": "The width attribute of a SphericalMesh contains the width of mesh cells in each direction.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the n_elements attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute n_elements", "output": "The n_elements attribute of a SphericalMesh contains total number of mesh elements.. It's a int value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the volumes attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute volumes", "output": "The volumes attribute of a SphericalMesh contains volume of each mesh element in [cm^3]. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the bounding_box attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute bounding_box", "output": "The bounding_box attribute of a SphericalMesh contains axis-aligned bounding box of the mesh. It's a openmc.BoundingBox value that you can access after creating a SphericalMesh instance." }, { "instruction": "How do you call the __init__() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the lower_left() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dimension() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_parameters() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh._get_parameters() method signature", "output": "To call the _get_parameters() method, use: def _get_parameters(self: Any). It takes 1 parameters." }, { "instruction": "What does the set_grid() method do in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.set_grid() method", "output": "The set_grid() method set grid values. It's used for sphericalmesh operations." }, { "instruction": "How do you call the set_grid() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.set_grid() method signature", "output": "To call the set_grid() method, use: def set_grid(self: Any, r_grid: Any, theta_grid: Any, phi_grid: Any). It takes 4 parameters." }, { "instruction": "What does the r_grid parameter do in the set_grid() method?", "input": "OpenMC Python API SphericalMesh.set_grid() parameter r_grid", "output": "The r_grid parameter mesh boundary points along the r-axis. It should be a iterable of float value." }, { "instruction": "What does the theta_grid parameter do in the set_grid() method?", "input": "OpenMC Python API SphericalMesh.set_grid() parameter theta_grid", "output": "The theta_grid parameter mesh boundary points along the theta-axis. It should be a Iterable of float value." }, { "instruction": "What does the phi_grid parameter do in the set_grid() method?", "input": "OpenMC Python API SphericalMesh.set_grid() parameter phi_grid", "output": "The phi_grid parameter mesh boundary points along the phi-axis. It should be a Iterable of float value." }, { "instruction": "How do you call the __getitem__() method in the _MeshMapping class?", "input": "OpenMC Python API _MeshMapping.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the _MeshMapping class?", "input": "OpenMC Python API _MeshMapping.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _MeshMapping class?", "input": "OpenMC Python API _MeshMapping.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _MeshMapping class?", "input": "OpenMC Python API _MeshMapping.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_mesh() function in OpenMC's Python API?", "input": "OpenMC Python API _get_mesh() function signature", "output": "To call the _get_mesh() function, use: def _get_mesh(index: Any). It takes 1 parameters." }, { "instruction": "What is the Nuclide class in OpenMC's Python API?", "input": "OpenMC Python API Nuclide class", "output": "The Nuclide class represents nuclide stored internally. this class exposes a nuclide that is stored internally in the openmc solver. to obtain a view of a nuclide with a given name, use the :data:`openmc.lib.nuclides` mapping. It provides 4 methods and 0 properties for working with nuclide data in OpenMC." }, { "instruction": "What does the Nuclide class do in OpenMC's Python API?", "input": "OpenMC Python API Nuclide class description", "output": "The Nuclide class nuclide stored internally. this class exposes a nuclide that is stored internally in the openmc solver. to obtain a view of a nuclide with a given name, use the :data:`openmc.lib.nuclides` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the index parameter do when creating a Nuclide?", "input": "OpenMC Python API Nuclide constructor parameter index", "output": "When creating a Nuclide, the index parameter specifies index in the `nuclides` array.. It should be a int value." }, { "instruction": "What is the name attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute name", "output": "The name attribute of a Nuclide contains name of the nuclide, e.g. 'u235'. It's a str value that you can access after creating a Nuclide instance." }, { "instruction": "How do you call the __new__() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any). It takes 1 parameters." }, { "instruction": "How do you call the __init__() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, index: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What does the collapse_rate() method do in the Nuclide class?", "input": "OpenMC Python API Nuclide.collapse_rate() method", "output": "The collapse_rate() method calculate reaction rate based on group-wise flux distribution. It's used for nuclide operations." }, { "instruction": "How do you call the collapse_rate() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.collapse_rate() method signature", "output": "To call the collapse_rate() method, use: def collapse_rate(self: Any, MT: Any, temperature: Any, energy: Any, flux: Any). It takes 5 parameters." }, { "instruction": "What does the MT parameter do in the collapse_rate() method?", "input": "OpenMC Python API Nuclide.collapse_rate() parameter MT", "output": "The MT parameter endf mt value of the desired reaction. It should be a int value." }, { "instruction": "What does the temperature parameter do in the collapse_rate() method?", "input": "OpenMC Python API Nuclide.collapse_rate() parameter temperature", "output": "The temperature parameter temperature in [k] at which to evaluate cross sections. It should be a float value." }, { "instruction": "What does the energy parameter do in the collapse_rate() method?", "input": "OpenMC Python API Nuclide.collapse_rate() parameter energy", "output": "The energy parameter energy group boundaries in [ev]. It should be a iterable of float value." }, { "instruction": "What does the flux parameter do in the collapse_rate() method?", "input": "OpenMC Python API Nuclide.collapse_rate() parameter flux", "output": "The flux parameter flux in each energy group (not normalized per ev). It should be a iterable of float value." }, { "instruction": "What is the _NuclideMapping class in OpenMC's Python API?", "input": "OpenMC Python API _NuclideMapping class", "output": "The _NuclideMapping class represents provide mapping from nuclide name to index in nuclides array.. It provides 4 methods and 0 properties for working with _nuclidemapping data in OpenMC." }, { "instruction": "What does the _NuclideMapping class do in OpenMC's Python API?", "input": "OpenMC Python API _NuclideMapping class description", "output": "The _NuclideMapping class provide mapping from nuclide name to index in nuclides array.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __getitem__() method in the _NuclideMapping class?", "input": "OpenMC Python API _NuclideMapping.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the _NuclideMapping class?", "input": "OpenMC Python API _NuclideMapping.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _NuclideMapping class?", "input": "OpenMC Python API _NuclideMapping.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _NuclideMapping class?", "input": "OpenMC Python API _NuclideMapping.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the load_nuclide() function do in OpenMC's Python API?", "input": "OpenMC Python API load_nuclide() function", "output": "The load_nuclide() function load cross section data for a nuclide. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the load_nuclide() function in OpenMC's Python API?", "input": "OpenMC Python API load_nuclide() function purpose", "output": "The load_nuclide() function load cross section data for a nuclide. It's part of OpenMC's Python API." }, { "instruction": "How do you call the load_nuclide() function in OpenMC's Python API?", "input": "OpenMC Python API load_nuclide() function signature", "output": "To call the load_nuclide() function, use: def load_nuclide(name: Any). It takes 1 parameters." }, { "instruction": "What does the name parameter do in the load_nuclide() function?", "input": "OpenMC Python API load_nuclide() parameter name", "output": "The name parameter name of the nuclide, e.g. 'u235'. It should be a str value." }, { "instruction": "What is the _Position class in OpenMC's Python API?", "input": "OpenMC Python API _Position class", "output": "The _Position class represents definition of an xyz location in space with underlying c-types\n\n c-type attributes\n -----------------\n x : c_double\n position's x value (default: 0.0)\n y : c_double\n position's y value (default: 0.0)\n z : c_double\n position's z value (default: 0.0). It provides 3 methods and 0 properties for working with _position data in OpenMC." }, { "instruction": "What does the _Position class do in OpenMC's Python API?", "input": "OpenMC Python API _Position class description", "output": "The _Position class definition of an xyz location in space with underlying c-types\n\n c-type attributes\n -----------------\n x : c_double\n position's x value (default: 0.0)\n y : c_double\n position's y value (default: 0.0)\n z : c_double\n position's z value (default: 0.0). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __getitem__() method in the _Position class?", "input": "OpenMC Python API _Position.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, idx: Any). It takes 2 parameters." }, { "instruction": "How do you call the __setitem__() method in the _Position class?", "input": "OpenMC Python API _Position.__setitem__() method signature", "output": "To call the __setitem__() method, use: def __setitem__(self: Any, idx: Any, val: Any). It takes 3 parameters." }, { "instruction": "How do you call the __repr__() method in the _Position class?", "input": "OpenMC Python API _Position.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What is the _PlotBase class in OpenMC's Python API?", "input": "OpenMC Python API _PlotBase class", "output": "The _PlotBase class represents a structure defining a 2-d geometry slice with underlying c-types c-type attributes ----------------- origin : openmc.lib.plot._position a position defining the origin of the plot. width_ : openmc.lib.plot._position the width of the plot along the x, y, and z axes, respectively basis_ : c_int the axes basis of the plot view. pixels_ : c_size_t[3] the resolution of the plot in the horizontal and vertical dimensions level_ : c_int the universe level for the plot view. It provides 20 methods and 0 properties for working with _plotbase data in OpenMC." }, { "instruction": "What does the _PlotBase class do in OpenMC's Python API?", "input": "OpenMC Python API _PlotBase class description", "output": "The _PlotBase class a structure defining a 2-d geometry slice with underlying c-types c-type attributes ----------------- origin : openmc.lib.plot._position a position defining the origin of the plot. width_ : openmc.lib.plot._position the width of the plot along the x, y, and z axes, respectively basis_ : c_int the axes basis of the plot view. pixels_ : c_size_t[3] the resolution of the plot in the horizontal and vertical dimensions level_ : c_int the universe level for the plot view. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the origin attribute of a _PlotBase?", "input": "OpenMC Python API _PlotBase attribute origin", "output": "The origin attribute of a _PlotBase contains origin (center) of the plot. It's a tuple or list of ndarray value that you can access after creating a _PlotBase instance." }, { "instruction": "What is the width attribute of a _PlotBase?", "input": "OpenMC Python API _PlotBase attribute width", "output": "The width attribute of a _PlotBase contains the horizontal dimension of the plot in geometry units (cm). It's a float value that you can access after creating a _PlotBase instance." }, { "instruction": "What is the height attribute of a _PlotBase?", "input": "OpenMC Python API _PlotBase attribute height", "output": "The height attribute of a _PlotBase contains the vertical dimension of the plot in geometry units (cm). It's a float value that you can access after creating a _PlotBase instance." }, { "instruction": "What is the basis attribute of a _PlotBase?", "input": "OpenMC Python API _PlotBase attribute basis", "output": "The basis attribute of a _PlotBase contains one of {'xy', 'xz', 'yz'} indicating the horizontal and vertical axes of the plot.. It's a string value that you can access after creating a _PlotBase instance." }, { "instruction": "What is the h_res attribute of a _PlotBase?", "input": "OpenMC Python API _PlotBase attribute h_res", "output": "The h_res attribute of a _PlotBase contains the horizontal resolution of the plot in pixels. It's a int value that you can access after creating a _PlotBase instance." }, { "instruction": "What is the v_res attribute of a _PlotBase?", "input": "OpenMC Python API _PlotBase attribute v_res", "output": "The v_res attribute of a _PlotBase contains the vertical resolution of the plot in pixels. It's a int value that you can access after creating a _PlotBase instance." }, { "instruction": "What is the level attribute of a _PlotBase?", "input": "OpenMC Python API _PlotBase attribute level", "output": "The level attribute of a _PlotBase contains the universe level for the plot (default: -1 -> all universes shown). It's a int value that you can access after creating a _PlotBase instance." }, { "instruction": "How do you call the __init__() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.origin() method signature", "output": "To call the origin() method, use: @property def origin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.origin() method signature", "output": "To call the origin() method, use: @origin.setter def origin(self: Any, origin: Any). It takes 2 parameters." }, { "instruction": "How do you call the width() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.width() method signature", "output": "To call the width() method, use: @width.setter def width(self: Any, width: Any). It takes 2 parameters." }, { "instruction": "How do you call the height() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.height() method signature", "output": "To call the height() method, use: @property def height(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the height() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.height() method signature", "output": "To call the height() method, use: @height.setter def height(self: Any, height: Any). It takes 2 parameters." }, { "instruction": "How do you call the basis() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.basis() method signature", "output": "To call the basis() method, use: @property def basis(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the basis() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.basis() method signature", "output": "To call the basis() method, use: @basis.setter def basis(self: Any, basis: Any). It takes 2 parameters." }, { "instruction": "How do you call the h_res() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.h_res() method signature", "output": "To call the h_res() method, use: @property def h_res(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the h_res() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.h_res() method signature", "output": "To call the h_res() method, use: @h_res.setter def h_res(self: Any, h_res: Any). It takes 2 parameters." }, { "instruction": "How do you call the v_res() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.v_res() method signature", "output": "To call the v_res() method, use: @property def v_res(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the v_res() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.v_res() method signature", "output": "To call the v_res() method, use: @v_res.setter def v_res(self: Any, v_res: Any). It takes 2 parameters." }, { "instruction": "How do you call the level() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.level() method signature", "output": "To call the level() method, use: @property def level(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the level() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.level() method signature", "output": "To call the level() method, use: @level.setter def level(self: Any, level: Any). It takes 2 parameters." }, { "instruction": "How do you call the color_overlaps() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.color_overlaps() method signature", "output": "To call the color_overlaps() method, use: @property def color_overlaps(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the color_overlaps() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.color_overlaps() method signature", "output": "To call the color_overlaps() method, use: @color_overlaps.setter def color_overlaps(self: Any, color_overlaps: Any). It takes 2 parameters." }, { "instruction": "How do you call the color_overlaps() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.color_overlaps() method signature", "output": "To call the color_overlaps() method, use: @property def color_overlaps(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the color_overlaps() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.color_overlaps() method signature", "output": "To call the color_overlaps() method, use: @color_overlaps.setter def color_overlaps(self: Any, val: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the _PlotBase class?", "input": "OpenMC Python API _PlotBase.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the id_map() function do in OpenMC's Python API?", "input": "OpenMC Python API id_map() function", "output": "The id_map() function generate a 2-d map of cell and material ids. used for in-memory image generation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the id_map() function in OpenMC's Python API?", "input": "OpenMC Python API id_map() function purpose", "output": "The id_map() function generate a 2-d map of cell and material ids. used for in-memory image generation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the id_map() function in OpenMC's Python API?", "input": "OpenMC Python API id_map() function signature", "output": "To call the id_map() function, use: def id_map(plot: Any). It takes 1 parameters." }, { "instruction": "What does the plot parameter do in the id_map() function?", "input": "OpenMC Python API id_map() parameter plot", "output": "The plot parameter object describing the slice of the model to be generated. It should be a openmc.lib.plot._PlotBase value." }, { "instruction": "What does the id_map() function return in OpenMC's Python API?", "input": "OpenMC Python API id_map() return value", "output": "The id_map() function returns a numpy array with shape (vertical pixels, horizontal pixels, 3) of openmc property ids with dtype int32. the last dimension of the array contains, in order, cell ids, cell instances, and material ids.. The return type is numpy.ndarray." }, { "instruction": "What does the property_map() function do in OpenMC's Python API?", "input": "OpenMC Python API property_map() function", "output": "The property_map() function generate a 2-d map of cell temperatures and material densities. used for in-memory image generation. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the property_map() function in OpenMC's Python API?", "input": "OpenMC Python API property_map() function purpose", "output": "The property_map() function generate a 2-d map of cell temperatures and material densities. used for in-memory image generation. It's part of OpenMC's Python API." }, { "instruction": "How do you call the property_map() function in OpenMC's Python API?", "input": "OpenMC Python API property_map() function signature", "output": "To call the property_map() function, use: def property_map(plot: Any). It takes 1 parameters." }, { "instruction": "What does the plot parameter do in the property_map() function?", "input": "OpenMC Python API property_map() parameter plot", "output": "The plot parameter object describing the slice of the model to be generated. It should be a openmc.lib.plot._PlotBase value." }, { "instruction": "What does the property_map() function return in OpenMC's Python API?", "input": "OpenMC Python API property_map() return value", "output": "The property_map() function returns a numpy array with shape (vertical pixels, horizontal pixels, 2) of openmc property ids with dtype float. The return type is numpy.ndarray." }, { "instruction": "How do you call the run_mode() method in the _Settings class?", "input": "OpenMC Python API _Settings.run_mode() method signature", "output": "To call the run_mode() method, use: @property def run_mode(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the run_mode() method in the _Settings class?", "input": "OpenMC Python API _Settings.run_mode() method signature", "output": "To call the run_mode() method, use: @run_mode.setter def run_mode(self: Any, mode: Any). It takes 2 parameters." }, { "instruction": "How do you call the path_statepoint() method in the _Settings class?", "input": "OpenMC Python API _Settings.path_statepoint() method signature", "output": "To call the path_statepoint() method, use: @property def path_statepoint(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the seed() method in the _Settings class?", "input": "OpenMC Python API _Settings.seed() method signature", "output": "To call the seed() method, use: @property def seed(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the seed() method in the _Settings class?", "input": "OpenMC Python API _Settings.seed() method signature", "output": "To call the seed() method, use: @seed.setter def seed(self: Any, seed: Any). It takes 2 parameters." }, { "instruction": "How do you call the stride() method in the _Settings class?", "input": "OpenMC Python API _Settings.stride() method signature", "output": "To call the stride() method, use: @property def stride(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the stride() method in the _Settings class?", "input": "OpenMC Python API _Settings.stride() method signature", "output": "To call the stride() method, use: @stride.setter def stride(self: Any, stride: Any). It takes 2 parameters." }, { "instruction": "What does the set_batches() method do in the _Settings class?", "input": "OpenMC Python API _Settings.set_batches() method", "output": "The set_batches() method set number of batches or maximum number of batches. It's used for _settings operations." }, { "instruction": "How do you call the set_batches() method in the _Settings class?", "input": "OpenMC Python API _Settings.set_batches() method signature", "output": "To call the set_batches() method, use: def set_batches(self: Any, n_batches: Any, set_max_batches: Any, add_sp_batch: Any). It takes 4 parameters." }, { "instruction": "What does the n_batches parameter do in the set_batches() method?", "input": "OpenMC Python API _Settings.set_batches() parameter n_batches", "output": "The n_batches parameter number of batches to simulate. It should be a int value." }, { "instruction": "What does the set_max_batches parameter do in the set_batches() method?", "input": "OpenMC Python API _Settings.set_batches() parameter set_max_batches", "output": "The set_max_batches parameter whether to set maximum number of batches. if true, the value of `n_max_batches` is overridden, otherwise the value of `n_batches` is overridden. only has an effect when triggers are used. It should be a bool value." }, { "instruction": "What does the add_sp_batch parameter do in the set_batches() method?", "input": "OpenMC Python API _Settings.set_batches() parameter add_sp_batch", "output": "The add_sp_batch parameter whether to add `n_batches` as a statepoint batch. It should be a bool value." }, { "instruction": "What does the get_batches() method do in the _Settings class?", "input": "OpenMC Python API _Settings.get_batches() method", "output": "The get_batches() method get number of batches or maximum number of batches. It's used for _settings operations." }, { "instruction": "How do you call the get_batches() method in the _Settings class?", "input": "OpenMC Python API _Settings.get_batches() method signature", "output": "To call the get_batches() method, use: def get_batches(self: Any, get_max_batches: Any). It takes 2 parameters." }, { "instruction": "What does the get_max_batches parameter do in the get_batches() method?", "input": "OpenMC Python API _Settings.get_batches() parameter get_max_batches", "output": "The get_max_batches parameter return `n_max_batches` if true, else return `n_batches`. difference arises only if triggers are used.. It should be a bool value." }, { "instruction": "What is the Tally class in OpenMC's Python API?", "input": "OpenMC Python API Tally class", "output": "The Tally class represents tally stored internally. this class exposes a tally that is stored internally in the openmc library. to obtain a view of a tally with a given id, use the :data:`openmc.lib.tallies` mapping. It provides 26 methods and 0 properties for working with tally data in OpenMC." }, { "instruction": "What does the Tally class do in OpenMC's Python API?", "input": "OpenMC Python API Tally class description", "output": "The Tally class tally stored internally. this class exposes a tally that is stored internally in the openmc library. to obtain a view of a tally with a given id, use the :data:`openmc.lib.tallies` mapping. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the uid parameter do when creating a Tally?", "input": "OpenMC Python API Tally constructor parameter uid", "output": "When creating a Tally, the uid parameter specifies unique id of the tally. It should be a int or None value." }, { "instruction": "What does the new parameter do when creating a Tally?", "input": "OpenMC Python API Tally constructor parameter new", "output": "When creating a Tally, the new parameter specifies when `index` is none, this argument controls whether a new object is created or a view of an existing object is returned.. It should be a bool value." }, { "instruction": "What does the index parameter do when creating a Tally?", "input": "OpenMC Python API Tally constructor parameter index", "output": "When creating a Tally, the index parameter specifies index in the `tallies` array.. It should be a int or None value." }, { "instruction": "What is the id attribute of a Tally?", "input": "OpenMC Python API Tally attribute id", "output": "The id attribute of a Tally contains id of the tally. It's a int value that you can access after creating a Tally instance." }, { "instruction": "What is the estimator attribute of a Tally?", "input": "OpenMC Python API Tally attribute estimator", "output": "The estimator attribute of a Tally contains estimator type of tally (analog, tracklength, collision). It's a str value that you can access after creating a Tally instance." }, { "instruction": "What is the filters attribute of a Tally?", "input": "OpenMC Python API Tally attribute filters", "output": "The filters attribute of a Tally contains list of tally filters. It's a list value that you can access after creating a Tally instance." }, { "instruction": "What is the mean attribute of a Tally?", "input": "OpenMC Python API Tally attribute mean", "output": "The mean attribute of a Tally contains an array containing the sample mean for each bin. It's a numpy.ndarray value that you can access after creating a Tally instance." }, { "instruction": "What is the multiply_density attribute of a Tally?", "input": "OpenMC Python API Tally attribute multiply_density", "output": "The multiply_density attribute of a Tally contains whether reaction rates should be multiplied by atom density .. versionadded:: 0.14.0. It's a bool value that you can access after creating a Tally instance." }, { "instruction": "What is the nuclides attribute of a Tally?", "input": "OpenMC Python API Tally attribute nuclides", "output": "The nuclides attribute of a Tally contains list of nuclides to score results for. It's a list of str value that you can access after creating a Tally instance." }, { "instruction": "What is the num_realizations attribute of a Tally?", "input": "OpenMC Python API Tally attribute num_realizations", "output": "The num_realizations attribute of a Tally contains number of realizations. It's a int value that you can access after creating a Tally instance." }, { "instruction": "What is the results attribute of a Tally?", "input": "OpenMC Python API Tally attribute results", "output": "The results attribute of a Tally contains array of tally results. It's a numpy.ndarray value that you can access after creating a Tally instance." }, { "instruction": "What is the std_dev attribute of a Tally?", "input": "OpenMC Python API Tally attribute std_dev", "output": "The std_dev attribute of a Tally contains an array containing the sample standard deviation for each bin. It's a numpy.ndarray value that you can access after creating a Tally instance." }, { "instruction": "What is the type attribute of a Tally?", "input": "OpenMC Python API Tally attribute type", "output": "The type attribute of a Tally contains type of tally (volume, mesh_surface, surface). It's a str value that you can access after creating a Tally instance." }, { "instruction": "How do you call the __new__() method in the Tally class?", "input": "OpenMC Python API Tally.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, uid: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the active() method in the Tally class?", "input": "OpenMC Python API Tally.active() method signature", "output": "To call the active() method, use: @property def active(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the active() method in the Tally class?", "input": "OpenMC Python API Tally.active() method signature", "output": "To call the active() method, use: @active.setter def active(self: Any, active: Any). It takes 2 parameters." }, { "instruction": "How do you call the type() method in the Tally class?", "input": "OpenMC Python API Tally.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the type() method in the Tally class?", "input": "OpenMC Python API Tally.type() method signature", "output": "To call the type() method, use: @type.setter def type(self: Any, type: Any). It takes 2 parameters." }, { "instruction": "How do you call the estimator() method in the Tally class?", "input": "OpenMC Python API Tally.estimator() method signature", "output": "To call the estimator() method, use: @property def estimator(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the estimator() method in the Tally class?", "input": "OpenMC Python API Tally.estimator() method signature", "output": "To call the estimator() method, use: @estimator.setter def estimator(self: Any, estimator: Any). It takes 2 parameters." }, { "instruction": "How do you call the id() method in the Tally class?", "input": "OpenMC Python API Tally.id() method signature", "output": "To call the id() method, use: @property def id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the id() method in the Tally class?", "input": "OpenMC Python API Tally.id() method signature", "output": "To call the id() method, use: @id.setter def id(self: Any, tally_id: Any). It takes 2 parameters." }, { "instruction": "How do you call the filters() method in the Tally class?", "input": "OpenMC Python API Tally.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the Tally class?", "input": "OpenMC Python API Tally.filters() method signature", "output": "To call the filters() method, use: @filters.setter def filters(self: Any, filters: Any). It takes 2 parameters." }, { "instruction": "What does the find_filter() method do in the Tally class?", "input": "OpenMC Python API Tally.find_filter() method", "output": "The find_filter() method returns the first instance of a filter matching the specified type. It's used for tally operations." }, { "instruction": "How do you call the find_filter() method in the Tally class?", "input": "OpenMC Python API Tally.find_filter() method signature", "output": "To call the find_filter() method, use: def find_filter(self: Any, filter_type: Any). It takes 2 parameters." }, { "instruction": "What does the filter_type parameter do in the find_filter() method?", "input": "OpenMC Python API Tally.find_filter() parameter filter_type", "output": "The filter_type parameter the filter type to match when retrieving a filter instance. It should be a subclass of openmc.lib.Filter value." }, { "instruction": "What does the find_filter() method return in the Tally class?", "input": "OpenMC Python API Tally.find_filter() return value", "output": "The find_filter() method returns the filter instance matching the input filter type. The return type is openmc.lib.Filter." }, { "instruction": "How do you call the mean() method in the Tally class?", "input": "OpenMC Python API Tally.mean() method signature", "output": "To call the mean() method, use: @property def mean(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the Tally class?", "input": "OpenMC Python API Tally.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the Tally class?", "input": "OpenMC Python API Tally.nuclides() method signature", "output": "To call the nuclides() method, use: @nuclides.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_realizations() method in the Tally class?", "input": "OpenMC Python API Tally.num_realizations() method signature", "output": "To call the num_realizations() method, use: @property def num_realizations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the results() method in the Tally class?", "input": "OpenMC Python API Tally.results() method signature", "output": "To call the results() method, use: @property def results(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the Tally class?", "input": "OpenMC Python API Tally.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the Tally class?", "input": "OpenMC Python API Tally.scores() method signature", "output": "To call the scores() method, use: @scores.setter def scores(self: Any, scores: Any). It takes 2 parameters." }, { "instruction": "How do you call the std_dev() method in the Tally class?", "input": "OpenMC Python API Tally.std_dev() method signature", "output": "To call the std_dev() method, use: @property def std_dev(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the writable() method in the Tally class?", "input": "OpenMC Python API Tally.writable() method signature", "output": "To call the writable() method, use: @property def writable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the writable() method in the Tally class?", "input": "OpenMC Python API Tally.writable() method signature", "output": "To call the writable() method, use: @writable.setter def writable(self: Any, writable: Any). It takes 2 parameters." }, { "instruction": "How do you call the multiply_density() method in the Tally class?", "input": "OpenMC Python API Tally.multiply_density() method signature", "output": "To call the multiply_density() method, use: @property def multiply_density(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the multiply_density() method in the Tally class?", "input": "OpenMC Python API Tally.multiply_density() method signature", "output": "To call the multiply_density() method, use: @multiply_density.setter def multiply_density(self: Any, multiply_density: Any). It takes 2 parameters." }, { "instruction": "What does the reset() method do in the Tally class?", "input": "OpenMC Python API Tally.reset() method", "output": "The reset() method reset results and num_realizations of tally. It's used for tally operations." }, { "instruction": "How do you call the reset() method in the Tally class?", "input": "OpenMC Python API Tally.reset() method signature", "output": "To call the reset() method, use: def reset(self: Any). It takes 1 parameters." }, { "instruction": "What does the ci_width() method do in the Tally class?", "input": "OpenMC Python API Tally.ci_width() method", "output": "The ci_width() method confidence interval half-width based on a student t distribution. It's used for tally operations." }, { "instruction": "How do you call the ci_width() method in the Tally class?", "input": "OpenMC Python API Tally.ci_width() method signature", "output": "To call the ci_width() method, use: def ci_width(self: Any, alpha: Any). It takes 2 parameters." }, { "instruction": "What does the alpha parameter do in the ci_width() method?", "input": "OpenMC Python API Tally.ci_width() parameter alpha", "output": "The alpha parameter significance level (one minus the confidence level!). It should be a float value." }, { "instruction": "How do you call the __getitem__() method in the _TallyMapping class?", "input": "OpenMC Python API _TallyMapping.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the _TallyMapping class?", "input": "OpenMC Python API _TallyMapping.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _TallyMapping class?", "input": "OpenMC Python API _TallyMapping.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _TallyMapping class?", "input": "OpenMC Python API _TallyMapping.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the __delitem__() method do in the _TallyMapping class?", "input": "OpenMC Python API _TallyMapping.__delitem__() method", "output": "The __delitem__() method delete a tally from tally vector and remove the id,index pair from tally. It's used for _tallymapping operations." }, { "instruction": "How do you call the __delitem__() method in the _TallyMapping class?", "input": "OpenMC Python API _TallyMapping.__delitem__() method signature", "output": "To call the __delitem__() method, use: def __delitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "What does the global_tallies() function do in OpenMC's Python API?", "input": "OpenMC Python API global_tallies() function", "output": "The global_tallies() function mean and standard deviation of the mean for each global tally. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the global_tallies() function in OpenMC's Python API?", "input": "OpenMC Python API global_tallies() function purpose", "output": "The global_tallies() function mean and standard deviation of the mean for each global tally. It's part of OpenMC's Python API." }, { "instruction": "How do you call the global_tallies() function in OpenMC's Python API?", "input": "OpenMC Python API global_tallies() function signature", "output": "To call the global_tallies() function, use: def global_tallies(). It takes 0 parameters." }, { "instruction": "What is the WeightWindows class in OpenMC's Python API?", "input": "OpenMC Python API WeightWindows class", "output": "The WeightWindows class represents weightwindows stored internally. this class exposes a weight windows object that is stored internally in the openmc library. to obtain a view of a weight windows object with a given id, use the :data:`openmc.lib.weight_windows` mapping. .. versionadded:: 0.14.0. It provides 21 methods and 0 properties for working with weightwindows data in OpenMC." }, { "instruction": "What does the WeightWindows class do in OpenMC's Python API?", "input": "OpenMC Python API WeightWindows class description", "output": "The WeightWindows class weightwindows stored internally. this class exposes a weight windows object that is stored internally in the openmc library. to obtain a view of a weight windows object with a given id, use the :data:`openmc.lib.weight_windows` mapping. .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the id parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter id", "output": "When creating a WeightWindows, the id parameter specifies unique id of the weight windows. It should be a int or None value." }, { "instruction": "What does the new parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter new", "output": "When creating a WeightWindows, the new parameter specifies when `index` is none, this argument controls whether a new object is created or a view of an existing object is returned.. It should be a bool value." }, { "instruction": "What does the index parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter index", "output": "When creating a WeightWindows, the index parameter specifies index in the `weight_windows` array.. It should be a int or None value." }, { "instruction": "What is the id attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute id", "output": "The id attribute of a WeightWindows contains id of the weight windows object. It's a int value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the mesh attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute mesh", "output": "The mesh attribute of a WeightWindows contains mesh used for the weight windows. It's a openmc.lib.Mesh value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the particle attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute particle", "output": "The particle attribute of a WeightWindows contains the particle type to which these weight windows apply. It's a openmc.ParticleType value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the energy_bounds attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute energy_bounds", "output": "The energy_bounds attribute of a WeightWindows contains the energy bounds for the weight windows. It's a numpy.ndarray value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the bounds attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute bounds", "output": "The bounds attribute of a WeightWindows contains the weight window bounds. It's a numpy.ndarray value that you can access after creating a WeightWindows instance." }, { "instruction": "How do you call the __new__() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, id: Any, new: Any, index: Any). It takes 4 parameters." }, { "instruction": "How do you call the id() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.id() method signature", "output": "To call the id() method, use: @property def id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the id() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.id() method signature", "output": "To call the id() method, use: @id.setter def id(self: Any, ww_id: Any). It takes 2 parameters." }, { "instruction": "How do you call the mesh() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, mesh: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.energy_bounds() method signature", "output": "To call the energy_bounds() method, use: @property def energy_bounds(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.energy_bounds() method signature", "output": "To call the energy_bounds() method, use: @energy_bounds.setter def energy_bounds(self: Any, e_bounds: Any). It takes 2 parameters." }, { "instruction": "How do you call the particle() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.particle() method signature", "output": "To call the particle() method, use: @property def particle(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the particle() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.particle() method signature", "output": "To call the particle() method, use: @particle.setter def particle(self: Any, p: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.bounds() method signature", "output": "To call the bounds() method, use: @property def bounds(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.bounds() method signature", "output": "To call the bounds() method, use: @bounds.setter def bounds(self: Any, bounds: Any). It takes 2 parameters." }, { "instruction": "How do you call the survival_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.survival_ratio() method signature", "output": "To call the survival_ratio() method, use: @property def survival_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the survival_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.survival_ratio() method signature", "output": "To call the survival_ratio() method, use: @survival_ratio.setter def survival_ratio(self: Any, ratio: Any). It takes 2 parameters." }, { "instruction": "How do you call the max_lower_bound_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_lower_bound_ratio() method signature", "output": "To call the max_lower_bound_ratio() method, use: @property def max_lower_bound_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_lower_bound_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_lower_bound_ratio() method signature", "output": "To call the max_lower_bound_ratio() method, use: @max_lower_bound_ratio.setter def max_lower_bound_ratio(self: Any, lb_ratio: Any). It takes 2 parameters." }, { "instruction": "How do you call the weight_cutoff() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.weight_cutoff() method signature", "output": "To call the weight_cutoff() method, use: @property def weight_cutoff(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the weight_cutoff() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.weight_cutoff() method signature", "output": "To call the weight_cutoff() method, use: @weight_cutoff.setter def weight_cutoff(self: Any, cutoff: Any). It takes 2 parameters." }, { "instruction": "How do you call the max_split() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_split() method signature", "output": "To call the max_split() method, use: @property def max_split(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_split() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_split() method signature", "output": "To call the max_split() method, use: @max_split.setter def max_split(self: Any, max_split: Any). It takes 2 parameters." }, { "instruction": "What does the update_magic() method do in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.update_magic() method", "output": "The update_magic() method update weight window values using the magic method reference: https://inis.iaea.org/records/231pm-zzy35. It's used for weightwindows operations." }, { "instruction": "How do you call the update_magic() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.update_magic() method signature", "output": "To call the update_magic() method, use: def update_magic(self: Any, tally: Any, value: Any, threshold: Any, ratio: Any). It takes 5 parameters." }, { "instruction": "What does the tally parameter do in the update_magic() method?", "input": "OpenMC Python API WeightWindows.update_magic() parameter tally", "output": "The tally parameter the tally used to update weight window information. It should be a openmc.lib.Tally object value." }, { "instruction": "What does the value parameter do in the update_magic() method?", "input": "OpenMC Python API WeightWindows.update_magic() parameter value", "output": "The value parameter value type used to generate weight windows. one of {'mean', 'rel_err'}.. It should be a str value." }, { "instruction": "What does the threshold parameter do in the update_magic() method?", "input": "OpenMC Python API WeightWindows.update_magic() parameter threshold", "output": "The threshold parameter threshold for relative error of results used to generate weight window bounds. It should be a float value." }, { "instruction": "What does the ratio parameter do in the update_magic() method?", "input": "OpenMC Python API WeightWindows.update_magic() parameter ratio", "output": "The ratio parameter ratio of the lower to upper weight window bounds. It should be a float value." }, { "instruction": "What does the from_tally() method do in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.from_tally() method", "output": "The from_tally() method create an instance of the weightwindows class based on the specified tally. It's used for weightwindows operations." }, { "instruction": "How do you call the from_tally() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.from_tally() method signature", "output": "To call the from_tally() method, use: @classmethod def from_tally(cls: Any, tally: Any, particle: Any). It takes 3 parameters." }, { "instruction": "What does the tally parameter do in the from_tally() method?", "input": "OpenMC Python API WeightWindows.from_tally() parameter tally", "output": "The tally parameter the tally used to create the weightwindows instance.. It should be a openmc.lib.Tally value." }, { "instruction": "What does the particle parameter do in the from_tally() method?", "input": "OpenMC Python API WeightWindows.from_tally() parameter particle", "output": "The particle parameter the particle type to use for the weightwindows instance. should be specified as an instance of particletype or as a string with a value of 'neutron' or 'photon'.. It should be a openmc.ParticleType or str, optional value." }, { "instruction": "How do you call the __getitem__() method in the _WeightWindowsMapping class?", "input": "OpenMC Python API _WeightWindowsMapping.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iter__() method in the _WeightWindowsMapping class?", "input": "OpenMC Python API _WeightWindowsMapping.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the _WeightWindowsMapping class?", "input": "OpenMC Python API _WeightWindowsMapping.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the _WeightWindowsMapping class?", "input": "OpenMC Python API _WeightWindowsMapping.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __delitem__() method in the _WeightWindowsMapping class?", "input": "OpenMC Python API _WeightWindowsMapping.__delitem__() method signature", "output": "To call the __delitem__() method, use: def __delitem__(self: Any). It takes 1 parameters." }, { "instruction": "What is the Macroscopic class in OpenMC's Python API?", "input": "OpenMC Python API Macroscopic class", "output": "The Macroscopic class represents a macroscopic object that can be used in a material. It provides 2 methods and 0 properties for working with macroscopic data in OpenMC." }, { "instruction": "What does the Macroscopic class do in OpenMC's Python API?", "input": "OpenMC Python API Macroscopic class description", "output": "The Macroscopic class a macroscopic object that can be used in a material. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a Macroscopic?", "input": "OpenMC Python API Macroscopic constructor parameter name", "output": "When creating a Macroscopic, the name parameter specifies name of the macroscopic data, e.g. uo2. It should be a str value." }, { "instruction": "What is the name attribute of a Macroscopic?", "input": "OpenMC Python API Macroscopic attribute name", "output": "The name attribute of a Macroscopic contains name of the nuclide, e.g. uo2. It's a str value that you can access after creating a Macroscopic instance." }, { "instruction": "How do you call the __new__() method in the Macroscopic class?", "input": "OpenMC Python API Macroscopic.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the Macroscopic class?", "input": "OpenMC Python API Macroscopic.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What is the Material class in OpenMC's Python API?", "input": "OpenMC Python API Material class", "output": "The Material class represents a material composed of a collection of nuclides/elements. to create a material, one should create an instance of this class, add nuclides or elements with :meth:`material.add_nuclide` or :meth:`material.add_element`, respectively, and set the total material density with :meth:`material.set_density()`. alternatively, you can use :meth:`material.add_components()` to pass a dictionary containing all the component information. the material can then be assigned to a cell using the :attr:`cell.fill` attribute. It provides 55 methods and 0 properties for working with material data in OpenMC." }, { "instruction": "What does the Material class do in OpenMC's Python API?", "input": "OpenMC Python API Material class description", "output": "The Material class a material composed of a collection of nuclides/elements. to create a material, one should create an instance of this class, add nuclides or elements with :meth:`material.add_nuclide` or :meth:`material.add_element`, respectively, and set the total material density with :meth:`material.set_density()`. alternatively, you can use :meth:`material.add_components()` to pass a dictionary containing all the component information. the material can then be assigned to a cell using the :attr:`cell.fill` attribute. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the material_id parameter do when creating a Material?", "input": "OpenMC Python API Material constructor parameter material_id", "output": "When creating a Material, the material_id parameter specifies unique identifier for the material. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a Material?", "input": "OpenMC Python API Material constructor parameter name", "output": "When creating a Material, the name parameter specifies name of the material. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the temperature parameter do when creating a Material?", "input": "OpenMC Python API Material constructor parameter temperature", "output": "When creating a Material, the temperature parameter specifies temperature of the material in kelvin. if not specified, the material inherits the default temperature applied to the model.. It should be a float, optional value." }, { "instruction": "What is the id attribute of a Material?", "input": "OpenMC Python API Material attribute id", "output": "The id attribute of a Material contains unique identifier for the material. It's a int value that you can access after creating a Material instance." }, { "instruction": "What is the temperature attribute of a Material?", "input": "OpenMC Python API Material attribute temperature", "output": "The temperature attribute of a Material contains temperature of the material in kelvin.. It's a float value that you can access after creating a Material instance." }, { "instruction": "What is the density attribute of a Material?", "input": "OpenMC Python API Material attribute density", "output": "The density attribute of a Material contains density of the material (units defined separately). It's a float value that you can access after creating a Material instance." }, { "instruction": "What is the density_units attribute of a Material?", "input": "OpenMC Python API Material attribute density_units", "output": "The density_units attribute of a Material contains units used for `density`. can be one of 'g/cm3', 'g/cc', 'kg/m3', 'atom/b-cm', 'atom/cm3', 'sum', or 'macro'. the 'macro' unit only applies in the case of a multi-group calculation.. It's a str value that you can access after creating a Material instance." }, { "instruction": "What is the depletable attribute of a Material?", "input": "OpenMC Python API Material attribute depletable", "output": "The depletable attribute of a Material contains indicate whether the material is depletable.. It's a bool value that you can access after creating a Material instance." }, { "instruction": "What is the nuclides attribute of a Material?", "input": "OpenMC Python API Material attribute nuclides", "output": "The nuclides attribute of a Material contains list in which each item is a namedtuple consisting of a nuclide string, the percent density, and the percent type ('ao' or 'wo'). the namedtuple has field names ``name``, ``percent``, and ``percent_type``.. It's a list of namedtuple value that you can access after creating a Material instance." }, { "instruction": "What is the isotropic attribute of a Material?", "input": "OpenMC Python API Material attribute isotropic", "output": "The isotropic attribute of a Material contains nuclides for which elastic scattering should be treated as though it were isotropic in the laboratory system.. It's a list of str value that you can access after creating a Material instance." }, { "instruction": "What is the average_molar_mass attribute of a Material?", "input": "OpenMC Python API Material attribute average_molar_mass", "output": "The average_molar_mass attribute of a Material contains the average molar mass of nuclides in the material in units of grams per mol. for example, uo2 with 3 nuclides will have an average molar mass of 270 / 3 = 90 g / mol.. It's a float value that you can access after creating a Material instance." }, { "instruction": "What is the volume attribute of a Material?", "input": "OpenMC Python API Material attribute volume", "output": "The volume attribute of a Material contains volume of the material in cm^3. this can either be set manually or calculated in a stochastic volume calculation and added via the :meth:`material.add_volume_information` method.. It's a float value that you can access after creating a Material instance." }, { "instruction": "What is the paths attribute of a Material?", "input": "OpenMC Python API Material attribute paths", "output": "The paths attribute of a Material contains the paths traversed through the csg tree to reach each material instance. this property is initialized by calling the :meth:`geometry.determine_paths` method.. It's a list of str value that you can access after creating a Material instance." }, { "instruction": "What is the num_instances attribute of a Material?", "input": "OpenMC Python API Material attribute num_instances", "output": "The num_instances attribute of a Material contains the number of instances of this material throughout the geometry. this property is initialized by calling the :meth:`geometry.determine_paths` method.. It's a int value that you can access after creating a Material instance." }, { "instruction": "What is the fissionable_mass attribute of a Material?", "input": "OpenMC Python API Material attribute fissionable_mass", "output": "The fissionable_mass attribute of a Material contains mass of fissionable nuclides in the material in [g]. requires that the :attr:`volume` attribute is set.. It's a float value that you can access after creating a Material instance." }, { "instruction": "What is the ncrystal_cfg attribute of a Material?", "input": "OpenMC Python API Material attribute ncrystal_cfg", "output": "The ncrystal_cfg attribute of a Material contains ncrystal configuration string .. versionadded:: 0.13.3. It's a str value that you can access after creating a Material instance." }, { "instruction": "How do you call the __init__() method in the Material class?", "input": "OpenMC Python API Material.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, material_id: Any, name: Any, temperature: Any). It takes 4 parameters." }, { "instruction": "How do you call the __repr__() method in the Material class?", "input": "OpenMC Python API Material.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Material class?", "input": "OpenMC Python API Material.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Material class?", "input": "OpenMC Python API Material.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the temperature() method in the Material class?", "input": "OpenMC Python API Material.temperature() method signature", "output": "To call the temperature() method, use: @property def temperature(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the temperature() method in the Material class?", "input": "OpenMC Python API Material.temperature() method signature", "output": "To call the temperature() method, use: @temperature.setter def temperature(self: Any, temperature: Any). It takes 2 parameters." }, { "instruction": "How do you call the density() method in the Material class?", "input": "OpenMC Python API Material.density() method signature", "output": "To call the density() method, use: @property def density(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the density_units() method in the Material class?", "input": "OpenMC Python API Material.density_units() method signature", "output": "To call the density_units() method, use: @property def density_units(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the depletable() method in the Material class?", "input": "OpenMC Python API Material.depletable() method signature", "output": "To call the depletable() method, use: @property def depletable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the depletable() method in the Material class?", "input": "OpenMC Python API Material.depletable() method signature", "output": "To call the depletable() method, use: @depletable.setter def depletable(self: Any, depletable: bool). It takes 2 parameters." }, { "instruction": "How do you call the paths() method in the Material class?", "input": "OpenMC Python API Material.paths() method signature", "output": "To call the paths() method, use: @property def paths(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_instances() method in the Material class?", "input": "OpenMC Python API Material.num_instances() method signature", "output": "To call the num_instances() method, use: @property def num_instances(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the Material class?", "input": "OpenMC Python API Material.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the isotropic() method in the Material class?", "input": "OpenMC Python API Material.isotropic() method signature", "output": "To call the isotropic() method, use: @property def isotropic(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the isotropic() method in the Material class?", "input": "OpenMC Python API Material.isotropic() method signature", "output": "To call the isotropic() method, use: @isotropic.setter def isotropic(self: Any, isotropic: Any). It takes 2 parameters." }, { "instruction": "How do you call the average_molar_mass() method in the Material class?", "input": "OpenMC Python API Material.average_molar_mass() method signature", "output": "To call the average_molar_mass() method, use: @property def average_molar_mass(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the Material class?", "input": "OpenMC Python API Material.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the Material class?", "input": "OpenMC Python API Material.volume() method signature", "output": "To call the volume() method, use: @volume.setter def volume(self: Any, volume: Real). It takes 2 parameters." }, { "instruction": "How do you call the ncrystal_cfg() method in the Material class?", "input": "OpenMC Python API Material.ncrystal_cfg() method signature", "output": "To call the ncrystal_cfg() method, use: @property def ncrystal_cfg(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fissionable_mass() method in the Material class?", "input": "OpenMC Python API Material.fissionable_mass() method signature", "output": "To call the fissionable_mass() method, use: @property def fissionable_mass(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the decay_photon_energy() method in the Material class?", "input": "OpenMC Python API Material.decay_photon_energy() method signature", "output": "To call the decay_photon_energy() method, use: @property def decay_photon_energy(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_decay_photon_energy() method do in the Material class?", "input": "OpenMC Python API Material.get_decay_photon_energy() method", "output": "The get_decay_photon_energy() method return energy distribution of decay photons from unstable nuclides. .. versionadded:: 0.14.0. It's used for material operations." }, { "instruction": "How do you call the get_decay_photon_energy() method in the Material class?", "input": "OpenMC Python API Material.get_decay_photon_energy() method signature", "output": "To call the get_decay_photon_energy() method, use: def get_decay_photon_energy(self: Any, clip_tolerance: float, units: str, volume: Any). It takes 4 parameters." }, { "instruction": "What does the clip_tolerance parameter do in the get_decay_photon_energy() method?", "input": "OpenMC Python API Material.get_decay_photon_energy() parameter clip_tolerance", "output": "The clip_tolerance parameter maximum fraction of :math:`\\sum_i x_i p_i` for discrete distributions that will be discarded.. It should be a float value." }, { "instruction": "What does the units parameter do in the get_decay_photon_energy() method?", "input": "OpenMC Python API Material.get_decay_photon_energy() parameter units", "output": "The units parameter specifies the units on the integral of the distribution.. It should be a {'Bq', 'Bq/g', 'Bq/kg', 'Bq/cm3'} value." }, { "instruction": "What does the volume parameter do in the get_decay_photon_energy() method?", "input": "OpenMC Python API Material.get_decay_photon_energy() parameter volume", "output": "The volume parameter volume of the material. if not passed, defaults to using the :attr:`material.volume` attribute.. It should be a float, optional value." }, { "instruction": "What does the from_hdf5() method do in the Material class?", "input": "OpenMC Python API Material.from_hdf5() method", "output": "The from_hdf5() method create material from hdf5 group. It's used for material operations." }, { "instruction": "How do you call the from_hdf5() method in the Material class?", "input": "OpenMC Python API Material.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Material.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the from_ncrystal() method do in the Material class?", "input": "OpenMC Python API Material.from_ncrystal() method", "output": "The from_ncrystal() method create material from ncrystal configuration string. density, temperature, and material composition, and (ultimately) thermal neutron scattering will be automatically be provided by ncrystal based on this string. the name and material_id parameters are simply passed on to the material constructor. .. versionadded:: 0.13.3. It's used for material operations." }, { "instruction": "How do you call the from_ncrystal() method in the Material class?", "input": "OpenMC Python API Material.from_ncrystal() method signature", "output": "To call the from_ncrystal() method, use: @classmethod def from_ncrystal(cls: Any, cfg: Any). It takes 2 parameters." }, { "instruction": "What does the cfg parameter do in the from_ncrystal() method?", "input": "OpenMC Python API Material.from_ncrystal() parameter cfg", "output": "The cfg parameter ncrystal configuration string **kwargs keyword arguments passed to :class:`openmc.material`. It should be a str value." }, { "instruction": "What does the add_volume_information() method do in the Material class?", "input": "OpenMC Python API Material.add_volume_information() method", "output": "The add_volume_information() method add volume information to a material. It's used for material operations." }, { "instruction": "How do you call the add_volume_information() method in the Material class?", "input": "OpenMC Python API Material.add_volume_information() method signature", "output": "To call the add_volume_information() method, use: def add_volume_information(self: Any, volume_calc: Any). It takes 2 parameters." }, { "instruction": "What does the volume_calc parameter do in the add_volume_information() method?", "input": "OpenMC Python API Material.add_volume_information() parameter volume_calc", "output": "The volume_calc parameter results from a stochastic volume calculation. It should be a openmc.VolumeCalculation value." }, { "instruction": "What does the set_density() method do in the Material class?", "input": "OpenMC Python API Material.set_density() method", "output": "The set_density() method set the density of the material. It's used for material operations." }, { "instruction": "How do you call the set_density() method in the Material class?", "input": "OpenMC Python API Material.set_density() method signature", "output": "To call the set_density() method, use: def set_density(self: Any, units: str, density: Any). It takes 3 parameters." }, { "instruction": "What does the units parameter do in the set_density() method?", "input": "OpenMC Python API Material.set_density() parameter units", "output": "The units parameter physical units of density.. It should be a {'g/cm3', 'g/cc', 'kg/m3', 'atom/b-cm', 'atom/cm3', 'sum', 'macro'} value." }, { "instruction": "What does the density parameter do in the set_density() method?", "input": "OpenMC Python API Material.set_density() parameter density", "output": "The density parameter value of the density. must be specified unless units is given as 'sum'.. It should be a float, optional value." }, { "instruction": "What does the add_nuclide() method do in the Material class?", "input": "OpenMC Python API Material.add_nuclide() method", "output": "The add_nuclide() method add a nuclide to the material. It's used for material operations." }, { "instruction": "How do you call the add_nuclide() method in the Material class?", "input": "OpenMC Python API Material.add_nuclide() method signature", "output": "To call the add_nuclide() method, use: def add_nuclide(self: Any, nuclide: str, percent: float, percent_type: str). It takes 4 parameters." }, { "instruction": "What does the nuclide parameter do in the add_nuclide() method?", "input": "OpenMC Python API Material.add_nuclide() parameter nuclide", "output": "The nuclide parameter nuclide to add, e.g., 'mo95'. It should be a str value." }, { "instruction": "What does the percent parameter do in the add_nuclide() method?", "input": "OpenMC Python API Material.add_nuclide() parameter percent", "output": "The percent parameter atom or weight percent. It should be a float value." }, { "instruction": "What does the percent_type parameter do in the add_nuclide() method?", "input": "OpenMC Python API Material.add_nuclide() parameter percent_type", "output": "The percent_type parameter 'ao' for atom percent and 'wo' for weight percent. It should be a {'ao', 'wo'} value." }, { "instruction": "What does the add_components() method do in the Material class?", "input": "OpenMC Python API Material.add_components() method", "output": "The add_components() method add multiple elements or nuclides to a material .. versionadded:: 0.13.1. It's used for material operations." }, { "instruction": "How do you call the add_components() method in the Material class?", "input": "OpenMC Python API Material.add_components() method signature", "output": "To call the add_components() method, use: def add_components(self: Any, components: dict, percent_type: str). It takes 3 parameters." }, { "instruction": "What does the components parameter do in the add_components() method?", "input": "OpenMC Python API Material.add_components() parameter components", "output": "The components parameter dictionary mapping element or nuclide names to their atom or weight percent. to specify enrichment of an element, the entry of ``components`` for that element must instead be a dictionary containing the keyword arguments as well as a value for ``'percent'``. It should be a dict of str to float or dict value." }, { "instruction": "What does the percent_type parameter do in the add_components() method?", "input": "OpenMC Python API Material.add_components() parameter percent_type", "output": "The percent_type parameter 'ao' for atom percent and 'wo' for weight percent. It should be a {'ao', 'wo'} value." }, { "instruction": "What does the remove_nuclide() method do in the Material class?", "input": "OpenMC Python API Material.remove_nuclide() method", "output": "The remove_nuclide() method remove a nuclide from the material. It's used for material operations." }, { "instruction": "How do you call the remove_nuclide() method in the Material class?", "input": "OpenMC Python API Material.remove_nuclide() method signature", "output": "To call the remove_nuclide() method, use: def remove_nuclide(self: Any, nuclide: str). It takes 2 parameters." }, { "instruction": "What does the nuclide parameter do in the remove_nuclide() method?", "input": "OpenMC Python API Material.remove_nuclide() parameter nuclide", "output": "The nuclide parameter nuclide to remove. It should be a str value." }, { "instruction": "What does the remove_element() method do in the Material class?", "input": "OpenMC Python API Material.remove_element() method", "output": "The remove_element() method remove an element from the material .. versionadded:: 0.13.1. It's used for material operations." }, { "instruction": "How do you call the remove_element() method in the Material class?", "input": "OpenMC Python API Material.remove_element() method signature", "output": "To call the remove_element() method, use: def remove_element(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the element parameter do in the remove_element() method?", "input": "OpenMC Python API Material.remove_element() parameter element", "output": "The element parameter element to remove. It should be a str value." }, { "instruction": "What does the add_macroscopic() method do in the Material class?", "input": "OpenMC Python API Material.add_macroscopic() method", "output": "The add_macroscopic() method add a macroscopic to the material. this will also set the density of the material to 1.0, unless it has been otherwise set, as a default for macroscopic cross sections. It's used for material operations." }, { "instruction": "How do you call the add_macroscopic() method in the Material class?", "input": "OpenMC Python API Material.add_macroscopic() method signature", "output": "To call the add_macroscopic() method, use: def add_macroscopic(self: Any, macroscopic: str). It takes 2 parameters." }, { "instruction": "What does the macroscopic parameter do in the add_macroscopic() method?", "input": "OpenMC Python API Material.add_macroscopic() parameter macroscopic", "output": "The macroscopic parameter macroscopic to add. It should be a str value." }, { "instruction": "What does the remove_macroscopic() method do in the Material class?", "input": "OpenMC Python API Material.remove_macroscopic() method", "output": "The remove_macroscopic() method remove a macroscopic from the material. It's used for material operations." }, { "instruction": "How do you call the remove_macroscopic() method in the Material class?", "input": "OpenMC Python API Material.remove_macroscopic() method signature", "output": "To call the remove_macroscopic() method, use: def remove_macroscopic(self: Any, macroscopic: str). It takes 2 parameters." }, { "instruction": "What does the macroscopic parameter do in the remove_macroscopic() method?", "input": "OpenMC Python API Material.remove_macroscopic() parameter macroscopic", "output": "The macroscopic parameter macroscopic to remove. It should be a str value." }, { "instruction": "What does the add_element() method do in the Material class?", "input": "OpenMC Python API Material.add_element() method", "output": "The add_element() method add a natural element to the material. It's used for material operations." }, { "instruction": "How do you call the add_element() method in the Material class?", "input": "OpenMC Python API Material.add_element() method signature", "output": "To call the add_element() method, use: def add_element(self: Any, element: str, percent: float, percent_type: str, enrichment: Any, enrichment_target: Any, enrichment_type: Any, cross_sections: Any). It takes 8 parameters." }, { "instruction": "What does the element parameter do in the add_element() method?", "input": "OpenMC Python API Material.add_element() parameter element", "output": "The element parameter element to add, e.g., 'zr' or 'zirconium'. It should be a str value." }, { "instruction": "What does the percent parameter do in the add_element() method?", "input": "OpenMC Python API Material.add_element() parameter percent", "output": "The percent parameter atom or weight percent. It should be a float value." }, { "instruction": "What does the percent_type parameter do in the add_element() method?", "input": "OpenMC Python API Material.add_element() parameter percent_type", "output": "The percent_type parameter 'ao' for atom percent and 'wo' for weight percent. defaults to atom percent.. It should be a {'ao', 'wo'}, optional value." }, { "instruction": "What does the enrichment parameter do in the add_element() method?", "input": "OpenMC Python API Material.add_element() parameter enrichment", "output": "The enrichment parameter enrichment of an enrichment_target nuclide in percent (ao or wo). if enrichment_target is not supplied then it is enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none (natural composition).. It should be a float, optional value." }, { "instruction": "What does the enrichment_target parameter do in the add_element() method?", "input": "OpenMC Python API Material.add_element() parameter enrichment_target", "output": "The enrichment_target parameter single nuclide name to enrich from a natural composition (e.g., 'o16') .. versionadded:: 0.12. It should be a str, optional value." }, { "instruction": "What does the enrichment_type parameter do in the add_element() method?", "input": "OpenMC Python API Material.add_element() parameter enrichment_type", "output": "The enrichment_type parameter 'ao' for enrichment as atom percent and 'wo' for weight percent. default is: 'ao' for two-isotope enrichment; 'wo' for u enrichment .. versionadded:: 0.12. It should be a {'ao', 'wo'}, optional value." }, { "instruction": "What does the cross_sections parameter do in the add_element() method?", "input": "OpenMC Python API Material.add_element() parameter cross_sections", "output": "The cross_sections parameter location of cross_sections.xml file.. It should be a str, optional value." }, { "instruction": "What does the add_elements_from_formula() method do in the Material class?", "input": "OpenMC Python API Material.add_elements_from_formula() method", "output": "The add_elements_from_formula() method add a elements from a chemical formula to the material. .. versionadded:: 0.12. It's used for material operations." }, { "instruction": "How do you call the add_elements_from_formula() method in the Material class?", "input": "OpenMC Python API Material.add_elements_from_formula() method signature", "output": "To call the add_elements_from_formula() method, use: def add_elements_from_formula(self: Any, formula: str, percent_type: str, enrichment: Any, enrichment_target: Any, enrichment_type: Any). It takes 6 parameters." }, { "instruction": "What does the formula parameter do in the add_elements_from_formula() method?", "input": "OpenMC Python API Material.add_elements_from_formula() parameter formula", "output": "The formula parameter formula to add, e.g., 'c2o', 'c6h12o6', or (nh4)2so4. note this is case sensitive, elements must start with an uppercase character. multiplier numbers must be integers.. It should be a str value." }, { "instruction": "What does the percent_type parameter do in the add_elements_from_formula() method?", "input": "OpenMC Python API Material.add_elements_from_formula() parameter percent_type", "output": "The percent_type parameter 'ao' for atom percent and 'wo' for weight percent. defaults to atom percent.. It should be a {'ao', 'wo'}, optional value." }, { "instruction": "What does the enrichment parameter do in the add_elements_from_formula() method?", "input": "OpenMC Python API Material.add_elements_from_formula() parameter enrichment", "output": "The enrichment parameter enrichment of an enrichment_target nuclide in percent (ao or wo). if enrichment_target is not supplied then it is enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none (natural composition).. It should be a float, optional value." }, { "instruction": "What does the enrichment_target parameter do in the add_elements_from_formula() method?", "input": "OpenMC Python API Material.add_elements_from_formula() parameter enrichment_target", "output": "The enrichment_target parameter single nuclide name to enrich from a natural composition (e.g., 'o16'). It should be a str, optional value." }, { "instruction": "What does the enrichment_type parameter do in the add_elements_from_formula() method?", "input": "OpenMC Python API Material.add_elements_from_formula() parameter enrichment_type", "output": "The enrichment_type parameter 'ao' for enrichment as atom percent and 'wo' for weight percent. default is: 'ao' for two-isotope enrichment; 'wo' for u enrichment. It should be a {'ao', 'wo'}, optional value." }, { "instruction": "What does the add_s_alpha_beta() method do in the Material class?", "input": "OpenMC Python API Material.add_s_alpha_beta() method", "output": "The add_s_alpha_beta() method add an :math:`s(\\alpha,\\beta)` table to the material. It's used for material operations." }, { "instruction": "How do you call the add_s_alpha_beta() method in the Material class?", "input": "OpenMC Python API Material.add_s_alpha_beta() method signature", "output": "To call the add_s_alpha_beta() method, use: def add_s_alpha_beta(self: Any, name: str, fraction: float). It takes 3 parameters." }, { "instruction": "What does the name parameter do in the add_s_alpha_beta() method?", "input": "OpenMC Python API Material.add_s_alpha_beta() parameter name", "output": "The name parameter name of the :math:`s(\\alpha,\\beta)` table. It should be a str value." }, { "instruction": "What does the fraction parameter do in the add_s_alpha_beta() method?", "input": "OpenMC Python API Material.add_s_alpha_beta() parameter fraction", "output": "The fraction parameter the fraction of relevant nuclei that are affected by the :math:`s(\\alpha,\\beta)` table. for example, if the material is a block of carbon that is 60% graphite and 40% amorphous then add a. It should be a float value." }, { "instruction": "What does the graphite parameter do in the add_s_alpha_beta() method?", "input": "OpenMC Python API Material.add_s_alpha_beta() parameter graphite", "output": "The graphite parameter . It should be a math:`S(\\alpha,\\beta)` table with fraction=0.6. value." }, { "instruction": "How do you call the make_isotropic_in_lab() method in the Material class?", "input": "OpenMC Python API Material.make_isotropic_in_lab() method signature", "output": "To call the make_isotropic_in_lab() method, use: def make_isotropic_in_lab(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_elements() method do in the Material class?", "input": "OpenMC Python API Material.get_elements() method", "output": "The get_elements() method returns all elements in the material .. versionadded:: 0.12. It's used for material operations." }, { "instruction": "How do you call the get_elements() method in the Material class?", "input": "OpenMC Python API Material.get_elements() method signature", "output": "To call the get_elements() method, use: def get_elements(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_elements() method return in the Material class?", "input": "OpenMC Python API Material.get_elements() return value", "output": "The get_elements() method returns list of element names. The return type is list of str." }, { "instruction": "What does the get_nuclides() method do in the Material class?", "input": "OpenMC Python API Material.get_nuclides() method", "output": "The get_nuclides() method returns a list of all nuclides in the material, if the element argument is specified then just nuclides of that element are returned. It's used for material operations." }, { "instruction": "How do you call the get_nuclides() method in the Material class?", "input": "OpenMC Python API Material.get_nuclides() method signature", "output": "To call the get_nuclides() method, use: def get_nuclides(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the element parameter do in the get_nuclides() method?", "input": "OpenMC Python API Material.get_nuclides() parameter element", "output": "The element parameter specifies the element to match when searching through the nuclides .. versionadded:: 0.13.2. It should be a str value." }, { "instruction": "What does the get_nuclides() method return in the Material class?", "input": "OpenMC Python API Material.get_nuclides() return value", "output": "The get_nuclides() method returns list of nuclide names. The return type is list of str." }, { "instruction": "What does the get_nuclide_densities() method do in the Material class?", "input": "OpenMC Python API Material.get_nuclide_densities() method", "output": "The get_nuclide_densities() method returns all nuclides in the material and their densities. It's used for material operations." }, { "instruction": "How do you call the get_nuclide_densities() method in the Material class?", "input": "OpenMC Python API Material.get_nuclide_densities() method signature", "output": "To call the get_nuclide_densities() method, use: def get_nuclide_densities(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclide_densities() method return in the Material class?", "input": "OpenMC Python API Material.get_nuclide_densities() return value", "output": "The get_nuclide_densities() method returns dictionary whose keys are nuclide names and values are 3-tuples of (nuclide, density percent, density percent type). The return type is dict." }, { "instruction": "What does the get_nuclide_atom_densities() method do in the Material class?", "input": "OpenMC Python API Material.get_nuclide_atom_densities() method", "output": "The get_nuclide_atom_densities() method returns one or all nuclides in the material and their atomic densities in units of atom/b-cm .. versionchanged:: 0.13.1 the values in the dictionary were changed from a tuple containing the nuclide name and the density to just the density. It's used for material operations." }, { "instruction": "How do you call the get_nuclide_atom_densities() method in the Material class?", "input": "OpenMC Python API Material.get_nuclide_atom_densities() method signature", "output": "To call the get_nuclide_atom_densities() method, use: def get_nuclide_atom_densities(self: Any, nuclide: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides parameter do in the get_nuclide_atom_densities() method?", "input": "OpenMC Python API Material.get_nuclide_atom_densities() parameter nuclides", "output": "The nuclides parameter nuclide for which atom density is desired. if not specified, the atom density for each nuclide in the material is given. .. versionadded:: 0.13.2. It should be a str, optional value." }, { "instruction": "What does the get_nuclide_atom_densities() method return in the Material class?", "input": "OpenMC Python API Material.get_nuclide_atom_densities() return value", "output": "The get_nuclide_atom_densities() method returns dictionary whose keys are nuclide names and values are densities in [atom/b-cm]. The return type is dict." }, { "instruction": "What does the get_element_atom_densities() method do in the Material class?", "input": "OpenMC Python API Material.get_element_atom_densities() method", "output": "The get_element_atom_densities() method returns one or all elements in the material and their atomic densities in units of atom/b-cm .. versionadded:: 0.15.1. It's used for material operations." }, { "instruction": "How do you call the get_element_atom_densities() method in the Material class?", "input": "OpenMC Python API Material.get_element_atom_densities() method signature", "output": "To call the get_element_atom_densities() method, use: def get_element_atom_densities(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the element parameter do in the get_element_atom_densities() method?", "input": "OpenMC Python API Material.get_element_atom_densities() parameter element", "output": "The element parameter element for which atom density is desired. if not specified, the atom density for each element in the material is given.. It should be a str, optional value." }, { "instruction": "What does the get_element_atom_densities() method return in the Material class?", "input": "OpenMC Python API Material.get_element_atom_densities() return value", "output": "The get_element_atom_densities() method returns dictionary whose keys are element names and values are densities in [atom/b-cm]. The return type is dict." }, { "instruction": "What does the get_activity() method do in the Material class?", "input": "OpenMC Python API Material.get_activity() method", "output": "The get_activity() method returns the activity of the material or of each nuclide within. .. versionadded:: 0.13.1. It's used for material operations." }, { "instruction": "How do you call the get_activity() method in the Material class?", "input": "OpenMC Python API Material.get_activity() method signature", "output": "To call the get_activity() method, use: def get_activity(self: Any, units: str, by_nuclide: bool, volume: Any). It takes 4 parameters." }, { "instruction": "What does the units parameter do in the get_activity() method?", "input": "OpenMC Python API Material.get_activity() parameter units", "output": "The units parameter specifies the type of activity to return, options include total activity [bq,ci], specific [bq/g, bq/kg] or volumetric activity [bq/cm3,ci/m3]. default is volumetric activity [bq/cm3].. It should be a {'Bq', 'Bq/g', 'Bq/kg', 'Bq/cm3', 'Ci', 'Ci/m3'} value." }, { "instruction": "What does the by_nuclide parameter do in the get_activity() method?", "input": "OpenMC Python API Material.get_activity() parameter by_nuclide", "output": "The by_nuclide parameter specifies if the activity should be returned for the material as a whole or per nuclide. default is false.. It should be a bool value." }, { "instruction": "What does the volume parameter do in the get_activity() method?", "input": "OpenMC Python API Material.get_activity() parameter volume", "output": "The volume parameter volume of the material. if not passed, defaults to using the :attr:`material.volume` attribute. .. versionadded:: 0.13.3. It should be a float, optional value." }, { "instruction": "What does the get_decay_heat() method do in the Material class?", "input": "OpenMC Python API Material.get_decay_heat() method", "output": "The get_decay_heat() method returns the decay heat of the material or for each nuclide in the material in units of [w], [w/g], [w/kg] or [w/cm3]. .. versionadded:: 0.13.3. It's used for material operations." }, { "instruction": "How do you call the get_decay_heat() method in the Material class?", "input": "OpenMC Python API Material.get_decay_heat() method signature", "output": "To call the get_decay_heat() method, use: def get_decay_heat(self: Any, units: str, by_nuclide: bool, volume: Any). It takes 4 parameters." }, { "instruction": "What does the units parameter do in the get_decay_heat() method?", "input": "OpenMC Python API Material.get_decay_heat() parameter units", "output": "The units parameter specifies the units of decay heat to return. options include total heat [w], specific [w/g, w/kg] or volumetric heat [w/cm3]. default is total heat [w].. It should be a {'W', 'W/g', 'W/kg', 'W/cm3'} value." }, { "instruction": "What does the by_nuclide parameter do in the get_decay_heat() method?", "input": "OpenMC Python API Material.get_decay_heat() parameter by_nuclide", "output": "The by_nuclide parameter specifies if the decay heat should be returned for the material as a whole or per nuclide. default is false.. It should be a bool value." }, { "instruction": "What does the volume parameter do in the get_decay_heat() method?", "input": "OpenMC Python API Material.get_decay_heat() parameter volume", "output": "The volume parameter volume of the material. if not passed, defaults to using the :attr:`material.volume` attribute. .. versionadded:: 0.13.3. It should be a float, optional value." }, { "instruction": "What does the get_nuclide_atoms() method do in the Material class?", "input": "OpenMC Python API Material.get_nuclide_atoms() method", "output": "The get_nuclide_atoms() method return number of atoms of each nuclide in the material .. versionadded:: 0.13.1. It's used for material operations." }, { "instruction": "How do you call the get_nuclide_atoms() method in the Material class?", "input": "OpenMC Python API Material.get_nuclide_atoms() method signature", "output": "To call the get_nuclide_atoms() method, use: def get_nuclide_atoms(self: Any, volume: Any). It takes 2 parameters." }, { "instruction": "What does the volume parameter do in the get_nuclide_atoms() method?", "input": "OpenMC Python API Material.get_nuclide_atoms() parameter volume", "output": "The volume parameter volume of the material. if not passed, defaults to using the :attr:`material.volume` attribute. .. versionadded:: 0.13.3. It should be a float, optional value." }, { "instruction": "What does the get_mass_density() method do in the Material class?", "input": "OpenMC Python API Material.get_mass_density() method", "output": "The get_mass_density() method return mass density of one or all nuclides. It's used for material operations." }, { "instruction": "How do you call the get_mass_density() method in the Material class?", "input": "OpenMC Python API Material.get_mass_density() method signature", "output": "To call the get_mass_density() method, use: def get_mass_density(self: Any, nuclide: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides parameter do in the get_mass_density() method?", "input": "OpenMC Python API Material.get_mass_density() parameter nuclides", "output": "The nuclides parameter nuclide for which density is desired. if not specified, the density for the entire material is given.. It should be a str, optional value." }, { "instruction": "What does the get_mass() method do in the Material class?", "input": "OpenMC Python API Material.get_mass() method", "output": "The get_mass() method return mass of one or all nuclides. note that this method requires that the :attr:`material.volume` has already been set. It's used for material operations." }, { "instruction": "How do you call the get_mass() method in the Material class?", "input": "OpenMC Python API Material.get_mass() method signature", "output": "To call the get_mass() method, use: def get_mass(self: Any, nuclide: Any, volume: Any). It takes 3 parameters." }, { "instruction": "What does the nuclides parameter do in the get_mass() method?", "input": "OpenMC Python API Material.get_mass() parameter nuclides", "output": "The nuclides parameter nuclide for which mass is desired. if not specified, the density for the entire material is given.. It should be a str, optional value." }, { "instruction": "What does the volume parameter do in the get_mass() method?", "input": "OpenMC Python API Material.get_mass() parameter volume", "output": "The volume parameter volume of the material. if not passed, defaults to using the :attr:`material.volume` attribute. .. versionadded:: 0.13.3. It should be a float, optional value." }, { "instruction": "What does the waste_classification() method do in the Material class?", "input": "OpenMC Python API Material.waste_classification() method", "output": "The waste_classification() method classify the material for near-surface waste disposal. this method determines a waste classification for the material based on the nrc regulations (10 cfr 61.55). note that the nrc regulations do not consider many long-lived radionuclides relevant to fusion systems; for fusion applications, it is recommended to calculate a waste disposal rating based on limits by fetter et al. using the :meth:`~openmc.material.waste_disposal_rating` method. It's used for material operations." }, { "instruction": "How do you call the waste_classification() method in the Material class?", "input": "OpenMC Python API Material.waste_classification() method signature", "output": "To call the waste_classification() method, use: def waste_classification(self: Any, metal: bool). It takes 2 parameters." }, { "instruction": "What does the metal parameter do in the waste_classification() method?", "input": "OpenMC Python API Material.waste_classification() parameter metal", "output": "The metal parameter whether or not the material is in metal form.. It should be a bool, optional value." }, { "instruction": "What does the waste_disposal_rating() method do in the Material class?", "input": "OpenMC Python API Material.waste_disposal_rating() method", "output": "The waste_disposal_rating() method return the waste disposal rating for the material. this method returns a waste disposal rating for the material based on a set of specific activity limits. the waste disposal rating is a single number that represents the sum of the ratios of the specific activity for each radionuclide in the material against a nuclide-specific limit. a value less than 1.0 indicates that the material \"meets\" the limits whereas a value greater than 1.0 exceeds the limits. note that the limits for nrc do not consider many long-lived radionuclides relevant to fusion systems. a paper by `fetter et al. `_ applies the nrc methodology to calculate specific activity limits for an expanded set of radionuclides. It's used for material operations." }, { "instruction": "How do you call the waste_disposal_rating() method in the Material class?", "input": "OpenMC Python API Material.waste_disposal_rating() method signature", "output": "To call the waste_disposal_rating() method, use: def waste_disposal_rating(self: Any, limits: Any, metal: bool). It takes 3 parameters." }, { "instruction": "What does the limits parameter do in the waste_disposal_rating() method?", "input": "OpenMC Python API Material.waste_disposal_rating() parameter limits", "output": "The limits parameter the name of a predefined set of specific activity limits or a dictionary that contains specific activity limits for radionuclides, where keys are nuclide names and values are activities in units of [ci/m3]. the predefined options are: - 'fetter': uses limits from fetter et al. (1990) - 'nrc_long': uses the 10 cfr 61.55 limits for long-lived radionuclides - 'nrc_short_a': uses the 10 cfr 61.55 class a limits for short-lived radionuclides - 'nrc_short_b': uses the 10 cfr 61.55 class b limits for short-lived radionuclides - 'nrc_short_c': uses the 10 cfr 61.55 class c limits for short-lived radionuclides. It should be a str or dict, optional value." }, { "instruction": "What does the metal parameter do in the waste_disposal_rating() method?", "input": "OpenMC Python API Material.waste_disposal_rating() parameter metal", "output": "The metal parameter whether or not the material is in metal form (only applicable for nrc based limits). It should be a bool, optional value." }, { "instruction": "What does the clone() method do in the Material class?", "input": "OpenMC Python API Material.clone() method", "output": "The clone() method create a copy of this material with a new unique id. It's used for material operations." }, { "instruction": "How do you call the clone() method in the Material class?", "input": "OpenMC Python API Material.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the memo parameter do in the clone() method?", "input": "OpenMC Python API Material.clone() parameter memo", "output": "The memo parameter a nested dictionary of previously cloned objects. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the clone() method return in the Material class?", "input": "OpenMC Python API Material.clone() return value", "output": "The clone() method returns the clone of this material. The return type is openmc.Material." }, { "instruction": "How do you call the _get_nuclide_xml() method in the Material class?", "input": "OpenMC Python API Material._get_nuclide_xml() method signature", "output": "To call the _get_nuclide_xml() method, use: def _get_nuclide_xml(self: Any, nuclide: NuclideTuple). It takes 2 parameters." }, { "instruction": "How do you call the _get_macroscopic_xml() method in the Material class?", "input": "OpenMC Python API Material._get_macroscopic_xml() method signature", "output": "To call the _get_macroscopic_xml() method, use: def _get_macroscopic_xml(self: Any, macroscopic: str). It takes 2 parameters." }, { "instruction": "How do you call the _get_nuclides_xml() method in the Material class?", "input": "OpenMC Python API Material._get_nuclides_xml() method signature", "output": "To call the _get_nuclides_xml() method, use: def _get_nuclides_xml(self: Any, nuclides: Any, nuclides_to_ignore: Any). It takes 3 parameters." }, { "instruction": "What does the to_xml_element() method do in the Material class?", "input": "OpenMC Python API Material.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the material. It's used for material operations." }, { "instruction": "How do you call the to_xml_element() method in the Material class?", "input": "OpenMC Python API Material.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, nuclides_to_ignore: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides_to_ignore parameter do in the to_xml_element() method?", "input": "OpenMC Python API Material.to_xml_element() parameter nuclides_to_ignore", "output": "The nuclides_to_ignore parameter nuclides to ignore when exporting to xml.. It should be a list of str value." }, { "instruction": "What does the to_xml_element() method return in the Material class?", "input": "OpenMC Python API Material.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing material data. The return type is lxml.etree._Element." }, { "instruction": "What does the mix_materials() method do in the Material class?", "input": "OpenMC Python API Material.mix_materials() method", "output": "The mix_materials() method mix materials together based on atom, weight, or volume fractions .. versionadded:: 0.12. It's used for material operations." }, { "instruction": "How do you call the mix_materials() method in the Material class?", "input": "OpenMC Python API Material.mix_materials() method signature", "output": "To call the mix_materials() method, use: @classmethod def mix_materials(cls: Any, materials: Any, fracs: Any, percent_type: str). It takes 4 parameters." }, { "instruction": "What does the materials parameter do in the mix_materials() method?", "input": "OpenMC Python API Material.mix_materials() parameter materials", "output": "The materials parameter materials to combine. It should be a Iterable of openmc.Material value." }, { "instruction": "What does the fracs parameter do in the mix_materials() method?", "input": "OpenMC Python API Material.mix_materials() parameter fracs", "output": "The fracs parameter fractions of each material to be combined. It should be a Iterable of float value." }, { "instruction": "What does the percent_type parameter do in the mix_materials() method?", "input": "OpenMC Python API Material.mix_materials() parameter percent_type", "output": "The percent_type parameter type of percentage, must be one of 'ao', 'wo', or 'vo', to signify atom percent (molar percent), weight percent, or volume percent, optional. defaults to 'ao' **kwargs keyword arguments passed to :class:`openmc.material`. It should be a {'ao', 'wo', 'vo'} value." }, { "instruction": "What does the from_xml_element() method do in the Material class?", "input": "OpenMC Python API Material.from_xml_element() method", "output": "The from_xml_element() method generate material from an xml element. It's used for material operations." }, { "instruction": "How do you call the from_xml_element() method in the Material class?", "input": "OpenMC Python API Material.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Material.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Materials class in OpenMC's Python API?", "input": "OpenMC Python API Materials class", "output": "The Materials class represents collection of materials used for an openmc simulation. this class corresponds directly to the materials.xml input file. it can be thought of as a normal python list where each member is a :class:`material`. it behaves like a list as the following example demonstrates: >>> fuel = openmc.material() >>> clad = openmc.material() >>> water = openmc.material() >>> m = openmc.materials([fuel]) >>> m.append(water) >>> m += [clad]. It provides 10 methods and 0 properties for working with materials data in OpenMC." }, { "instruction": "What does the Materials class do in OpenMC's Python API?", "input": "OpenMC Python API Materials class description", "output": "The Materials class collection of materials used for an openmc simulation. this class corresponds directly to the materials.xml input file. it can be thought of as a normal python list where each member is a :class:`material`. it behaves like a list as the following example demonstrates: >>> fuel = openmc.material() >>> clad = openmc.material() >>> water = openmc.material() >>> m = openmc.materials([fuel]) >>> m.append(water) >>> m += [clad]. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the materials parameter do when creating a Materials?", "input": "OpenMC Python API Materials constructor parameter materials", "output": "When creating a Materials, the materials parameter specifies materials to add to the collection. It should be a Iterable of openmc.Material value." }, { "instruction": "What is the cross_sections attribute of a Materials?", "input": "OpenMC Python API Materials attribute cross_sections", "output": "The cross_sections attribute of a Materials contains indicates the path to an xml cross section listing file (usually named cross_sections.xml). if it is not set, the :envvar:`openmc_cross_sections` environment variable will be used for continuous-energy calculations and :envvar:`openmc_mg_cross_sections` will be used for multi-group calculations to find the path to the hdf5 cross section file.. It's a str or path-like value that you can access after creating a Materials instance." }, { "instruction": "How do you call the __init__() method in the Materials class?", "input": "OpenMC Python API Materials.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, materials: Any). It takes 2 parameters." }, { "instruction": "How do you call the cross_sections() method in the Materials class?", "input": "OpenMC Python API Materials.cross_sections() method signature", "output": "To call the cross_sections() method, use: @property def cross_sections(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cross_sections() method in the Materials class?", "input": "OpenMC Python API Materials.cross_sections() method signature", "output": "To call the cross_sections() method, use: @cross_sections.setter def cross_sections(self: Any, cross_sections: Any). It takes 2 parameters." }, { "instruction": "What does the append() method do in the Materials class?", "input": "OpenMC Python API Materials.append() method", "output": "The append() method append material to collection. It's used for materials operations." }, { "instruction": "How do you call the append() method in the Materials class?", "input": "OpenMC Python API Materials.append() method signature", "output": "To call the append() method, use: def append(self: Any, material: Any). It takes 2 parameters." }, { "instruction": "What does the material parameter do in the append() method?", "input": "OpenMC Python API Materials.append() parameter material", "output": "The material parameter material to append. It should be a openmc.Material value." }, { "instruction": "What does the insert() method do in the Materials class?", "input": "OpenMC Python API Materials.insert() method", "output": "The insert() method insert material before index. It's used for materials operations." }, { "instruction": "How do you call the insert() method in the Materials class?", "input": "OpenMC Python API Materials.insert() method signature", "output": "To call the insert() method, use: def insert(self: Any, index: int, material: Any). It takes 3 parameters." }, { "instruction": "What does the index parameter do in the insert() method?", "input": "OpenMC Python API Materials.insert() parameter index", "output": "The index parameter index in list. It should be a int value." }, { "instruction": "What does the material parameter do in the insert() method?", "input": "OpenMC Python API Materials.insert() parameter material", "output": "The material parameter material to insert. It should be a openmc.Material value." }, { "instruction": "How do you call the make_isotropic_in_lab() method in the Materials class?", "input": "OpenMC Python API Materials.make_isotropic_in_lab() method signature", "output": "To call the make_isotropic_in_lab() method, use: def make_isotropic_in_lab(self: Any). It takes 1 parameters." }, { "instruction": "What does the _write_xml() method do in the Materials class?", "input": "OpenMC Python API Materials._write_xml() method", "output": "The _write_xml() method writes xml content of the materials to an open file handle. It's used for materials operations." }, { "instruction": "How do you call the _write_xml() method in the Materials class?", "input": "OpenMC Python API Materials._write_xml() method signature", "output": "To call the _write_xml() method, use: def _write_xml(self: Any, file: Any, header: Any, level: Any, spaces_per_level: Any, trailing_indent: Any, nuclides_to_ignore: Any). It takes 7 parameters." }, { "instruction": "What does the file parameter do in the _write_xml() method?", "input": "OpenMC Python API Materials._write_xml() parameter file", "output": "The file parameter open file handle to write content into.. It should be a IOTextWrapper value." }, { "instruction": "What does the header parameter do in the _write_xml() method?", "input": "OpenMC Python API Materials._write_xml() parameter header", "output": "The header parameter whether or not to write the xml header. It should be a bool value." }, { "instruction": "What does the level parameter do in the _write_xml() method?", "input": "OpenMC Python API Materials._write_xml() parameter level", "output": "The level parameter indentation level of materials element. It should be a int value." }, { "instruction": "What does the spaces_per_level parameter do in the _write_xml() method?", "input": "OpenMC Python API Materials._write_xml() parameter spaces_per_level", "output": "The spaces_per_level parameter number of spaces per indentation. It should be a int value." }, { "instruction": "What does the trailing_indentation parameter do in the _write_xml() method?", "input": "OpenMC Python API Materials._write_xml() parameter trailing_indentation", "output": "The trailing_indentation parameter whether or not to write a trailing indentation for the materials element. It should be a bool value." }, { "instruction": "What does the nuclides_to_ignore parameter do in the _write_xml() method?", "input": "OpenMC Python API Materials._write_xml() parameter nuclides_to_ignore", "output": "The nuclides_to_ignore parameter nuclides to ignore when exporting to xml.. It should be a list of str value." }, { "instruction": "What does the export_to_xml() method do in the Materials class?", "input": "OpenMC Python API Materials.export_to_xml() method", "output": "The export_to_xml() method export material collection to an xml file. It's used for materials operations." }, { "instruction": "How do you call the export_to_xml() method in the Materials class?", "input": "OpenMC Python API Materials.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, path: PathLike, nuclides_to_ignore: Any). It takes 3 parameters." }, { "instruction": "What does the path parameter do in the export_to_xml() method?", "input": "OpenMC Python API Materials.export_to_xml() parameter path", "output": "The path parameter path to file to write. defaults to 'materials.xml'.. It should be a str value." }, { "instruction": "What does the nuclides_to_ignore parameter do in the export_to_xml() method?", "input": "OpenMC Python API Materials.export_to_xml() parameter nuclides_to_ignore", "output": "The nuclides_to_ignore parameter nuclides to ignore when exporting to xml.. It should be a list of str value." }, { "instruction": "What does the from_xml_element() method do in the Materials class?", "input": "OpenMC Python API Materials.from_xml_element() method", "output": "The from_xml_element() method generate materials collection from xml file. It's used for materials operations." }, { "instruction": "How do you call the from_xml_element() method in the Materials class?", "input": "OpenMC Python API Materials.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Materials.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the from_xml() method do in the Materials class?", "input": "OpenMC Python API Materials.from_xml() method", "output": "The from_xml() method generate materials collection from xml file. It's used for materials operations." }, { "instruction": "How do you call the from_xml() method in the Materials class?", "input": "OpenMC Python API Materials.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, path: PathLike). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the from_xml() method?", "input": "OpenMC Python API Materials.from_xml() parameter path", "output": "The path parameter path to materials xml file. It should be a str value." }, { "instruction": "How do you call the openmc_natabund() function in OpenMC's Python API?", "input": "OpenMC Python API openmc_natabund() function signature", "output": "To call the openmc_natabund() function, use: def openmc_natabund(Z: Any). It takes 1 parameters." }, { "instruction": "What is the MeshMaterialVolumes class in OpenMC's Python API?", "input": "OpenMC Python API MeshMaterialVolumes class", "output": "The MeshMaterialVolumes class represents results from a material volume in mesh calculation. this class provides multiple ways of accessing information about material volumes in individual mesh elements. first, the class behaves like a dictionary that maps material ids to an array of volumes equal in size to the number of mesh elements. second, the class provides a :meth:`by_element` method that gives all the material volumes for a specific mesh element. .. versionadded:: 0.15.1. It provides 9 methods and 0 properties for working with meshmaterialvolumes data in OpenMC." }, { "instruction": "What does the MeshMaterialVolumes class do in OpenMC's Python API?", "input": "OpenMC Python API MeshMaterialVolumes class description", "output": "The MeshMaterialVolumes class results from a material volume in mesh calculation. this class provides multiple ways of accessing information about material volumes in individual mesh elements. first, the class behaves like a dictionary that maps material ids to an array of volumes equal in size to the number of mesh elements. second, the class provides a :meth:`by_element` method that gives all the material volumes for a specific mesh element. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the materials parameter do when creating a MeshMaterialVolumes?", "input": "OpenMC Python API MeshMaterialVolumes constructor parameter materials", "output": "When creating a MeshMaterialVolumes, the materials parameter specifies array of shape (elements, max_materials) storing material ids. It should be a numpy.ndarray value." }, { "instruction": "What does the volumes parameter do when creating a MeshMaterialVolumes?", "input": "OpenMC Python API MeshMaterialVolumes constructor parameter volumes", "output": "When creating a MeshMaterialVolumes, the volumes parameter specifies array of shape (elements, max_materials) storing material volumes see also -------- openmc.meshbase.material_volumes. It should be a numpy.ndarray value." }, { "instruction": "How do you call the __init__() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, materials: np.ndarray, volumes: np.ndarray). It takes 3 parameters." }, { "instruction": "How do you call the num_elements() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.num_elements() method signature", "output": "To call the num_elements() method, use: @property def num_elements(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __iter__() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.__iter__() method signature", "output": "To call the __iter__() method, use: def __iter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __len__() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getitem__() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, material_id: int). It takes 2 parameters." }, { "instruction": "What does the by_element() method do in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.by_element() method", "output": "The by_element() method get a list of volumes for each material within a specific element. It's used for meshmaterialvolumes operations." }, { "instruction": "How do you call the by_element() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.by_element() method signature", "output": "To call the by_element() method, use: def by_element(self: Any, index_elem: int). It takes 2 parameters." }, { "instruction": "What does the index_elem parameter do in the by_element() method?", "input": "OpenMC Python API MeshMaterialVolumes.by_element() parameter index_elem", "output": "The index_elem parameter mesh element index. It should be a int value." }, { "instruction": "What does the save() method do in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.save() method", "output": "The save() method save material volumes to a .npz file. It's used for meshmaterialvolumes operations." }, { "instruction": "How do you call the save() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.save() method signature", "output": "To call the save() method, use: def save(self: Any, filename: PathLike). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the save() method?", "input": "OpenMC Python API MeshMaterialVolumes.save() parameter filename", "output": "The filename parameter filename where data will be saved. It should be a path-like value." }, { "instruction": "What does the from_npz() method do in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.from_npz() method", "output": "The from_npz() method generate material volumes from a .npz file. It's used for meshmaterialvolumes operations." }, { "instruction": "How do you call the from_npz() method in the MeshMaterialVolumes class?", "input": "OpenMC Python API MeshMaterialVolumes.from_npz() method signature", "output": "To call the from_npz() method, use: @classmethod def from_npz(cls: Any, filename: PathLike). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the from_npz() method?", "input": "OpenMC Python API MeshMaterialVolumes.from_npz() parameter filename", "output": "The filename parameter file where data will be read from. It should be a path-like value." }, { "instruction": "What is the MeshBase class in OpenMC's Python API?", "input": "OpenMC Python API MeshBase class", "output": "The MeshBase class represents a mesh that partitions geometry for tallying purposes. It provides 12 methods and 0 properties for working with meshbase data in OpenMC." }, { "instruction": "What does the MeshBase class do in OpenMC's Python API?", "input": "OpenMC Python API MeshBase class description", "output": "The MeshBase class a mesh that partitions geometry for tallying purposes. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh_id parameter do when creating a MeshBase?", "input": "OpenMC Python API MeshBase constructor parameter mesh_id", "output": "When creating a MeshBase, the mesh_id parameter specifies unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do when creating a MeshBase?", "input": "OpenMC Python API MeshBase constructor parameter name", "output": "When creating a MeshBase, the name parameter specifies name of the mesh. It should be a str value." }, { "instruction": "What is the id attribute of a MeshBase?", "input": "OpenMC Python API MeshBase attribute id", "output": "The id attribute of a MeshBase contains unique identifier for the mesh. It's a int value that you can access after creating a MeshBase instance." }, { "instruction": "What is the name attribute of a MeshBase?", "input": "OpenMC Python API MeshBase attribute name", "output": "The name attribute of a MeshBase contains name of the mesh. It's a str value that you can access after creating a MeshBase instance." }, { "instruction": "What is the bounding_box attribute of a MeshBase?", "input": "OpenMC Python API MeshBase attribute bounding_box", "output": "The bounding_box attribute of a MeshBase contains axis-aligned bounding box of the mesh as defined by the upper-right and lower-left coordinates.. It's a openmc.BoundingBox value that you can access after creating a MeshBase instance." }, { "instruction": "What is the indices attribute of a MeshBase?", "input": "OpenMC Python API MeshBase attribute indices", "output": "The indices attribute of a MeshBase contains an iterable of mesh indices for each mesh element, e.g. [(1, 1, 1), (2, 1, 1), ...]. It's a Iterable of tuple value that you can access after creating a MeshBase instance." }, { "instruction": "How do you call the __init__() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh_id: Any, name: str). It takes 3 parameters." }, { "instruction": "How do you call the name() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: str). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.indices() method signature", "output": "To call the indices() method, use: @property, @abstractmethod def indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _volume_dim_check() method in the MeshBase class?", "input": "OpenMC Python API MeshBase._volume_dim_check() method signature", "output": "To call the _volume_dim_check() method, use: def _volume_dim_check(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_hdf5() method do in the MeshBase class?", "input": "OpenMC Python API MeshBase.from_hdf5() method", "output": "The from_hdf5() method create mesh from hdf5 group. It's used for meshbase operations." }, { "instruction": "How do you call the from_hdf5() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API MeshBase.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the to_xml_element() method do in the MeshBase class?", "input": "OpenMC Python API MeshBase.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the mesh. It's used for meshbase operations." }, { "instruction": "How do you call the to_xml_element() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the MeshBase class?", "input": "OpenMC Python API MeshBase.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing mesh data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the MeshBase class?", "input": "OpenMC Python API MeshBase.from_xml_element() method", "output": "The from_xml_element() method generates a mesh from an xml element. It's used for meshbase operations." }, { "instruction": "How do you call the from_xml_element() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API MeshBase.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the get_homogenized_materials() method do in the MeshBase class?", "input": "OpenMC Python API MeshBase.get_homogenized_materials() method", "output": "The get_homogenized_materials() method generate homogenized materials over each element in a mesh. .. versionadded:: 0.15.0. It's used for meshbase operations." }, { "instruction": "How do you call the get_homogenized_materials() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.get_homogenized_materials() method signature", "output": "To call the get_homogenized_materials() method, use: def get_homogenized_materials(self: Any, model: openmc.Model, n_samples: Any, include_void: bool). It takes 4 parameters." }, { "instruction": "What does the model parameter do in the get_homogenized_materials() method?", "input": "OpenMC Python API MeshBase.get_homogenized_materials() parameter model", "output": "The model parameter model containing materials to be homogenized and the associated geometry.. It should be a openmc.Model value." }, { "instruction": "What does the n_samples parameter do in the get_homogenized_materials() method?", "input": "OpenMC Python API MeshBase.get_homogenized_materials() parameter n_samples", "output": "The n_samples parameter total number of rays to sample. the number of rays in each direction is determined by the aspect ratio of the mesh bounding box. when specified as a 3-tuple, it is interpreted as the number of rays in the x, y, and z dimensions.. It should be a int or 2-tuple of int value." }, { "instruction": "What does the include_void parameter do in the get_homogenized_materials() method?", "input": "OpenMC Python API MeshBase.get_homogenized_materials() parameter include_void", "output": "The include_void parameter whether homogenization should include voids. **kwargs keyword-arguments passed to :meth:`meshbase.material_volumes`.. It should be a bool, optional value." }, { "instruction": "What does the material_volumes() method do in the MeshBase class?", "input": "OpenMC Python API MeshBase.material_volumes() method", "output": "The material_volumes() method determine volume of materials in each mesh element. this method works by raytracing repeatedly through the mesh to count the estimated volume of each material in all mesh elements. three sets of rays are used: one set parallel to the x-axis, one parallel to the y-axis, and one parallel to the z-axis. .. versionadded:: 0.15.1. It's used for meshbase operations." }, { "instruction": "How do you call the material_volumes() method in the MeshBase class?", "input": "OpenMC Python API MeshBase.material_volumes() method signature", "output": "To call the material_volumes() method, use: def material_volumes(self: Any, model: openmc.Model, n_samples: Any, max_materials: int). It takes 4 parameters." }, { "instruction": "What does the model parameter do in the material_volumes() method?", "input": "OpenMC Python API MeshBase.material_volumes() parameter model", "output": "The model parameter model containing materials.. It should be a openmc.Model value." }, { "instruction": "What does the n_samples parameter do in the material_volumes() method?", "input": "OpenMC Python API MeshBase.material_volumes() parameter n_samples", "output": "The n_samples parameter total number of rays to sample. the number of rays in each direction is determined by the aspect ratio of the mesh bounding box. when specified as a 3-tuple, it is interpreted as the number of rays in the x, y, and z dimensions.. It should be a int or 3-tuple of int value." }, { "instruction": "What does the max_materials parameter do in the material_volumes() method?", "input": "OpenMC Python API MeshBase.material_volumes() parameter max_materials", "output": "The max_materials parameter estimated maximum number of materials in any given mesh element. **kwargs : dict keyword arguments passed to :func:`openmc.lib.init`. It should be a int, optional value." }, { "instruction": "What is the StructuredMesh class in OpenMC's Python API?", "input": "OpenMC Python API StructuredMesh class", "output": "The StructuredMesh class represents a base class for structured mesh functionality. It provides 14 methods and 0 properties for working with structuredmesh data in OpenMC." }, { "instruction": "What does the StructuredMesh class do in OpenMC's Python API?", "input": "OpenMC Python API StructuredMesh class description", "output": "The StructuredMesh class a base class for structured mesh functionality. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh_id parameter do when creating a StructuredMesh?", "input": "OpenMC Python API StructuredMesh constructor parameter mesh_id", "output": "When creating a StructuredMesh, the mesh_id parameter specifies unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do when creating a StructuredMesh?", "input": "OpenMC Python API StructuredMesh constructor parameter name", "output": "When creating a StructuredMesh, the name parameter specifies name of the mesh. It should be a str value." }, { "instruction": "What is the id attribute of a StructuredMesh?", "input": "OpenMC Python API StructuredMesh attribute id", "output": "The id attribute of a StructuredMesh contains unique identifier for the mesh. It's a int value that you can access after creating a StructuredMesh instance." }, { "instruction": "What is the name attribute of a StructuredMesh?", "input": "OpenMC Python API StructuredMesh attribute name", "output": "The name attribute of a StructuredMesh contains name of the mesh. It's a str value that you can access after creating a StructuredMesh instance." }, { "instruction": "How do you call the __init__() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dimension() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.dimension() method signature", "output": "To call the dimension() method, use: @property, @abstractmethod def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_dimension() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.n_dimension() method signature", "output": "To call the n_dimension() method, use: @property, @abstractmethod def n_dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _grids() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._grids() method signature", "output": "To call the _grids() method, use: @property, @abstractmethod def _grids(self: Any). It takes 1 parameters." }, { "instruction": "What does the vertices() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.vertices() method", "output": "The vertices() method return coordinates of mesh vertices in cartesian coordinates. also see :meth:`cylindricalmesh.vertices_cylindrical` and :meth:`sphericalmesh.vertices_spherical` for coordinates in other coordinate systems. It's used for structuredmesh operations." }, { "instruction": "How do you call the vertices() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.vertices() method signature", "output": "To call the vertices() method, use: @property def vertices(self: Any). It takes 1 parameters." }, { "instruction": "What does the vertices() method return in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.vertices() return value", "output": "The vertices() method returns returns a numpy.ndarray representing the coordinates of the mesh vertices with a shape equal to (dim1 + 1, ..., dimn + 1, ndim). x, y, z values can be unpacked with xx, yy, zz = np.rollaxis(mesh.vertices, -1).. The return type is numpy.ndarray." }, { "instruction": "What does the _generate_vertices() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._generate_vertices() method", "output": "The _generate_vertices() method returns an array with shape (i_grid.size, j_grid.size, k_grid.size, 3)\n containing the corner vertices of mesh elements.. It's used for structuredmesh operations." }, { "instruction": "How do you call the _generate_vertices() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._generate_vertices() method signature", "output": "To call the _generate_vertices() method, use: @staticmethod def _generate_vertices(i_grid: Any, j_grid: Any, k_grid: Any). It takes 3 parameters." }, { "instruction": "What does the _generate_edge_midpoints() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._generate_edge_midpoints() method", "output": "The _generate_edge_midpoints() method generates the midpoints of mesh element edges for each dimension of the mesh. It's used for structuredmesh operations." }, { "instruction": "How do you call the _generate_edge_midpoints() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._generate_edge_midpoints() method signature", "output": "To call the _generate_edge_midpoints() method, use: @staticmethod def _generate_edge_midpoints(grids: Any). It takes 1 parameters." }, { "instruction": "What does the grids parameter do in the _generate_edge_midpoints() method?", "input": "OpenMC Python API StructuredMesh._generate_edge_midpoints() parameter grids", "output": "The grids parameter the vertex grids along each dimension of the mesh.. It should be a numpy.ndarray value." }, { "instruction": "What does the _generate_edge_midpoints() method return in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._generate_edge_midpoints() return value", "output": "The _generate_edge_midpoints() method returns the edge midpoints for the i, j, and k midpoints of each element in i, j, k ordering. the shapes of the resulting grids are [(ni-1, nj, nk, 3), (ni, nj-1, nk, 3), (ni, nj, nk-1, 3)]. The return type is list of numpy.ndarray." }, { "instruction": "What does the midpoint_vertices() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.midpoint_vertices() method", "output": "The midpoint_vertices() method create vertices that lie on the midpoint of element edges. It's used for structuredmesh operations." }, { "instruction": "How do you call the midpoint_vertices() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.midpoint_vertices() method signature", "output": "To call the midpoint_vertices() method, use: @property def midpoint_vertices(self: Any). It takes 1 parameters." }, { "instruction": "What does the centroids() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.centroids() method", "output": "The centroids() method return coordinates of mesh element centroids. It's used for structuredmesh operations." }, { "instruction": "How do you call the centroids() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.centroids() method signature", "output": "To call the centroids() method, use: @property def centroids(self: Any). It takes 1 parameters." }, { "instruction": "What does the centroids() method return in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.centroids() return value", "output": "The centroids() method returns returns a numpy.ndarray representing the mesh element centroid coordinates with a shape equal to (dim1, ..., dimn, ndim). x, y, z values can be unpacked with xx, yy, zz = np.rollaxis(mesh.centroids, -1).. The return type is numpy.ndarray." }, { "instruction": "How do you call the num_mesh_cells() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.num_mesh_cells() method signature", "output": "To call the num_mesh_cells() method, use: @property def num_mesh_cells(self: Any). It takes 1 parameters." }, { "instruction": "What does the write_data_to_vtk() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.write_data_to_vtk() method", "output": "The write_data_to_vtk() method creates a vtk object of the mesh. It's used for structuredmesh operations." }, { "instruction": "How do you call the write_data_to_vtk() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh.write_data_to_vtk() method signature", "output": "To call the write_data_to_vtk() method, use: def write_data_to_vtk(self: Any, filename: PathLike, datasets: Any, volume_normalization: bool, curvilinear: bool). It takes 5 parameters." }, { "instruction": "What does the filename parameter do in the write_data_to_vtk() method?", "input": "OpenMC Python API StructuredMesh.write_data_to_vtk() parameter filename", "output": "The filename parameter name of the vtk file to write.. It should be a str value." }, { "instruction": "What does the datasets parameter do in the write_data_to_vtk() method?", "input": "OpenMC Python API StructuredMesh.write_data_to_vtk() parameter datasets", "output": "The datasets parameter dictionary whose keys are the data labels and values are the data sets.. It should be a dict value." }, { "instruction": "What does the volume_normalization parameter do in the write_data_to_vtk() method?", "input": "OpenMC Python API StructuredMesh.write_data_to_vtk() parameter volume_normalization", "output": "The volume_normalization parameter whether or not to normalize the data by the volume of the mesh elements.. It should be a bool, optional value." }, { "instruction": "What does the curvilinear parameter do in the write_data_to_vtk() method?", "input": "OpenMC Python API StructuredMesh.write_data_to_vtk() parameter curvilinear", "output": "The curvilinear parameter whether or not to write curvilinear elements. only applies to ``sphericalmesh`` and ``cylindricalmesh``.. It should be a bool value." }, { "instruction": "What does the _create_vtk_structured_grid() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._create_vtk_structured_grid() method", "output": "The _create_vtk_structured_grid() method create a structured grid. It's used for structuredmesh operations." }, { "instruction": "How do you call the _create_vtk_structured_grid() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._create_vtk_structured_grid() method signature", "output": "To call the _create_vtk_structured_grid() method, use: def _create_vtk_structured_grid(self: Any). It takes 1 parameters." }, { "instruction": "What does the _create_vtk_unstructured_grid() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._create_vtk_unstructured_grid() method", "output": "The _create_vtk_unstructured_grid() method create an unstructured grid of curvilinear elements representing the mesh. It's used for structuredmesh operations." }, { "instruction": "How do you call the _create_vtk_unstructured_grid() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._create_vtk_unstructured_grid() method signature", "output": "To call the _create_vtk_unstructured_grid() method, use: def _create_vtk_unstructured_grid(self: Any). It takes 1 parameters." }, { "instruction": "What does the _check_vtk_datasets() method do in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._check_vtk_datasets() method", "output": "The _check_vtk_datasets() method perform some basic checks that the datasets are valid for this mesh. It's used for structuredmesh operations." }, { "instruction": "How do you call the _check_vtk_datasets() method in the StructuredMesh class?", "input": "OpenMC Python API StructuredMesh._check_vtk_datasets() method signature", "output": "To call the _check_vtk_datasets() method, use: def _check_vtk_datasets(self: Any, datasets: dict). It takes 2 parameters." }, { "instruction": "What does the datasets parameter do in the _check_vtk_datasets() method?", "input": "OpenMC Python API StructuredMesh._check_vtk_datasets() parameter datasets", "output": "The datasets parameter dictionary whose keys are the data labels and values are the data sets.. It should be a dict value." }, { "instruction": "What is the RegularMesh class in OpenMC's Python API?", "input": "OpenMC Python API RegularMesh class", "output": "The RegularMesh class represents a regular cartesian mesh in one, two, or three dimensions. It provides 21 methods and 0 properties for working with regularmesh data in OpenMC." }, { "instruction": "What does the RegularMesh class do in OpenMC's Python API?", "input": "OpenMC Python API RegularMesh class description", "output": "The RegularMesh class a regular cartesian mesh in one, two, or three dimensions. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh_id parameter do when creating a RegularMesh?", "input": "OpenMC Python API RegularMesh constructor parameter mesh_id", "output": "When creating a RegularMesh, the mesh_id parameter specifies unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do when creating a RegularMesh?", "input": "OpenMC Python API RegularMesh constructor parameter name", "output": "When creating a RegularMesh, the name parameter specifies name of the mesh. It should be a str value." }, { "instruction": "What is the id attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute id", "output": "The id attribute of a RegularMesh contains unique identifier for the mesh. It's a int value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the name attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute name", "output": "The name attribute of a RegularMesh contains name of the mesh. It's a str value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the dimension attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute dimension", "output": "The dimension attribute of a RegularMesh contains the number of mesh cells in each direction (x, y, z).. It's a Iterable of int value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the n_dimension attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute n_dimension", "output": "The n_dimension attribute of a RegularMesh contains number of mesh dimensions.. It's a int value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the lower_left attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute lower_left", "output": "The lower_left attribute of a RegularMesh contains the lower-left corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a Iterable of float value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the upper_right attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute upper_right", "output": "The upper_right attribute of a RegularMesh contains the upper-right corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a Iterable of float value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the bounding_box attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute bounding_box", "output": "The bounding_box attribute of a RegularMesh contains axis-aligned bounding box of the mesh as defined by the upper-right and lower-left coordinates.. It's a openmc.BoundingBox value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the width attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute width", "output": "The width attribute of a RegularMesh contains the width of mesh cells in each direction.. It's a Iterable of float value that you can access after creating a RegularMesh instance." }, { "instruction": "What is the indices attribute of a RegularMesh?", "input": "OpenMC Python API RegularMesh attribute indices", "output": "The indices attribute of a RegularMesh contains an iterable of mesh indices for each mesh element, e.g. [(1, 1, 1), (2, 1, 1), ...]. It's a Iterable of tuple value that you can access after creating a RegularMesh instance." }, { "instruction": "How do you call the __init__() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh_id: Any, name: str). It takes 3 parameters." }, { "instruction": "How do you call the dimension() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the dimension() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.dimension() method signature", "output": "To call the dimension() method, use: @dimension.setter def dimension(self: Any, dimension: Any). It takes 2 parameters." }, { "instruction": "How do you call the n_dimension() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.n_dimension() method signature", "output": "To call the n_dimension() method, use: @property def n_dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @lower_left.setter def lower_left(self: Any, lower_left: Any). It takes 2 parameters." }, { "instruction": "How do you call the upper_right() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @upper_right.setter def upper_right(self: Any, upper_right: Any). It takes 2 parameters." }, { "instruction": "How do you call the width() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.width() method signature", "output": "To call the width() method, use: @width.setter def width(self: Any, width: Any). It takes 2 parameters." }, { "instruction": "What does the volumes() method do in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.volumes() method", "output": "The volumes() method return volumes for every mesh cell. It's used for regularmesh operations." }, { "instruction": "How do you call the volumes() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.volumes() method signature", "output": "To call the volumes() method, use: @property def volumes(self: Any). It takes 1 parameters." }, { "instruction": "What does the volumes() method return in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.volumes() return value", "output": "The volumes() method returns volumes. The return type is numpy.ndarray." }, { "instruction": "How do you call the total_volume() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.total_volume() method signature", "output": "To call the total_volume() method, use: @property def total_volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.indices() method signature", "output": "To call the indices() method, use: @property def indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _grids() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh._grids() method signature", "output": "To call the _grids() method, use: @property def _grids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_hdf5() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group, mesh_id: int, name: str). It takes 4 parameters." }, { "instruction": "What does the from_rect_lattice() method do in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.from_rect_lattice() method", "output": "The from_rect_lattice() method create mesh from an existing rectangular lattice. It's used for regularmesh operations." }, { "instruction": "How do you call the from_rect_lattice() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.from_rect_lattice() method signature", "output": "To call the from_rect_lattice() method, use: @classmethod def from_rect_lattice(cls: Any, lattice: Any, division: int, mesh_id: Any, name: str). It takes 5 parameters." }, { "instruction": "What does the lattice parameter do in the from_rect_lattice() method?", "input": "OpenMC Python API RegularMesh.from_rect_lattice() parameter lattice", "output": "The lattice parameter rectangular lattice used as a template for this mesh. It should be a openmc.RectLattice value." }, { "instruction": "What does the division parameter do in the from_rect_lattice() method?", "input": "OpenMC Python API RegularMesh.from_rect_lattice() parameter division", "output": "The division parameter number of mesh cells per lattice cell. if not specified, there will be 1 mesh cell per lattice cell.. It should be a int value." }, { "instruction": "What does the mesh_id parameter do in the from_rect_lattice() method?", "input": "OpenMC Python API RegularMesh.from_rect_lattice() parameter mesh_id", "output": "The mesh_id parameter unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do in the from_rect_lattice() method?", "input": "OpenMC Python API RegularMesh.from_rect_lattice() parameter name", "output": "The name parameter name of the mesh. It should be a str value." }, { "instruction": "What does the from_domain() method do in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.from_domain() method", "output": "The from_domain() method create mesh from an existing openmc cell, region, universe or geometry by making use of the objects bounding box property. It's used for regularmesh operations." }, { "instruction": "How do you call the from_domain() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.from_domain() method signature", "output": "To call the from_domain() method, use: @classmethod def from_domain(cls: Any, domain: Any, dimension: Any, mesh_id: Any, name: str). It takes 5 parameters." }, { "instruction": "What does the domain parameter do in the from_domain() method?", "input": "OpenMC Python API RegularMesh.from_domain() parameter domain", "output": "The domain parameter the object passed in will be used as a template for this mesh. the bounding box of the property of the object passed will be used to set the lower_left and upper_right and of the mesh instance. It should be a {openmc.Cell, openmc.Region, openmc.Universe, openmc.Geometry} value." }, { "instruction": "What does the dimension parameter do in the from_domain() method?", "input": "OpenMC Python API RegularMesh.from_domain() parameter dimension", "output": "The dimension parameter the number of mesh cells in each direction (x, y, z).. It should be a Iterable of int value." }, { "instruction": "What does the mesh_id parameter do in the from_domain() method?", "input": "OpenMC Python API RegularMesh.from_domain() parameter mesh_id", "output": "The mesh_id parameter unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do in the from_domain() method?", "input": "OpenMC Python API RegularMesh.from_domain() parameter name", "output": "The name parameter name of the mesh. It should be a str value." }, { "instruction": "What does the to_xml_element() method do in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the mesh. It's used for regularmesh operations." }, { "instruction": "How do you call the to_xml_element() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing mesh data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.from_xml_element() method", "output": "The from_xml_element() method generate mesh from an xml element. It's used for regularmesh operations." }, { "instruction": "How do you call the from_xml_element() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API RegularMesh.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the build_cells() method do in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.build_cells() method", "output": "The build_cells() method generates a lattice of universes with the same dimensionality as the mesh object. the individual cells/universes produced will not have material definitions applied and so downstream code will have to apply that information. It's used for regularmesh operations." }, { "instruction": "How do you call the build_cells() method in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.build_cells() method signature", "output": "To call the build_cells() method, use: def build_cells(self: Any, bc: Any). It takes 2 parameters." }, { "instruction": "What does the bc parameter do in the build_cells() method?", "input": "OpenMC Python API RegularMesh.build_cells() parameter bc", "output": "The bc parameter boundary conditions for each of the four faces of a rectangle (if applying to a 2d mesh) or six faces of a parallelepiped (if applying to a 3d mesh) provided in the following order: [x min, x max, y min, y max, z min, z max]. 2-d cells do not contain the z min and z max entries. defaults to 'reflective' for all faces.. It should be a iterable of {'reflective', 'periodic', 'transmission', 'vacuum', or 'white'} value." }, { "instruction": "What does the build_cells() method return in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.build_cells() return value", "output": "The build_cells() method returns the cell containing the lattice representing the mesh geometry; this cell is a single parallelepiped with boundaries matching the outermost mesh boundary with the boundary conditions from bc applied.. The return type is openmc.Cell." }, { "instruction": "What does the build_cells() method return in the RegularMesh class?", "input": "OpenMC Python API RegularMesh.build_cells() return value", "output": "The build_cells() method returns the list of cells within each lattice position mimicking the mesh geometry.. The return type is iterable of openmc.Cell." }, { "instruction": "What is the RectilinearMesh class in OpenMC's Python API?", "input": "OpenMC Python API RectilinearMesh class", "output": "The RectilinearMesh class represents a 3d rectilinear cartesian mesh. It provides 19 methods and 0 properties for working with rectilinearmesh data in OpenMC." }, { "instruction": "What does the RectilinearMesh class do in OpenMC's Python API?", "input": "OpenMC Python API RectilinearMesh class description", "output": "The RectilinearMesh class a 3d rectilinear cartesian mesh. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh_id parameter do when creating a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh constructor parameter mesh_id", "output": "When creating a RectilinearMesh, the mesh_id parameter specifies unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do when creating a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh constructor parameter name", "output": "When creating a RectilinearMesh, the name parameter specifies name of the mesh. It should be a str value." }, { "instruction": "What is the id attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute id", "output": "The id attribute of a RectilinearMesh contains unique identifier for the mesh. It's a int value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the name attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute name", "output": "The name attribute of a RectilinearMesh contains name of the mesh. It's a str value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the dimension attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute dimension", "output": "The dimension attribute of a RectilinearMesh contains the number of mesh cells in each direction (x, y, z).. It's a Iterable of int value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the n_dimension attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute n_dimension", "output": "The n_dimension attribute of a RectilinearMesh contains number of mesh dimensions (always 3 for a rectilinearmesh).. It's a int value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the x_grid attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute x_grid", "output": "The x_grid attribute of a RectilinearMesh contains 1-d array of mesh boundary points along the x-axis.. It's a numpy.ndarray value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the y_grid attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute y_grid", "output": "The y_grid attribute of a RectilinearMesh contains 1-d array of mesh boundary points along the y-axis.. It's a numpy.ndarray value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the z_grid attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute z_grid", "output": "The z_grid attribute of a RectilinearMesh contains 1-d array of mesh boundary points along the z-axis.. It's a numpy.ndarray value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the indices attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute indices", "output": "The indices attribute of a RectilinearMesh contains an iterable of mesh indices for each mesh element, e.g. [(1, 1, 1), (2, 1, 1), ...]. It's a Iterable of tuple value that you can access after creating a RectilinearMesh instance." }, { "instruction": "What is the bounding_box attribute of a RectilinearMesh?", "input": "OpenMC Python API RectilinearMesh attribute bounding_box", "output": "The bounding_box attribute of a RectilinearMesh contains axis-aligned bounding box of the mesh as defined by the upper-right and lower-left coordinates.. It's a openmc.BoundingBox value that you can access after creating a RectilinearMesh instance." }, { "instruction": "How do you call the __init__() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh_id: int, name: str). It takes 3 parameters." }, { "instruction": "How do you call the dimension() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_dimension() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.n_dimension() method signature", "output": "To call the n_dimension() method, use: @property def n_dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x_grid() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.x_grid() method signature", "output": "To call the x_grid() method, use: @property def x_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x_grid() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.x_grid() method signature", "output": "To call the x_grid() method, use: @x_grid.setter def x_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the y_grid() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.y_grid() method signature", "output": "To call the y_grid() method, use: @property def y_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the y_grid() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.y_grid() method signature", "output": "To call the y_grid() method, use: @y_grid.setter def y_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the z_grid() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.z_grid() method signature", "output": "To call the z_grid() method, use: @property def z_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the z_grid() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.z_grid() method signature", "output": "To call the z_grid() method, use: @z_grid.setter def z_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the _grids() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh._grids() method signature", "output": "To call the _grids() method, use: @property def _grids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "What does the volumes() method do in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.volumes() method", "output": "The volumes() method return volumes for every mesh cell. It's used for rectilinearmesh operations." }, { "instruction": "How do you call the volumes() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.volumes() method signature", "output": "To call the volumes() method, use: @property def volumes(self: Any). It takes 1 parameters." }, { "instruction": "What does the volumes() method return in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.volumes() return value", "output": "The volumes() method returns volumes. The return type is numpy.ndarray." }, { "instruction": "How do you call the total_volume() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.total_volume() method signature", "output": "To call the total_volume() method, use: @property def total_volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.indices() method signature", "output": "To call the indices() method, use: @property def indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_hdf5() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group, mesh_id: int, name: str). It takes 4 parameters." }, { "instruction": "What does the from_xml_element() method do in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.from_xml_element() method", "output": "The from_xml_element() method generate a rectilinear mesh from an xml element. It's used for rectilinearmesh operations." }, { "instruction": "How do you call the from_xml_element() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API RectilinearMesh.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the to_xml_element() method do in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the mesh. It's used for rectilinearmesh operations." }, { "instruction": "How do you call the to_xml_element() method in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the RectilinearMesh class?", "input": "OpenMC Python API RectilinearMesh.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing mesh data. The return type is lxml.etree._Element." }, { "instruction": "What is the CylindricalMesh class in OpenMC's Python API?", "input": "OpenMC Python API CylindricalMesh class", "output": "The CylindricalMesh class represents a 3d cylindrical mesh. It provides 27 methods and 0 properties for working with cylindricalmesh data in OpenMC." }, { "instruction": "What does the CylindricalMesh class do in OpenMC's Python API?", "input": "OpenMC Python API CylindricalMesh class description", "output": "The CylindricalMesh class a 3d cylindrical mesh. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the r_grid parameter do when creating a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh constructor parameter r_grid", "output": "When creating a CylindricalMesh, the r_grid parameter specifies 1-d array of mesh boundary points along the r-axis requirement is r >= 0.. It should be a numpy.ndarray value." }, { "instruction": "What does the z_grid parameter do when creating a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh constructor parameter z_grid", "output": "When creating a CylindricalMesh, the z_grid parameter specifies 1-d array of mesh boundary points along the z-axis relative to the origin.. It should be a numpy.ndarray value." }, { "instruction": "What does the phi_grid parameter do when creating a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh constructor parameter phi_grid", "output": "When creating a CylindricalMesh, the phi_grid parameter specifies 1-d array of mesh boundary points along the phi-axis in radians. the default value is [0, 2\u03c0], i.e. the full phi range.. It should be a numpy.ndarray value." }, { "instruction": "What does the origin parameter do when creating a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh constructor parameter origin", "output": "When creating a CylindricalMesh, the origin parameter specifies 1-d array of length 3 the (x,y,z) origin of the mesh in cartesian coordinates. It should be a numpy.ndarray value." }, { "instruction": "What does the mesh_id parameter do when creating a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh constructor parameter mesh_id", "output": "When creating a CylindricalMesh, the mesh_id parameter specifies unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do when creating a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh constructor parameter name", "output": "When creating a CylindricalMesh, the name parameter specifies name of the mesh. It should be a str value." }, { "instruction": "What is the id attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute id", "output": "The id attribute of a CylindricalMesh contains unique identifier for the mesh. It's a int value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the name attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute name", "output": "The name attribute of a CylindricalMesh contains name of the mesh. It's a str value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the dimension attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute dimension", "output": "The dimension attribute of a CylindricalMesh contains the number of mesh cells in each direction (r_grid, phi_grid, z_grid).. It's a Iterable of int value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the n_dimension attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute n_dimension", "output": "The n_dimension attribute of a CylindricalMesh contains number of mesh dimensions (always 3 for a cylindricalmesh).. It's a int value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the r_grid attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute r_grid", "output": "The r_grid attribute of a CylindricalMesh contains 1-d array of mesh boundary points along the r-axis. requirement is r >= 0.. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the phi_grid attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute phi_grid", "output": "The phi_grid attribute of a CylindricalMesh contains 1-d array of mesh boundary points along the phi-axis in radians. the default value is [0, 2\u03c0], i.e. the full phi range.. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the z_grid attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute z_grid", "output": "The z_grid attribute of a CylindricalMesh contains 1-d array of mesh boundary points along the z-axis relative to the origin.. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the origin attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute origin", "output": "The origin attribute of a CylindricalMesh contains 1-d array of length 3 the (x,y,z) origin of the mesh in cartesian coordinates. It's a numpy.ndarray value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the indices attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute indices", "output": "The indices attribute of a CylindricalMesh contains an iterable of mesh indices for each mesh element, e.g. [(1, 1, 1), (2, 1, 1), ...]. It's a Iterable of tuple value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the lower_left attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute lower_left", "output": "The lower_left attribute of a CylindricalMesh contains the lower-left corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a Iterable of float value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the upper_right attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute upper_right", "output": "The upper_right attribute of a CylindricalMesh contains the upper-right corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a Iterable of float value that you can access after creating a CylindricalMesh instance." }, { "instruction": "What is the bounding_box attribute of a CylindricalMesh?", "input": "OpenMC Python API CylindricalMesh attribute bounding_box", "output": "The bounding_box attribute of a CylindricalMesh contains axis-aligned bounding box of the mesh as defined by the upper-right and lower-left coordinates.. It's a openmc.BoundingBox value that you can access after creating a CylindricalMesh instance." }, { "instruction": "How do you call the __init__() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, r_grid: Any, z_grid: Any, phi_grid: Any, origin: Any, mesh_id: Any, name: str). It takes 7 parameters." }, { "instruction": "How do you call the dimension() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_dimension() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.n_dimension() method signature", "output": "To call the n_dimension() method, use: @property def n_dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.origin() method signature", "output": "To call the origin() method, use: @property def origin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.origin() method signature", "output": "To call the origin() method, use: @origin.setter def origin(self: Any, coords: Any). It takes 2 parameters." }, { "instruction": "How do you call the r_grid() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.r_grid() method signature", "output": "To call the r_grid() method, use: @property def r_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the r_grid() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.r_grid() method signature", "output": "To call the r_grid() method, use: @r_grid.setter def r_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the phi_grid() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.phi_grid() method signature", "output": "To call the phi_grid() method, use: @property def phi_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the phi_grid() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.phi_grid() method signature", "output": "To call the phi_grid() method, use: @phi_grid.setter def phi_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the z_grid() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.z_grid() method signature", "output": "To call the z_grid() method, use: @property def z_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the z_grid() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.z_grid() method signature", "output": "To call the z_grid() method, use: @z_grid.setter def z_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the _grids() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh._grids() method signature", "output": "To call the _grids() method, use: @property def _grids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.indices() method signature", "output": "To call the indices() method, use: @property def indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_indices_at_coords() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.get_indices_at_coords() method", "output": "The get_indices_at_coords() method finds the index of the mesh voxel at the specified x,y,z coordinates. .. versionadded:: 0.15.0. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the get_indices_at_coords() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.get_indices_at_coords() method signature", "output": "To call the get_indices_at_coords() method, use: def get_indices_at_coords(self: Any, coords: Any). It takes 2 parameters." }, { "instruction": "What does the coords parameter do in the get_indices_at_coords() method?", "input": "OpenMC Python API CylindricalMesh.get_indices_at_coords() parameter coords", "output": "The coords parameter the x, y, z axis coordinates. It should be a Sequence[float] value." }, { "instruction": "How do you call the from_hdf5() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group, mesh_id: int, name: str). It takes 4 parameters." }, { "instruction": "What does the from_domain() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.from_domain() method", "output": "The from_domain() method creates a regular cylindricalmesh from an existing openmc domain. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the from_domain() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.from_domain() method signature", "output": "To call the from_domain() method, use: @classmethod def from_domain(cls: Any, domain: Any, dimension: Any, mesh_id: Any, phi_grid_bounds: Any, name: str). It takes 6 parameters." }, { "instruction": "What does the domain parameter do in the from_domain() method?", "input": "OpenMC Python API CylindricalMesh.from_domain() parameter domain", "output": "The domain parameter the object passed in will be used as a template for this mesh. the bounding box of the property of the object passed will be used to set the r_grid, z_grid ranges.. It should be a openmc.Cell or openmc.Region or openmc.Universe or openmc.Geometry value." }, { "instruction": "What does the dimension parameter do in the from_domain() method?", "input": "OpenMC Python API CylindricalMesh.from_domain() parameter dimension", "output": "The dimension parameter the number of equally spaced mesh cells in each direction (r_grid, phi_grid, z_grid). It should be a Iterable of int value." }, { "instruction": "What does the mesh_id parameter do in the from_domain() method?", "input": "OpenMC Python API CylindricalMesh.from_domain() parameter mesh_id", "output": "The mesh_id parameter unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the phi_grid_bounds parameter do in the from_domain() method?", "input": "OpenMC Python API CylindricalMesh.from_domain() parameter phi_grid_bounds", "output": "The phi_grid_bounds parameter mesh bounds points along the phi-axis in radians. the default value is (0, 2\u03c0), i.e., the full phi range.. It should be a numpy.ndarray value." }, { "instruction": "What does the name parameter do in the from_domain() method?", "input": "OpenMC Python API CylindricalMesh.from_domain() parameter name", "output": "The name parameter name of the mesh. It should be a str value." }, { "instruction": "What does the to_xml_element() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the mesh. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the to_xml_element() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing mesh data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.from_xml_element() method", "output": "The from_xml_element() method generate a cylindrical mesh from an xml element. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the from_xml_element() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API CylindricalMesh.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the volumes() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.volumes() method", "output": "The volumes() method return volumes for every mesh cell. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the volumes() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.volumes() method signature", "output": "To call the volumes() method, use: @property def volumes(self: Any). It takes 1 parameters." }, { "instruction": "What does the volumes() method return in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.volumes() return value", "output": "The volumes() method returns volumes. The return type is Iterable of float." }, { "instruction": "How do you call the vertices() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.vertices() method signature", "output": "To call the vertices() method, use: @property def vertices(self: Any). It takes 1 parameters." }, { "instruction": "What does the vertices_cylindrical() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.vertices_cylindrical() method", "output": "The vertices_cylindrical() method returns vertices of the mesh in cylindrical coordinates.. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the vertices_cylindrical() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.vertices_cylindrical() method signature", "output": "To call the vertices_cylindrical() method, use: @property def vertices_cylindrical(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the centroids() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.centroids() method signature", "output": "To call the centroids() method, use: @property def centroids(self: Any). It takes 1 parameters." }, { "instruction": "What does the centroids_cylindrical() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.centroids_cylindrical() method", "output": "The centroids_cylindrical() method returns centroids of the mesh in cylindrical coordinates.. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the centroids_cylindrical() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh.centroids_cylindrical() method signature", "output": "To call the centroids_cylindrical() method, use: @property def centroids_cylindrical(self: Any). It takes 1 parameters." }, { "instruction": "What does the _convert_to_cartesian() method do in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh._convert_to_cartesian() method", "output": "The _convert_to_cartesian() method converts an array with r, phi, z values in the last dimension (shape (..., 3))\n to cartesian coordinates.. It's used for cylindricalmesh operations." }, { "instruction": "How do you call the _convert_to_cartesian() method in the CylindricalMesh class?", "input": "OpenMC Python API CylindricalMesh._convert_to_cartesian() method signature", "output": "To call the _convert_to_cartesian() method, use: @staticmethod def _convert_to_cartesian(arr: Any, origin: Any). It takes 2 parameters." }, { "instruction": "What is the SphericalMesh class in OpenMC's Python API?", "input": "OpenMC Python API SphericalMesh class", "output": "The SphericalMesh class represents a 3d spherical mesh. It provides 25 methods and 0 properties for working with sphericalmesh data in OpenMC." }, { "instruction": "What does the SphericalMesh class do in OpenMC's Python API?", "input": "OpenMC Python API SphericalMesh class description", "output": "The SphericalMesh class a 3d spherical mesh. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the r_grid parameter do when creating a SphericalMesh?", "input": "OpenMC Python API SphericalMesh constructor parameter r_grid", "output": "When creating a SphericalMesh, the r_grid parameter specifies 1-d array of mesh boundary points along the r-axis. requirement is r >= 0.. It should be a numpy.ndarray value." }, { "instruction": "What does the phi_grid parameter do when creating a SphericalMesh?", "input": "OpenMC Python API SphericalMesh constructor parameter phi_grid", "output": "When creating a SphericalMesh, the phi_grid parameter specifies 1-d array of mesh boundary points along the phi-axis in radians. the default value is [0, 2\u03c0], i.e. the full phi range.. It should be a numpy.ndarray value." }, { "instruction": "What does the theta_grid parameter do when creating a SphericalMesh?", "input": "OpenMC Python API SphericalMesh constructor parameter theta_grid", "output": "When creating a SphericalMesh, the theta_grid parameter specifies 1-d array of mesh boundary points along the theta-axis in radians. the default value is [0, \u03c0], i.e. the full theta range.. It should be a numpy.ndarray value." }, { "instruction": "What does the origin parameter do when creating a SphericalMesh?", "input": "OpenMC Python API SphericalMesh constructor parameter origin", "output": "When creating a SphericalMesh, the origin parameter specifies 1-d array of length 3 the (x,y,z) origin of the mesh in cartesian coordinates. It should be a numpy.ndarray value." }, { "instruction": "What does the mesh_id parameter do when creating a SphericalMesh?", "input": "OpenMC Python API SphericalMesh constructor parameter mesh_id", "output": "When creating a SphericalMesh, the mesh_id parameter specifies unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do when creating a SphericalMesh?", "input": "OpenMC Python API SphericalMesh constructor parameter name", "output": "When creating a SphericalMesh, the name parameter specifies name of the mesh. It should be a str value." }, { "instruction": "What is the id attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute id", "output": "The id attribute of a SphericalMesh contains unique identifier for the mesh. It's a int value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the name attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute name", "output": "The name attribute of a SphericalMesh contains name of the mesh. It's a str value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the dimension attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute dimension", "output": "The dimension attribute of a SphericalMesh contains the number of mesh cells in each direction (r_grid, theta_grid, phi_grid).. It's a Iterable of int value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the n_dimension attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute n_dimension", "output": "The n_dimension attribute of a SphericalMesh contains number of mesh dimensions (always 3 for a sphericalmesh).. It's a int value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the r_grid attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute r_grid", "output": "The r_grid attribute of a SphericalMesh contains 1-d array of mesh boundary points along the r-axis. requirement is r >= 0.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the theta_grid attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute theta_grid", "output": "The theta_grid attribute of a SphericalMesh contains 1-d array of mesh boundary points along the theta-axis in radians. the default value is [0, \u03c0], i.e. the full theta range.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the phi_grid attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute phi_grid", "output": "The phi_grid attribute of a SphericalMesh contains 1-d array of mesh boundary points along the phi-axis in radians. the default value is [0, 2\u03c0], i.e. the full phi range.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the origin attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute origin", "output": "The origin attribute of a SphericalMesh contains 1-d array of length 3 the (x,y,z) origin of the mesh in cartesian coordinates. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the indices attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute indices", "output": "The indices attribute of a SphericalMesh contains an iterable of mesh indices for each mesh element, e.g. [(1, 1, 1), (2, 1, 1), ...]. It's a Iterable of tuple value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the lower_left attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute lower_left", "output": "The lower_left attribute of a SphericalMesh contains the lower-left corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the upper_right attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute upper_right", "output": "The upper_right attribute of a SphericalMesh contains the upper-right corner of the structured mesh. if only two coordinate are given, it is assumed that the mesh is an x-y mesh.. It's a numpy.ndarray value that you can access after creating a SphericalMesh instance." }, { "instruction": "What is the bounding_box attribute of a SphericalMesh?", "input": "OpenMC Python API SphericalMesh attribute bounding_box", "output": "The bounding_box attribute of a SphericalMesh contains axis-aligned bounding box of the mesh as defined by the upper-right and lower-left coordinates.. It's a openmc.BoundingBox value that you can access after creating a SphericalMesh instance." }, { "instruction": "How do you call the __init__() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, r_grid: Any, phi_grid: Any, theta_grid: Any, origin: Any, mesh_id: Any, name: str). It takes 7 parameters." }, { "instruction": "How do you call the dimension() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_dimension() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.n_dimension() method signature", "output": "To call the n_dimension() method, use: @property def n_dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.origin() method signature", "output": "To call the origin() method, use: @property def origin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.origin() method signature", "output": "To call the origin() method, use: @origin.setter def origin(self: Any, coords: Any). It takes 2 parameters." }, { "instruction": "How do you call the r_grid() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.r_grid() method signature", "output": "To call the r_grid() method, use: @property def r_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the r_grid() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.r_grid() method signature", "output": "To call the r_grid() method, use: @r_grid.setter def r_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the theta_grid() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.theta_grid() method signature", "output": "To call the theta_grid() method, use: @property def theta_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the theta_grid() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.theta_grid() method signature", "output": "To call the theta_grid() method, use: @theta_grid.setter def theta_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the phi_grid() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.phi_grid() method signature", "output": "To call the phi_grid() method, use: @property def phi_grid(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the phi_grid() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.phi_grid() method signature", "output": "To call the phi_grid() method, use: @phi_grid.setter def phi_grid(self: Any, grid: Any). It takes 2 parameters." }, { "instruction": "How do you call the _grids() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh._grids() method signature", "output": "To call the _grids() method, use: @property def _grids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.indices() method signature", "output": "To call the indices() method, use: @property def indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_hdf5() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group, mesh_id: int, name: str). It takes 4 parameters." }, { "instruction": "What does the to_xml_element() method do in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the mesh. It's used for sphericalmesh operations." }, { "instruction": "How do you call the to_xml_element() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing mesh data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.from_xml_element() method", "output": "The from_xml_element() method generate a spherical mesh from an xml element. It's used for sphericalmesh operations." }, { "instruction": "How do you call the from_xml_element() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API SphericalMesh.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the volumes() method do in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.volumes() method", "output": "The volumes() method return volumes for every mesh cell. It's used for sphericalmesh operations." }, { "instruction": "How do you call the volumes() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.volumes() method signature", "output": "To call the volumes() method, use: @property def volumes(self: Any). It takes 1 parameters." }, { "instruction": "What does the volumes() method return in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.volumes() return value", "output": "The volumes() method returns volumes. The return type is Iterable of float." }, { "instruction": "How do you call the vertices() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.vertices() method signature", "output": "To call the vertices() method, use: @property def vertices(self: Any). It takes 1 parameters." }, { "instruction": "What does the vertices_spherical() method do in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.vertices_spherical() method", "output": "The vertices_spherical() method returns vertices of the mesh in cylindrical coordinates.. It's used for sphericalmesh operations." }, { "instruction": "How do you call the vertices_spherical() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.vertices_spherical() method signature", "output": "To call the vertices_spherical() method, use: @property def vertices_spherical(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the centroids() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.centroids() method signature", "output": "To call the centroids() method, use: @property def centroids(self: Any). It takes 1 parameters." }, { "instruction": "What does the centroids_spherical() method do in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.centroids_spherical() method", "output": "The centroids_spherical() method returns centroids of the mesh in cylindrical coordinates.. It's used for sphericalmesh operations." }, { "instruction": "How do you call the centroids_spherical() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh.centroids_spherical() method signature", "output": "To call the centroids_spherical() method, use: @property def centroids_spherical(self: Any). It takes 1 parameters." }, { "instruction": "What does the _convert_to_cartesian() method do in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh._convert_to_cartesian() method", "output": "The _convert_to_cartesian() method converts an array with r, theta, phi values in the last dimension (shape (..., 3))\n to cartesian coordinates.. It's used for sphericalmesh operations." }, { "instruction": "How do you call the _convert_to_cartesian() method in the SphericalMesh class?", "input": "OpenMC Python API SphericalMesh._convert_to_cartesian() method signature", "output": "To call the _convert_to_cartesian() method, use: @staticmethod def _convert_to_cartesian(arr: Any, origin: Any). It takes 2 parameters." }, { "instruction": "What is the UnstructuredMesh class in OpenMC's Python API?", "input": "OpenMC Python API UnstructuredMesh class", "output": "The UnstructuredMesh class represents a 3d unstructured mesh .. versionadded:: 0.12 .. versionchanged:: 0.12.2 support for libmesh unstructured meshes was added. It provides 35 methods and 0 properties for working with unstructuredmesh data in OpenMC." }, { "instruction": "What does the UnstructuredMesh class do in OpenMC's Python API?", "input": "OpenMC Python API UnstructuredMesh class description", "output": "The UnstructuredMesh class a 3d unstructured mesh .. versionadded:: 0.12 .. versionchanged:: 0.12.2 support for libmesh unstructured meshes was added. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filename parameter do when creating a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh constructor parameter filename", "output": "When creating a UnstructuredMesh, the filename parameter specifies location of the unstructured mesh file. supported files for 'moab' library are .h5 and .vtk. supported files for 'libmesh' library are exodus mesh files .exo.. It should be a path-like value." }, { "instruction": "What does the library parameter do when creating a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh constructor parameter library", "output": "When creating a UnstructuredMesh, the library parameter specifies mesh library used for the unstructured mesh tally. It should be a {'moab', 'libmesh'} value." }, { "instruction": "What does the mesh_id parameter do when creating a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh constructor parameter mesh_id", "output": "When creating a UnstructuredMesh, the mesh_id parameter specifies unique identifier for the mesh. It should be a int value." }, { "instruction": "What does the name parameter do when creating a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh constructor parameter name", "output": "When creating a UnstructuredMesh, the name parameter specifies name of the mesh. It should be a str value." }, { "instruction": "What does the length_multiplier parameter do when creating a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh constructor parameter length_multiplier", "output": "When creating a UnstructuredMesh, the length_multiplier parameter specifies constant multiplier to apply to mesh coordinates. It should be a float value." }, { "instruction": "What does the options parameter do when creating a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh constructor parameter options", "output": "When creating a UnstructuredMesh, the options parameter specifies special options that control spatial search data structures used. this is currently only used to set `parameters `_ for moab's adaptivekdtree. if none, openmc internally uses a default of \"max_depth=20;plane_set=2;\".. It should be a str, optional value." }, { "instruction": "What is the id attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute id", "output": "The id attribute of a UnstructuredMesh contains unique identifier for the mesh. It's a int value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the name attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute name", "output": "The name attribute of a UnstructuredMesh contains name of the mesh. It's a str value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the filename attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute filename", "output": "The filename attribute of a UnstructuredMesh contains name of the file containing the unstructured mesh. It's a str value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the length_multiplier attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute length_multiplier", "output": "The length_multiplier attribute of a UnstructuredMesh contains multiplicative factor to apply to mesh coordinates. It's a float value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the library attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute library", "output": "The library attribute of a UnstructuredMesh contains mesh library used for the unstructured mesh tally. It's a {'moab', 'libmesh'} value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the options attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute options", "output": "The options attribute of a UnstructuredMesh contains special options that control spatial search data structures used. this is currently only used to set `parameters `_ for moab's adaptivekdtree. if none, openmc internally uses a default of \"max_depth=20;plane_set=2;\".. It's a str value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the output attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute output", "output": "The output attribute of a UnstructuredMesh contains indicates whether or not automatic tally output should be generated for this mesh. It's a bool value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the volumes attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute volumes", "output": "The volumes attribute of a UnstructuredMesh contains volumes of the unstructured mesh elements. It's a Iterable of float value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the centroids attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute centroids", "output": "The centroids attribute of a UnstructuredMesh contains centroids of the mesh elements with array shape (n_elements, 3). It's a numpy.ndarray value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the vertices attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute vertices", "output": "The vertices attribute of a UnstructuredMesh contains coordinates of the mesh vertices with array shape (n_elements, 3) .. versionadded:: 0.13.1. It's a numpy.ndarray value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the connectivity attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute connectivity", "output": "The connectivity attribute of a UnstructuredMesh contains connectivity of the elements with array shape (n_elements, 8) .. versionadded:: 0.13.1. It's a numpy.ndarray value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the element_types attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute element_types", "output": "The element_types attribute of a UnstructuredMesh contains mesh element types .. versionadded:: 0.13.1. It's a Iterable of integers value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the total_volume attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute total_volume", "output": "The total_volume attribute of a UnstructuredMesh contains volume of the unstructured mesh in total. It's a float value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "What is the bounding_box attribute of a UnstructuredMesh?", "input": "OpenMC Python API UnstructuredMesh attribute bounding_box", "output": "The bounding_box attribute of a UnstructuredMesh contains axis-aligned bounding box of the mesh as defined by the upper-right and lower-left coordinates.. It's a openmc.BoundingBox value that you can access after creating a UnstructuredMesh instance." }, { "instruction": "How do you call the __init__() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filename: PathLike, library: str, mesh_id: Any, name: str, length_multiplier: float, options: Any). It takes 7 parameters." }, { "instruction": "How do you call the filename() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.filename() method signature", "output": "To call the filename() method, use: @property def filename(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filename() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.filename() method signature", "output": "To call the filename() method, use: @filename.setter def filename(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "How do you call the library() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.library() method signature", "output": "To call the library() method, use: @property def library(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the library() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.library() method signature", "output": "To call the library() method, use: @library.setter def library(self: Any, lib: str). It takes 2 parameters." }, { "instruction": "How do you call the options() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.options() method signature", "output": "To call the options() method, use: @property def options(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the options() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.options() method signature", "output": "To call the options() method, use: @options.setter def options(self: Any, options: Any). It takes 2 parameters." }, { "instruction": "How do you call the size() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.size() method signature", "output": "To call the size() method, use: @property, @require_statepoint_data def size(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the size() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.size() method signature", "output": "To call the size() method, use: @size.setter def size(self: Any, size: int). It takes 2 parameters." }, { "instruction": "How do you call the output() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.output() method signature", "output": "To call the output() method, use: @property def output(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the output() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.output() method signature", "output": "To call the output() method, use: @output.setter def output(self: Any, val: bool). It takes 2 parameters." }, { "instruction": "What does the volumes() method do in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.volumes() method", "output": "The volumes() method return volumes for every mesh cell if populated by a statepoint file. It's used for unstructuredmesh operations." }, { "instruction": "How do you call the volumes() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.volumes() method signature", "output": "To call the volumes() method, use: @property, @require_statepoint_data def volumes(self: Any). It takes 1 parameters." }, { "instruction": "What does the volumes() method return in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.volumes() return value", "output": "The volumes() method returns volumes. The return type is numpy.ndarray." }, { "instruction": "How do you call the volumes() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.volumes() method signature", "output": "To call the volumes() method, use: @volumes.setter def volumes(self: Any, volumes: Any). It takes 2 parameters." }, { "instruction": "How do you call the total_volume() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.total_volume() method signature", "output": "To call the total_volume() method, use: @property, @require_statepoint_data def total_volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the vertices() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.vertices() method signature", "output": "To call the vertices() method, use: @property, @require_statepoint_data def vertices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the connectivity() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.connectivity() method signature", "output": "To call the connectivity() method, use: @property, @require_statepoint_data def connectivity(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the element_types() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.element_types() method signature", "output": "To call the element_types() method, use: @property, @require_statepoint_data def element_types(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the centroids() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.centroids() method signature", "output": "To call the centroids() method, use: @property, @require_statepoint_data def centroids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_elements() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.n_elements() method signature", "output": "To call the n_elements() method, use: @property, @require_statepoint_data def n_elements(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_elements() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.n_elements() method signature", "output": "To call the n_elements() method, use: @n_elements.setter def n_elements(self: Any, val: int). It takes 2 parameters." }, { "instruction": "How do you call the length_multiplier() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.length_multiplier() method signature", "output": "To call the length_multiplier() method, use: @property def length_multiplier(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the length_multiplier() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.length_multiplier() method signature", "output": "To call the length_multiplier() method, use: @length_multiplier.setter def length_multiplier(self: Any, length_multiplier: Any). It takes 2 parameters." }, { "instruction": "How do you call the dimension() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.dimension() method signature", "output": "To call the dimension() method, use: @property def dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_dimension() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.n_dimension() method signature", "output": "To call the n_dimension() method, use: @property def n_dimension(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the indices() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.indices() method signature", "output": "To call the indices() method, use: @property, @require_statepoint_data def indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the has_statepoint_data() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.has_statepoint_data() method signature", "output": "To call the has_statepoint_data() method, use: @property def has_statepoint_data(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.lower_left() method signature", "output": "To call the lower_left() method, use: @property, @require_statepoint_data def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.upper_right() method signature", "output": "To call the upper_right() method, use: @property, @require_statepoint_data def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "What does the centroid() method do in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.centroid() method", "output": "The centroid() method return the vertex averaged centroid of an element. It's used for unstructuredmesh operations." }, { "instruction": "How do you call the centroid() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.centroid() method signature", "output": "To call the centroid() method, use: @require_statepoint_data def centroid(self: Any, bin: int). It takes 2 parameters." }, { "instruction": "What does the bin parameter do in the centroid() method?", "input": "OpenMC Python API UnstructuredMesh.centroid() parameter bin", "output": "The bin parameter bin id for the returned centroid. It should be a int value." }, { "instruction": "What does the write_vtk_mesh() method do in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.write_vtk_mesh() method", "output": "The write_vtk_mesh() method map data to unstructured vtk mesh elements. .. deprecated:: 0.13 use :func:`unstructuredmesh.write_data_to_vtk` instead. It's used for unstructuredmesh operations." }, { "instruction": "How do you call the write_vtk_mesh() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.write_vtk_mesh() method signature", "output": "To call the write_vtk_mesh() method, use: def write_vtk_mesh(self: Any). It takes 1 parameters." }, { "instruction": "What does the filename parameter do in the write_vtk_mesh() method?", "input": "OpenMC Python API UnstructuredMesh.write_vtk_mesh() parameter filename", "output": "The filename parameter name of the vtk file to write.. It should be a str or pathlib.Path value." }, { "instruction": "What does the datasets parameter do in the write_vtk_mesh() method?", "input": "OpenMC Python API UnstructuredMesh.write_vtk_mesh() parameter datasets", "output": "The datasets parameter dictionary whose keys are the data labels and values are the data sets.. It should be a dict value." }, { "instruction": "What does the volume_normalization parameter do in the write_vtk_mesh() method?", "input": "OpenMC Python API UnstructuredMesh.write_vtk_mesh() parameter volume_normalization", "output": "The volume_normalization parameter whether or not to normalize the data by the volume of the mesh elements. It should be a bool value." }, { "instruction": "What does the write_data_to_vtk() method do in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.write_data_to_vtk() method", "output": "The write_data_to_vtk() method map data to unstructured vtk mesh elements. if filename is none, then a filename will be generated based on the mesh id, and exported to vtk format. It's used for unstructuredmesh operations." }, { "instruction": "How do you call the write_data_to_vtk() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.write_data_to_vtk() method signature", "output": "To call the write_data_to_vtk() method, use: def write_data_to_vtk(self: Any, filename: Any, datasets: Any, volume_normalization: bool). It takes 4 parameters." }, { "instruction": "What does the filename parameter do in the write_data_to_vtk() method?", "input": "OpenMC Python API UnstructuredMesh.write_data_to_vtk() parameter filename", "output": "The filename parameter name of the vtk file to write. if the filename ends in '.vtu' then a binary vtu format file will be written, if the filename ends in '.vtk' then a legacy vtk file will be written.. It should be a str or pathlib.Path value." }, { "instruction": "What does the datasets parameter do in the write_data_to_vtk() method?", "input": "OpenMC Python API UnstructuredMesh.write_data_to_vtk() parameter datasets", "output": "The datasets parameter dictionary whose keys are the data labels and values are numpy appropriately sized arrays of the data. It should be a dict value." }, { "instruction": "What does the volume_normalization parameter do in the write_data_to_vtk() method?", "input": "OpenMC Python API UnstructuredMesh.write_data_to_vtk() parameter volume_normalization", "output": "The volume_normalization parameter whether or not to normalize the data by the volume of the mesh elements. It should be a bool value." }, { "instruction": "How do you call the from_hdf5() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group, mesh_id: int, name: str). It takes 4 parameters." }, { "instruction": "What does the to_xml_element() method do in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the mesh. It's used for unstructuredmesh operations." }, { "instruction": "How do you call the to_xml_element() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing mesh data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.from_xml_element() method", "output": "The from_xml_element() method generate unstructured mesh object from xml element. It's used for unstructuredmesh operations." }, { "instruction": "How do you call the from_xml_element() method in the UnstructuredMesh class?", "input": "OpenMC Python API UnstructuredMesh.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API UnstructuredMesh.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "How do you call the Mesh() function in OpenMC's Python API?", "input": "OpenMC Python API Mesh() function signature", "output": "To call the Mesh() function, use: def Mesh(). It takes 0 parameters." }, { "instruction": "How do you call the require_statepoint_data() function in OpenMC's Python API?", "input": "OpenMC Python API require_statepoint_data() function signature", "output": "To call the require_statepoint_data() function, use: def require_statepoint_data(func: Any). It takes 1 parameters." }, { "instruction": "What does the _read_meshes() function do in OpenMC's Python API?", "input": "OpenMC Python API _read_meshes() function", "output": "The _read_meshes() function generate dictionary of meshes from a given xml node. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _read_meshes() function in OpenMC's Python API?", "input": "OpenMC Python API _read_meshes() function purpose", "output": "The _read_meshes() function generate dictionary of meshes from a given xml node. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _read_meshes() function in OpenMC's Python API?", "input": "OpenMC Python API _read_meshes() function signature", "output": "To call the _read_meshes() function, use: def _read_meshes(elem: Any). It takes 1 parameters." }, { "instruction": "What does the elem parameter do in the _read_meshes() function?", "input": "OpenMC Python API _read_meshes() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "How do you call the wrapper() function in OpenMC's Python API?", "input": "OpenMC Python API wrapper() function signature", "output": "To call the wrapper() function, use: def wrapper(self: UnstructuredMesh). It takes 1 parameters." }, { "instruction": "How do you call the _insert_point() function in OpenMC's Python API?", "input": "OpenMC Python API _insert_point() function signature", "output": "To call the _insert_point() function, use: def _insert_point(pnt: Any). It takes 1 parameters." }, { "instruction": "What is the EnergyGroups class in OpenMC's Python API?", "input": "OpenMC Python API EnergyGroups class", "output": "The EnergyGroups class represents an energy group structure used for multigroup cross-sections. It provides 14 methods and 0 properties for working with energygroups data in OpenMC." }, { "instruction": "What does the EnergyGroups class do in OpenMC's Python API?", "input": "OpenMC Python API EnergyGroups class description", "output": "The EnergyGroups class an energy group structure used for multigroup cross-sections. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the group_edges parameter do when creating a EnergyGroups?", "input": "OpenMC Python API EnergyGroups constructor parameter group_edges", "output": "When creating a EnergyGroups, the group_edges parameter specifies the energy group boundaries in [ev] or the name of the group structure (must be a valid key in the openmc.mgxs.group_structures dictionary). .. versionchanged:: 0.14.0 changed to allow a string specifying the group structure name.. It should be a Iterable of float or str value." }, { "instruction": "What is the group_edges attribute of a EnergyGroups?", "input": "OpenMC Python API EnergyGroups attribute group_edges", "output": "The group_edges attribute of a EnergyGroups contains the energy group boundaries in [ev]. It's a np.ndarray value that you can access after creating a EnergyGroups instance." }, { "instruction": "What is the num_groups attribute of a EnergyGroups?", "input": "OpenMC Python API EnergyGroups attribute num_groups", "output": "The num_groups attribute of a EnergyGroups contains the number of energy groups. It's a int value that you can access after creating a EnergyGroups instance." }, { "instruction": "How do you call the __init__() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, group_edges: Any). It takes 2 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the __eq__() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __hash__() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.__hash__() method signature", "output": "To call the __hash__() method, use: def __hash__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the group_edges() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.group_edges() method signature", "output": "To call the group_edges() method, use: @property def group_edges(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the group_edges() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.group_edges() method signature", "output": "To call the group_edges() method, use: @group_edges.setter def group_edges(self: Any, edges: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_groups() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.num_groups() method signature", "output": "To call the num_groups() method, use: @property def num_groups(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_group() method do in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_group() method", "output": "The get_group() method returns the energy group in which the given energy resides. It's used for energygroups operations." }, { "instruction": "How do you call the get_group() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_group() method signature", "output": "To call the get_group() method, use: def get_group(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "What does the energy parameter do in the get_group() method?", "input": "OpenMC Python API EnergyGroups.get_group() parameter energy", "output": "The energy parameter the energy of interest in ev. It should be a float value." }, { "instruction": "What does the get_group_bounds() method do in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_group_bounds() method", "output": "The get_group_bounds() method returns the energy boundaries for the energy group of interest. It's used for energygroups operations." }, { "instruction": "How do you call the get_group_bounds() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_group_bounds() method signature", "output": "To call the get_group_bounds() method, use: def get_group_bounds(self: Any, group: Any). It takes 2 parameters." }, { "instruction": "What does the group parameter do in the get_group_bounds() method?", "input": "OpenMC Python API EnergyGroups.get_group_bounds() parameter group", "output": "The group parameter the energy group index, starting at 1 for the highest energies. It should be a int value." }, { "instruction": "What does the get_group_indices() method do in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_group_indices() method", "output": "The get_group_indices() method returns the array indices for one or more energy groups. It's used for energygroups operations." }, { "instruction": "How do you call the get_group_indices() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_group_indices() method signature", "output": "To call the get_group_indices() method, use: def get_group_indices(self: Any, groups: Any). It takes 2 parameters." }, { "instruction": "What does the groups parameter do in the get_group_indices() method?", "input": "OpenMC Python API EnergyGroups.get_group_indices() parameter groups", "output": "The groups parameter the energy groups of interest - a tuple of the energy group indices, starting at 1 for the highest energies (default is 'all'). It should be a str, tuple value." }, { "instruction": "What does the get_condensed_groups() method do in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_condensed_groups() method", "output": "The get_condensed_groups() method return a coarsened version of this energygroups object. this method merges together energy groups in this object into wider energy groups as defined by the list of groups specified by the user, and returns a new, coarse energygroups object. It's used for energygroups operations." }, { "instruction": "How do you call the get_condensed_groups() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.get_condensed_groups() method signature", "output": "To call the get_condensed_groups() method, use: def get_condensed_groups(self: Any, coarse_groups: Any). It takes 2 parameters." }, { "instruction": "What does the coarse_groups parameter do in the get_condensed_groups() method?", "input": "OpenMC Python API EnergyGroups.get_condensed_groups() parameter coarse_groups", "output": "The coarse_groups parameter the energy groups of interest - a list of 2-tuples, each directly corresponding to one of the new coarse groups. the values in the 2-tuples are upper/lower energy groups used to construct a new coarse group. for example, if [(1,2), (3,4)] was used as the coarse groups, fine groups 1 and 2 would be merged into coarse group 1 while fine groups 3 and 4 would be merged into coarse group 2.. It should be a Iterable of 2-tuple value." }, { "instruction": "What does the can_merge() method do in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.can_merge() method", "output": "The can_merge() method determine if energy groups can be merged with another. It's used for energygroups operations." }, { "instruction": "How do you call the can_merge() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the can_merge() method?", "input": "OpenMC Python API EnergyGroups.can_merge() parameter other", "output": "The other parameter energygroups to compare with. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the merge() method do in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.merge() method", "output": "The merge() method merge this energy groups with another. It's used for energygroups operations." }, { "instruction": "How do you call the merge() method in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API EnergyGroups.merge() parameter other", "output": "The other parameter energygroups to merge with. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the merge() method return in the EnergyGroups class?", "input": "OpenMC Python API EnergyGroups.merge() return value", "output": "The merge() method returns energygroups resulting from the merge. The return type is openmc.mgxs.EnergyGroups." }, { "instruction": "What is the Library class in OpenMC's Python API?", "input": "OpenMC Python API Library class", "output": "The Library class represents a multi-energy-group and multi-delayed-group cross section library for some energy group structure. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for deterministic neutronics calculations. this class helps automate the generation of mgxs and mdgxs objects for some energy group structure and domain type. the library serves as a collection for mgxs and mdgxs objects with routines to automate the initialization of tallies for input files, the loading of tally data from statepoint files, data storage, energy group condensation and more. It provides 55 methods and 0 properties for working with library data in OpenMC." }, { "instruction": "What does the Library class do in OpenMC's Python API?", "input": "OpenMC Python API Library class description", "output": "The Library class a multi-energy-group and multi-delayed-group cross section library for some energy group structure. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for deterministic neutronics calculations. this class helps automate the generation of mgxs and mdgxs objects for some energy group structure and domain type. the library serves as a collection for mgxs and mdgxs objects with routines to automate the initialization of tallies for input files, the loading of tally data from statepoint files, data storage, energy group condensation and more. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the geometry parameter do when creating a Library?", "input": "OpenMC Python API Library constructor parameter geometry", "output": "When creating a Library, the geometry parameter specifies a geometry which has been initialized with a root universe. It should be a openmc.Geometry value." }, { "instruction": "What does the by_nuclide parameter do when creating a Library?", "input": "OpenMC Python API Library constructor parameter by_nuclide", "output": "When creating a Library, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in each domain. It should be a bool value." }, { "instruction": "What does the mgxs_types parameter do when creating a Library?", "input": "OpenMC Python API Library constructor parameter mgxs_types", "output": "When creating a Library, the mgxs_types parameter specifies the types of cross sections in the library (e.g., ['total', 'scatter']). It should be a Iterable of str value." }, { "instruction": "What does the name parameter do when creating a Library?", "input": "OpenMC Python API Library constructor parameter name", "output": "When creating a Library, the name parameter specifies name of the multi-group cross section library. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What is the geometry attribute of a Library?", "input": "OpenMC Python API Library attribute geometry", "output": "The geometry attribute of a Library contains an geometry which has been initialized with a root universe. It's a openmc.Geometry value that you can access after creating a Library instance." }, { "instruction": "What is the by_nuclide attribute of a Library?", "input": "OpenMC Python API Library attribute by_nuclide", "output": "The by_nuclide attribute of a Library contains if true, computes cross sections for each nuclide in each domain. It's a bool value that you can access after creating a Library instance." }, { "instruction": "What is the mgxs_types attribute of a Library?", "input": "OpenMC Python API Library attribute mgxs_types", "output": "The mgxs_types attribute of a Library contains the types of cross sections in the library (e.g., ['total', 'scatter']). It's a Iterable of str value that you can access after creating a Library instance." }, { "instruction": "What is the domain_type attribute of a Library?", "input": "OpenMC Python API Library attribute domain_type", "output": "The domain_type attribute of a Library contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a Library instance." }, { "instruction": "What is the domains attribute of a Library?", "input": "OpenMC Python API Library attribute domains", "output": "The domains attribute of a Library contains the spatial domain(s) for which mgxs in the library are computed. It's a Iterable of openmc.Material, openmc.Cell, openmc.Universe or openmc.RegularMesh value that you can access after creating a Library instance." }, { "instruction": "What is the correction attribute of a Library?", "input": "OpenMC Python API Library attribute correction", "output": "The correction attribute of a Library contains apply the p0 correction to scattering matrices if set to 'p0'. It's a {'P0', None} value that you can access after creating a Library instance." }, { "instruction": "What is the scatter_format attribute of a Library?", "input": "OpenMC Python API Library attribute scatter_format", "output": "The scatter_format attribute of a Library contains representation of the angular scattering distribution (default is 'legendre'). It's a {'legendre', 'histogram'} value that you can access after creating a Library instance." }, { "instruction": "What is the legendre_order attribute of a Library?", "input": "OpenMC Python API Library attribute legendre_order", "output": "The legendre_order attribute of a Library contains the highest legendre moment in the scattering matrix; this is used if :attr:`scattermatrixxs.scatter_format` is 'legendre'. (default is 0). It's a int value that you can access after creating a Library instance." }, { "instruction": "What is the histogram_bins attribute of a Library?", "input": "OpenMC Python API Library attribute histogram_bins", "output": "The histogram_bins attribute of a Library contains the number of equally-spaced bins for the histogram representation of the angular scattering distribution; this is used if :attr:`scattermatrixxs.scatter_format` is 'histogram'. (default is 16). It's a int value that you can access after creating a Library instance." }, { "instruction": "What is the energy_groups attribute of a Library?", "input": "OpenMC Python API Library attribute energy_groups", "output": "The energy_groups attribute of a Library contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a Library instance." }, { "instruction": "What is the num_delayed_groups attribute of a Library?", "input": "OpenMC Python API Library attribute num_delayed_groups", "output": "The num_delayed_groups attribute of a Library contains number of delayed groups. It's a int value that you can access after creating a Library instance." }, { "instruction": "What is the num_polar attribute of a Library?", "input": "OpenMC Python API Library attribute num_polar", "output": "The num_polar attribute of a Library contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a Library instance." }, { "instruction": "What is the num_azimuthal attribute of a Library?", "input": "OpenMC Python API Library attribute num_azimuthal", "output": "The num_azimuthal attribute of a Library contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a Library instance." }, { "instruction": "What is the nuclides attribute of a Library?", "input": "OpenMC Python API Library attribute nuclides", "output": "The nuclides attribute of a Library contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the domain are included.. It's a Iterable of str or 'sum' value that you can access after creating a Library instance." }, { "instruction": "What is the estimator attribute of a Library?", "input": "OpenMC Python API Library attribute estimator", "output": "The estimator attribute of a Library contains the tally estimator used to compute multi-group cross sections. if none, the default for each mgxs type is used.. It's a str or None value that you can access after creating a Library instance." }, { "instruction": "What is the tally_trigger attribute of a Library?", "input": "OpenMC Python API Library attribute tally_trigger", "output": "The tally_trigger attribute of a Library contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a Library instance." }, { "instruction": "What is the all_mgxs attribute of a Library?", "input": "OpenMC Python API Library attribute all_mgxs", "output": "The all_mgxs attribute of a Library contains mgxs objects keyed by domain id and cross section type. It's a dict value that you can access after creating a Library instance." }, { "instruction": "What is the sp_filename attribute of a Library?", "input": "OpenMC Python API Library attribute sp_filename", "output": "The sp_filename attribute of a Library contains the filename of the statepoint with tally data used to the compute cross sections. It's a str value that you can access after creating a Library instance." }, { "instruction": "What is the keff attribute of a Library?", "input": "OpenMC Python API Library attribute keff", "output": "The keff attribute of a Library contains the combined keff from the statepoint file with tally data used to compute cross sections (for eigenvalue calculations only). It's a Real or None value that you can access after creating a Library instance." }, { "instruction": "What is the name attribute of a Library?", "input": "OpenMC Python API Library attribute name", "output": "The name attribute of a Library contains name of the multi-group cross section library. used as a label to identify tallies in openmc 'tallies.xml' file.. It's a str, optional value that you can access after creating a Library instance." }, { "instruction": "What is the sparse attribute of a Library?", "input": "OpenMC Python API Library attribute sparse", "output": "The sparse attribute of a Library contains whether or not the library's tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a Library instance." }, { "instruction": "How do you call the __init__() method in the Library class?", "input": "OpenMC Python API Library.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, geometry: Any, by_nuclide: Any, mgxs_types: Any, name: Any). It takes 5 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the Library class?", "input": "OpenMC Python API Library.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the geometry() method in the Library class?", "input": "OpenMC Python API Library.geometry() method signature", "output": "To call the geometry() method, use: @property def geometry(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the geometry() method in the Library class?", "input": "OpenMC Python API Library.geometry() method signature", "output": "To call the geometry() method, use: @geometry.setter def geometry(self: Any, geometry: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the Library class?", "input": "OpenMC Python API Library.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Library class?", "input": "OpenMC Python API Library.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the mgxs_types() method in the Library class?", "input": "OpenMC Python API Library.mgxs_types() method signature", "output": "To call the mgxs_types() method, use: @property def mgxs_types(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mgxs_types() method in the Library class?", "input": "OpenMC Python API Library.mgxs_types() method signature", "output": "To call the mgxs_types() method, use: @mgxs_types.setter def mgxs_types(self: Any, mgxs_types: Any). It takes 2 parameters." }, { "instruction": "How do you call the by_nuclide() method in the Library class?", "input": "OpenMC Python API Library.by_nuclide() method signature", "output": "To call the by_nuclide() method, use: @property def by_nuclide(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the by_nuclide() method in the Library class?", "input": "OpenMC Python API Library.by_nuclide() method signature", "output": "To call the by_nuclide() method, use: @by_nuclide.setter def by_nuclide(self: Any, by_nuclide: Any). It takes 2 parameters." }, { "instruction": "How do you call the domain_type() method in the Library class?", "input": "OpenMC Python API Library.domain_type() method signature", "output": "To call the domain_type() method, use: @property def domain_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the domain_type() method in the Library class?", "input": "OpenMC Python API Library.domain_type() method signature", "output": "To call the domain_type() method, use: @domain_type.setter def domain_type(self: Any, domain_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the domains() method in the Library class?", "input": "OpenMC Python API Library.domains() method signature", "output": "To call the domains() method, use: @property def domains(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the domains() method in the Library class?", "input": "OpenMC Python API Library.domains() method signature", "output": "To call the domains() method, use: @domains.setter def domains(self: Any, domains: Any). It takes 2 parameters." }, { "instruction": "How do you call the nuclides() method in the Library class?", "input": "OpenMC Python API Library.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the Library class?", "input": "OpenMC Python API Library.nuclides() method signature", "output": "To call the nuclides() method, use: @nuclides.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_groups() method in the Library class?", "input": "OpenMC Python API Library.energy_groups() method signature", "output": "To call the energy_groups() method, use: @property def energy_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_groups() method in the Library class?", "input": "OpenMC Python API Library.energy_groups() method signature", "output": "To call the energy_groups() method, use: @energy_groups.setter def energy_groups(self: Any, energy_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_delayed_groups() method in the Library class?", "input": "OpenMC Python API Library.num_delayed_groups() method signature", "output": "To call the num_delayed_groups() method, use: @property def num_delayed_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_delayed_groups() method in the Library class?", "input": "OpenMC Python API Library.num_delayed_groups() method signature", "output": "To call the num_delayed_groups() method, use: @num_delayed_groups.setter def num_delayed_groups(self: Any, num_delayed_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_polar() method in the Library class?", "input": "OpenMC Python API Library.num_polar() method signature", "output": "To call the num_polar() method, use: @property def num_polar(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_polar() method in the Library class?", "input": "OpenMC Python API Library.num_polar() method signature", "output": "To call the num_polar() method, use: @num_polar.setter def num_polar(self: Any, num_polar: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_azimuthal() method in the Library class?", "input": "OpenMC Python API Library.num_azimuthal() method signature", "output": "To call the num_azimuthal() method, use: @property def num_azimuthal(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_azimuthal() method in the Library class?", "input": "OpenMC Python API Library.num_azimuthal() method signature", "output": "To call the num_azimuthal() method, use: @num_azimuthal.setter def num_azimuthal(self: Any, num_azimuthal: Any). It takes 2 parameters." }, { "instruction": "How do you call the correction() method in the Library class?", "input": "OpenMC Python API Library.correction() method signature", "output": "To call the correction() method, use: @property def correction(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the correction() method in the Library class?", "input": "OpenMC Python API Library.correction() method signature", "output": "To call the correction() method, use: @correction.setter def correction(self: Any, correction: Any). It takes 2 parameters." }, { "instruction": "How do you call the scatter_format() method in the Library class?", "input": "OpenMC Python API Library.scatter_format() method signature", "output": "To call the scatter_format() method, use: @property def scatter_format(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scatter_format() method in the Library class?", "input": "OpenMC Python API Library.scatter_format() method signature", "output": "To call the scatter_format() method, use: @scatter_format.setter def scatter_format(self: Any, scatter_format: Any). It takes 2 parameters." }, { "instruction": "How do you call the legendre_order() method in the Library class?", "input": "OpenMC Python API Library.legendre_order() method signature", "output": "To call the legendre_order() method, use: @property def legendre_order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the legendre_order() method in the Library class?", "input": "OpenMC Python API Library.legendre_order() method signature", "output": "To call the legendre_order() method, use: @legendre_order.setter def legendre_order(self: Any, legendre_order: Any). It takes 2 parameters." }, { "instruction": "How do you call the histogram_bins() method in the Library class?", "input": "OpenMC Python API Library.histogram_bins() method signature", "output": "To call the histogram_bins() method, use: @property def histogram_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the histogram_bins() method in the Library class?", "input": "OpenMC Python API Library.histogram_bins() method signature", "output": "To call the histogram_bins() method, use: @histogram_bins.setter def histogram_bins(self: Any, histogram_bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the tally_trigger() method in the Library class?", "input": "OpenMC Python API Library.tally_trigger() method signature", "output": "To call the tally_trigger() method, use: @property def tally_trigger(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_trigger() method in the Library class?", "input": "OpenMC Python API Library.tally_trigger() method signature", "output": "To call the tally_trigger() method, use: @tally_trigger.setter def tally_trigger(self: Any, tally_trigger: Any). It takes 2 parameters." }, { "instruction": "How do you call the estimator() method in the Library class?", "input": "OpenMC Python API Library.estimator() method signature", "output": "To call the estimator() method, use: @property def estimator(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the estimator() method in the Library class?", "input": "OpenMC Python API Library.estimator() method signature", "output": "To call the estimator() method, use: @estimator.setter def estimator(self: Any, estimator: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_groups() method in the Library class?", "input": "OpenMC Python API Library.num_groups() method signature", "output": "To call the num_groups() method, use: @property def num_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the all_mgxs() method in the Library class?", "input": "OpenMC Python API Library.all_mgxs() method signature", "output": "To call the all_mgxs() method, use: @property def all_mgxs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sp_filename() method in the Library class?", "input": "OpenMC Python API Library.sp_filename() method signature", "output": "To call the sp_filename() method, use: @property def sp_filename(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the keff() method in the Library class?", "input": "OpenMC Python API Library.keff() method signature", "output": "To call the keff() method, use: @property def keff(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sparse() method in the Library class?", "input": "OpenMC Python API Library.sparse() method signature", "output": "To call the sparse() method, use: @property def sparse(self: Any). It takes 1 parameters." }, { "instruction": "What does the sparse() method do in the Library class?", "input": "OpenMC Python API Library.sparse() method", "output": "The sparse() method convert tally data from numpy arrays to scipy list of lists (lil)\n sparse matrices, and vice versa.\n\n this property may be used to reduce the amount of data in memory during\n tally data processing. the tally data will be stored as scipy lil\n matrices internally within the tally object. all tally data access\n properties and methods will return data as a dense numpy array.. It's used for library operations." }, { "instruction": "How do you call the sparse() method in the Library class?", "input": "OpenMC Python API Library.sparse() method signature", "output": "To call the sparse() method, use: @sparse.setter def sparse(self: Any, sparse: Any). It takes 2 parameters." }, { "instruction": "What does the build_library() method do in the Library class?", "input": "OpenMC Python API Library.build_library() method", "output": "The build_library() method initialize mgxs objects in each domain and for each reaction type\n in the library.\n\n this routine will populate the all_mgxs instance attribute dictionary\n with mgxs subclass objects keyed by each domain id (e.g., material ids)\n and cross section type (e.g., 'nu-fission', 'total', etc.).. It's used for library operations." }, { "instruction": "How do you call the build_library() method in the Library class?", "input": "OpenMC Python API Library.build_library() method signature", "output": "To call the build_library() method, use: def build_library(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_to_tallies_file() method do in the Library class?", "input": "OpenMC Python API Library.add_to_tallies_file() method", "output": "The add_to_tallies_file() method add all tallies from all mgxs objects to a tallies file. note: this assumes that :meth:`library.build_library` has been called. It's used for library operations." }, { "instruction": "How do you call the add_to_tallies_file() method in the Library class?", "input": "OpenMC Python API Library.add_to_tallies_file() method signature", "output": "To call the add_to_tallies_file() method, use: def add_to_tallies_file(self: Any, tallies_file: Any, merge: Any). It takes 3 parameters." }, { "instruction": "What does the tallies_file parameter do in the add_to_tallies_file() method?", "input": "OpenMC Python API Library.add_to_tallies_file() parameter tallies_file", "output": "The tallies_file parameter a tallies collection to add each mgxs' tallies to generate a 'tallies.xml' input file for openmc. It should be a openmc.Tallies value." }, { "instruction": "What does the merge parameter do in the add_to_tallies_file() method?", "input": "OpenMC Python API Library.add_to_tallies_file() parameter merge", "output": "The merge parameter indicate whether tallies should be merged when possible. defaults to true.. It should be a bool value." }, { "instruction": "What does the load_from_statepoint() method do in the Library class?", "input": "OpenMC Python API Library.load_from_statepoint() method", "output": "The load_from_statepoint() method extracts tallies in an openmc statepoint with the data needed to compute multi-group cross sections. this method is needed to compute cross section data from tallies in an openmc statepoint object. note: the statepoint must first be linked with an openmc summary object. It's used for library operations." }, { "instruction": "How do you call the load_from_statepoint() method in the Library class?", "input": "OpenMC Python API Library.load_from_statepoint() method signature", "output": "To call the load_from_statepoint() method, use: def load_from_statepoint(self: Any, statepoint: Any). It takes 2 parameters." }, { "instruction": "What does the statepoint parameter do in the load_from_statepoint() method?", "input": "OpenMC Python API Library.load_from_statepoint() parameter statepoint", "output": "The statepoint parameter an openmc statepoint object with tally data. It should be a openmc.StatePoint value." }, { "instruction": "What does the get_mgxs() method do in the Library class?", "input": "OpenMC Python API Library.get_mgxs() method", "output": "The get_mgxs() method return the mgxs object for some domain and reaction rate type. this routine searches the library for an mgxs object for the spatial domain and reaction rate type requested by the user. note: this routine must be called after the build_library() routine. It's used for library operations." }, { "instruction": "How do you call the get_mgxs() method in the Library class?", "input": "OpenMC Python API Library.get_mgxs() method signature", "output": "To call the get_mgxs() method, use: def get_mgxs(self: Any, domain: Any, mgxs_type: Any). It takes 3 parameters." }, { "instruction": "What does the domain parameter do in the get_mgxs() method?", "input": "OpenMC Python API Library.get_mgxs() parameter domain", "output": "The domain parameter the material, cell, or universe object of interest (or its id). It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh or Integral value." }, { "instruction": "What does the mgxs_type parameter do in the get_mgxs() method?", "input": "OpenMC Python API Library.get_mgxs() parameter mgxs_type", "output": "The mgxs_type parameter the type of multi-group cross section object to return; allowable values are those mgxs to the library and present in the mgxs_types attribute.. It should be a str value." }, { "instruction": "What does the get_condensed_library() method do in the Library class?", "input": "OpenMC Python API Library.get_condensed_library() method", "output": "The get_condensed_library() method construct an energy-condensed version of this library. this routine condenses each of the multi-group cross sections in the library to a coarse energy group structure. note: this routine must be called after the load_from_statepoint(...) routine loads the tallies from the statepoint into each of the cross sections. It's used for library operations." }, { "instruction": "How do you call the get_condensed_library() method in the Library class?", "input": "OpenMC Python API Library.get_condensed_library() method signature", "output": "To call the get_condensed_library() method, use: def get_condensed_library(self: Any, coarse_groups: Any). It takes 2 parameters." }, { "instruction": "What does the coarse_groups parameter do in the get_condensed_library() method?", "input": "OpenMC Python API Library.get_condensed_library() parameter coarse_groups", "output": "The coarse_groups parameter the coarse energy group structure of interest. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the get_subdomain_avg_library() method do in the Library class?", "input": "OpenMC Python API Library.get_subdomain_avg_library() method", "output": "The get_subdomain_avg_library() method construct a subdomain-averaged version of this library. this routine averages each multi-group cross section across distribcell instances. the method performs spatial homogenization to compute the scalar flux-weighted average cross section across the subdomains. note: this method is only relevant for distribcell domain types and simplys returns a deep copy of the library for all other domains types. It's used for library operations." }, { "instruction": "How do you call the get_subdomain_avg_library() method in the Library class?", "input": "OpenMC Python API Library.get_subdomain_avg_library() method signature", "output": "To call the get_subdomain_avg_library() method, use: def get_subdomain_avg_library(self: Any). It takes 1 parameters." }, { "instruction": "What does the build_hdf5_store() method do in the Library class?", "input": "OpenMC Python API Library.build_hdf5_store() method", "output": "The build_hdf5_store() method export the multi-group cross section library to an hdf5 binary file. this method constructs an hdf5 file which stores the library's multi-group cross section data. the data is stored in a hierarchy of hdf5 groups from the domain type, domain id, subdomain id (for distribcell domains), nuclides and cross section types. two datasets for the mean and standard deviation are stored for each subdomain entry in the hdf5 file. the number of groups is stored as a file attribute. note: this requires the h5py python package. It's used for library operations." }, { "instruction": "How do you call the build_hdf5_store() method in the Library class?", "input": "OpenMC Python API Library.build_hdf5_store() method signature", "output": "To call the build_hdf5_store() method, use: def build_hdf5_store(self: Any, filename: Any, directory: Any, subdomains: Any, nuclides: Any, xs_type: Any, row_column: Any, libver: Any). It takes 8 parameters." }, { "instruction": "What does the filename parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API Library.build_hdf5_store() parameter filename", "output": "The filename parameter filename for the hdf5 file. defaults to 'mgxs.h5'.. It should be a str value." }, { "instruction": "What does the directory parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API Library.build_hdf5_store() parameter directory", "output": "The directory parameter directory for the hdf5 file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the subdomains parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API Library.build_hdf5_store() parameter subdomains", "output": "The subdomains parameter report all subdomains or the average of all subdomain cross sections in the report. defaults to 'all'.. It should be a {'all', 'avg'} value." }, { "instruction": "What does the nuclides parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API Library.build_hdf5_store() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the report. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will report the cross sections for all nuclides in the spatial domain. the special string 'sum' will report the cross sections summed over all nuclides. defaults to 'all'.. It should be a {'all', 'sum'} value." }, { "instruction": "What does the xs_type parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API Library.build_hdf5_store() parameter xs_type", "output": "The xs_type parameter store the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the row_column parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API Library.build_hdf5_store() parameter row_column", "output": "The row_column parameter store scattering matrices indexed first by incoming group and second by outgoing group ('inout'), or vice versa ('outin'). defaults to 'inout'.. It should be a {'inout', 'outin'} value." }, { "instruction": "What does the libver parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API Library.build_hdf5_store() parameter libver", "output": "The libver parameter compatibility mode for the hdf5 file. 'latest' will produce files that are less backwards compatible but have performance benefits.. It should be a {'earliest', 'latest'} value." }, { "instruction": "What does the dump_to_file() method do in the Library class?", "input": "OpenMC Python API Library.dump_to_file() method", "output": "The dump_to_file() method store this library object in a pickle binary file. It's used for library operations." }, { "instruction": "How do you call the dump_to_file() method in the Library class?", "input": "OpenMC Python API Library.dump_to_file() method signature", "output": "To call the dump_to_file() method, use: def dump_to_file(self: Any, filename: Any, directory: Any). It takes 3 parameters." }, { "instruction": "What does the filename parameter do in the dump_to_file() method?", "input": "OpenMC Python API Library.dump_to_file() parameter filename", "output": "The filename parameter filename for the pickle file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the directory parameter do in the dump_to_file() method?", "input": "OpenMC Python API Library.dump_to_file() parameter directory", "output": "The directory parameter directory for the pickle file. defaults to 'mgxs'. see also -------- library.load_from_file(filename, directory). It should be a str value." }, { "instruction": "What does the load_from_file() method do in the Library class?", "input": "OpenMC Python API Library.load_from_file() method", "output": "The load_from_file() method load a library object from a pickle binary file. It's used for library operations." }, { "instruction": "How do you call the load_from_file() method in the Library class?", "input": "OpenMC Python API Library.load_from_file() method signature", "output": "To call the load_from_file() method, use: @staticmethod def load_from_file(filename: Any, directory: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the load_from_file() method?", "input": "OpenMC Python API Library.load_from_file() parameter filename", "output": "The filename parameter filename for the pickle file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the directory parameter do in the load_from_file() method?", "input": "OpenMC Python API Library.load_from_file() parameter directory", "output": "The directory parameter directory for the pickle file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the get_xsdata() method do in the Library class?", "input": "OpenMC Python API Library.get_xsdata() method", "output": "The get_xsdata() method generates an openmc.xsdata object describing a multi-group cross section dataset for writing to an openmc.mgxslibrary object. note that this method does not build an xsdata object with nested temperature tables. the temperature of each xsdata object will be left at the default value of 294k. It's used for library operations." }, { "instruction": "How do you call the get_xsdata() method in the Library class?", "input": "OpenMC Python API Library.get_xsdata() method signature", "output": "To call the get_xsdata() method, use: def get_xsdata(self: Any, domain: Any, xsdata_name: Any, nuclide: Any, xs_type: Any, subdomain: Any, apply_domain_chi: Any). It takes 7 parameters." }, { "instruction": "What does the domain parameter do in the get_xsdata() method?", "input": "OpenMC Python API Library.get_xsdata() parameter domain", "output": "The domain parameter the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the xsdata_name parameter do in the get_xsdata() method?", "input": "OpenMC Python API Library.get_xsdata() parameter xsdata_name", "output": "The xsdata_name parameter name to apply to the \"xsdata\" entry produced by this method. It should be a str value." }, { "instruction": "What does the nuclide parameter do in the get_xsdata() method?", "input": "OpenMC Python API Library.get_xsdata() parameter nuclide", "output": "The nuclide parameter a nuclide name string (e.g., 'u235'). defaults to 'total' to obtain a material-wise macroscopic cross section.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the get_xsdata() method?", "input": "OpenMC Python API Library.get_xsdata() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'. if the library object is not tallied by nuclide this will be set to 'macro' regardless.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the get_xsdata() method?", "input": "OpenMC Python API Library.get_xsdata() parameter subdomain", "output": "The subdomain parameter this parameter is not used unless using a mesh domain. in that case, the subdomain is an [i,j,k] index (1-based indexing) of the mesh cell of interest in the openmc.regularmesh object. note: this parameter currently only supports subdomains within a mesh, and not the subdomains of a distribcell.. It should be a iterable of int value." }, { "instruction": "What does the apply_domain_chi parameter do in the get_xsdata() method?", "input": "OpenMC Python API Library.get_xsdata() parameter apply_domain_chi", "output": "The apply_domain_chi parameter this parameter sets whether (true) or not (false) the domain-averaged values of chi, chi-prompt, and chi-delayed are to be applied to each of the nuclide-dependent fission energy spectra of a domain. in effect, if this is true, then every nuclide in the domain receives the same flux-weighted chi. this is useful for downstream multigroup solvers that precompute a material-specific chi before the transport solve provides group-wise fluxes. defaults to false.. It should be a bool value." }, { "instruction": "What does the get_xsdata() method return in the Library class?", "input": "OpenMC Python API Library.get_xsdata() return value", "output": "The get_xsdata() method returns multi-group cross section dataset object.. The return type is openmc.XSdata." }, { "instruction": "What does the create_mg_library() method do in the Library class?", "input": "OpenMC Python API Library.create_mg_library() method", "output": "The create_mg_library() method creates an openmc.mgxslibrary object to contain the mgxs data for the multi-group mode of openmc. note that this library will not make use of nested temperature tables. every dataset in the library will be treated as if it was at the same default temperature. It's used for library operations." }, { "instruction": "How do you call the create_mg_library() method in the Library class?", "input": "OpenMC Python API Library.create_mg_library() method signature", "output": "To call the create_mg_library() method, use: def create_mg_library(self: Any, xs_type: Any, xsdata_names: Any, apply_domain_chi: Any). It takes 4 parameters." }, { "instruction": "What does the xs_type parameter do in the create_mg_library() method?", "input": "OpenMC Python API Library.create_mg_library() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'. if the library object is not tallied by nuclide this will be set to 'macro' regardless.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the xsdata_names parameter do in the create_mg_library() method?", "input": "OpenMC Python API Library.create_mg_library() parameter xsdata_names", "output": "The xsdata_names parameter list of names to apply to the \"xsdata\" entries in the resultant mgxs data file. defaults to 'set1', 'set2', .... It should be a Iterable of str value." }, { "instruction": "What does the apply_domain_chi parameter do in the create_mg_library() method?", "input": "OpenMC Python API Library.create_mg_library() parameter apply_domain_chi", "output": "The apply_domain_chi parameter this parameter sets whether (true) or not (false) the domain-averaged values of chi, chi-prompt, and chi-delayed are to be applied to each of the nuclide-dependent fission energy spectra of a domain. in effect, if this is true, then every nuclide in the domain receives the same flux-weighted chi. this is useful for downstream multigroup solvers that precompute a material-specific chi before the transport solve provides group-wise fluxes. defaults to false.. It should be a bool value." }, { "instruction": "What does the create_mg_library() method return in the Library class?", "input": "OpenMC Python API Library.create_mg_library() return value", "output": "The create_mg_library() method returns multi-group cross section file that is ready to be printed to the file of choice by the user.. The return type is openmc.MGXSLibrary." }, { "instruction": "What does the create_mg_mode() method do in the Library class?", "input": "OpenMC Python API Library.create_mg_mode() method", "output": "The create_mg_mode() method creates an openmc.mgxslibrary object to contain the mgxs data for the multi-group mode of openmc as well as the associated openmc.materials and openmc.geometry objects. the created geometry is the same as that used to generate the mgxs data, with the only differences being modifications to point to newly-created materials which point to the multi-group data. this method only creates a macroscopic mgxs library even if nuclidic tallies are specified in the library. note that this library will not make use of nested temperature tables. every dataset in the library will be treated as if it was at the same default temperature. It's used for library operations." }, { "instruction": "How do you call the create_mg_mode() method in the Library class?", "input": "OpenMC Python API Library.create_mg_mode() method signature", "output": "To call the create_mg_mode() method, use: def create_mg_mode(self: Any, xsdata_names: Any, bc: Any, apply_domain_chi: Any). It takes 4 parameters." }, { "instruction": "What does the xsdata_names parameter do in the create_mg_mode() method?", "input": "OpenMC Python API Library.create_mg_mode() parameter xsdata_names", "output": "The xsdata_names parameter list of names to apply to the \"xsdata\" entries in the resultant mgxs data file. defaults to 'set1', 'set2', .... It should be a Iterable of str value." }, { "instruction": "What does the bc parameter do in the create_mg_mode() method?", "input": "OpenMC Python API Library.create_mg_mode() parameter bc", "output": "The bc parameter boundary conditions for each of the four faces of a rectangle (if applying to a 2d mesh) or six faces of a parallelepiped (if applying to a 3d mesh) provided in the following order: [x min, x max, y min, y max, z min, z max]. 2-d cells do not contain the z min and z max entries.. It should be a iterable of {'reflective', 'periodic', 'transmission', or 'vacuum'} value." }, { "instruction": "What does the apply_domain_chi parameter do in the create_mg_mode() method?", "input": "OpenMC Python API Library.create_mg_mode() parameter apply_domain_chi", "output": "The apply_domain_chi parameter this parameter sets whether (true) or not (false) the domain-averaged values of chi, chi-prompt, and chi-delayed are to be applied to each of the nuclide-dependent fission energy spectra of a domain. in effect, if this is true, then every nuclide in the domain receives the same flux-weighted chi. this is useful for downstream multigroup solvers that precompute a material-specific chi before the transport solve provides group-wise fluxes. defaults to false.. It should be a bool value." }, { "instruction": "What does the create_mg_mode() method return in the Library class?", "input": "OpenMC Python API Library.create_mg_mode() return value", "output": "The create_mg_mode() method returns multi-group cross section file that is ready to be printed to the file of choice by the user.. The return type is openmc.MGXSLibrary." }, { "instruction": "What does the create_mg_mode() method return in the Library class?", "input": "OpenMC Python API Library.create_mg_mode() return value", "output": "The create_mg_mode() method returns materials file ready to be printed with all the macroscopic data present within this library.. The return type is openmc.Materials." }, { "instruction": "What does the create_mg_mode() method return in the Library class?", "input": "OpenMC Python API Library.create_mg_mode() return value", "output": "The create_mg_mode() method returns materials file ready to be printed with all the macroscopic data present within this library.. The return type is openmc.Geometry." }, { "instruction": "What does the check_library_for_openmc_mgxs() method do in the Library class?", "input": "OpenMC Python API Library.check_library_for_openmc_mgxs() method", "output": "The check_library_for_openmc_mgxs() method this routine will check the mgxs types within a library\n to ensure the mgxs types provided can be used to create\n a mgxs library for openmc's multi-group mode.\n\n the rules to check include:\n\n - either total or transport must be present.\n\n - both can be available if one wants, but we should\n use whatever corresponds to library.correction (if p0: transport)\n\n - absorption is required.\n - a nu-fission cross section and chi values are not required as a\n fixed source problem could be the target.\n - fission and kappa-fission are not required as they are only\n needed to support tallies the user may wish to request.\n - scattering multiplicity should have been tallied for increased model\n accuracy, either using a multiplicity or scatter and nu-scatter matrix\n tally.\n\n see also\n --------\n library.create_mg_library()\n library.create_mg_mode(). It's used for library operations." }, { "instruction": "How do you call the check_library_for_openmc_mgxs() method in the Library class?", "input": "OpenMC Python API Library.check_library_for_openmc_mgxs() method signature", "output": "To call the check_library_for_openmc_mgxs() method, use: def check_library_for_openmc_mgxs(self: Any). It takes 1 parameters." }, { "instruction": "What is the MDGXS class in OpenMC's Python API?", "input": "OpenMC Python API MDGXS class", "output": "The MDGXS class represents an abstract multi-delayed-group cross section for some energy and delayed group structures within some spatial domain. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed-group cross sections for downstream neutronics calculations. note: users should instantiate the subclasses of this abstract class. It provides 14 methods and 0 properties for working with mdgxs data in OpenMC." }, { "instruction": "What does the MDGXS class do in OpenMC's Python API?", "input": "OpenMC Python API MDGXS class description", "output": "The MDGXS class an abstract multi-delayed-group cross section for some energy and delayed group structures within some spatial domain. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed-group cross sections for downstream neutronics calculations. note: users should instantiate the subclasses of this abstract class. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter domain", "output": "When creating a MDGXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter domain_type", "output": "When creating a MDGXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the energy_groups parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter energy_groups", "output": "When creating a MDGXS, the energy_groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter by_nuclide", "output": "When creating a MDGXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter name", "output": "When creating a MDGXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter delayed_groups", "output": "When creating a MDGXS, the delayed_groups parameter specifies delayed groups to filter out the xs. It should be a list of int, optional value." }, { "instruction": "What does the num_polar parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter num_polar", "output": "When creating a MDGXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a MDGXS?", "input": "OpenMC Python API MDGXS constructor parameter num_azimuthal", "output": "When creating a MDGXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute name", "output": "The name attribute of a MDGXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a MDGXS instance." }, { "instruction": "What is the rxn_type attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute rxn_type", "output": "The rxn_type attribute of a MDGXS contains reaction type (e.g., 'chi-delayed', 'beta', etc.). It's a str value that you can access after creating a MDGXS instance." }, { "instruction": "What is the by_nuclide attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute by_nuclide", "output": "The by_nuclide attribute of a MDGXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a MDGXS instance." }, { "instruction": "What is the domain attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute domain", "output": "The domain attribute of a MDGXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a MDGXS instance." }, { "instruction": "What is the domain_type attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute domain_type", "output": "The domain_type attribute of a MDGXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a MDGXS instance." }, { "instruction": "What is the energy_groups attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute energy_groups", "output": "The energy_groups attribute of a MDGXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a MDGXS instance." }, { "instruction": "What is the delayed_groups attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute delayed_groups", "output": "The delayed_groups attribute of a MDGXS contains delayed groups to filter out the xs. It's a list of int, optional value that you can access after creating a MDGXS instance." }, { "instruction": "What is the num_polar attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute num_polar", "output": "The num_polar attribute of a MDGXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a MDGXS instance." }, { "instruction": "What is the num_azimuthal attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a MDGXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a MDGXS instance." }, { "instruction": "What is the tally_trigger attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute tally_trigger", "output": "The tally_trigger attribute of a MDGXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a MDGXS instance." }, { "instruction": "What is the scores attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute scores", "output": "The scores attribute of a MDGXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a MDGXS instance." }, { "instruction": "What is the filters attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute filters", "output": "The filters attribute of a MDGXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a MDGXS instance." }, { "instruction": "What is the tally_keys attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute tally_keys", "output": "The tally_keys attribute of a MDGXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a MDGXS instance." }, { "instruction": "What is the estimator attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute estimator", "output": "The estimator attribute of a MDGXS contains the tally estimator used to compute the multi-group cross section. It's a {'tracklength', 'analog'} value that you can access after creating a MDGXS instance." }, { "instruction": "What is the tallies attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute tallies", "output": "The tallies attribute of a MDGXS contains openmc tallies needed to compute the multi-group cross section. It's a dict value that you can access after creating a MDGXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a MDGXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a MDGXS instance." }, { "instruction": "What is the xs_tally attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute xs_tally", "output": "The xs_tally attribute of a MDGXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a MDGXS instance." }, { "instruction": "What is the num_subdomains attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute num_subdomains", "output": "The num_subdomains attribute of a MDGXS contains the number of subdomains is unity for 'material', 'cell', and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file) and the number of mesh cells for 'mesh' domain types.. It's a int value that you can access after creating a MDGXS instance." }, { "instruction": "What is the num_nuclides attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute num_nuclides", "output": "The num_nuclides attribute of a MDGXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a MDGXS instance." }, { "instruction": "What is the nuclides attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute nuclides", "output": "The nuclides attribute of a MDGXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a MDGXS instance." }, { "instruction": "What is the sparse attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute sparse", "output": "The sparse attribute of a MDGXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a MDGXS instance." }, { "instruction": "What is the loaded_sp attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute loaded_sp", "output": "The loaded_sp attribute of a MDGXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a MDGXS instance." }, { "instruction": "What is the derived attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute derived", "output": "The derived attribute of a MDGXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a MDGXS instance." }, { "instruction": "What is the mgxs_type attribute of a MDGXS?", "input": "OpenMC Python API MDGXS attribute mgxs_type", "output": "The mgxs_type attribute of a MDGXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a MDGXS instance." }, { "instruction": "How do you call the __init__() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, delayed_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the _dont_squeeze() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS._dont_squeeze() method", "output": "The _dont_squeeze() method create a tuple of axes which should not be removed during the get_xs\n process. It's used for mdgxs operations." }, { "instruction": "How do you call the _dont_squeeze() method in the MDGXS class?", "input": "OpenMC Python API MDGXS._dont_squeeze() method signature", "output": "To call the _dont_squeeze() method, use: @property def _dont_squeeze(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the delayed_groups() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.delayed_groups() method signature", "output": "To call the delayed_groups() method, use: @property def delayed_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the delayed_groups() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.delayed_groups() method signature", "output": "To call the delayed_groups() method, use: @delayed_groups.setter def delayed_groups(self: Any, delayed_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_delayed_groups() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.num_delayed_groups() method signature", "output": "To call the num_delayed_groups() method, use: @property def num_delayed_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_mgxs() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_mgxs() method", "output": "The get_mgxs() method return a mdgxs subclass object for some energy group structure within some spatial domain for some reaction type. this is a factory method which can be used to quickly create mdgxs subclass objects for various reaction types. It's used for mdgxs operations." }, { "instruction": "How do you call the get_mgxs() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_mgxs() method signature", "output": "To call the get_mgxs() method, use: @staticmethod def get_mgxs(mdgxs_type: Any, domain: Any, domain_type: Any, energy_groups: Any, delayed_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "What does the mdgxs_type parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter mdgxs_type", "output": "The mdgxs_type parameter the type of multi-delayed-group cross section object to return. It should be a {'delayed-nu-fission', 'chi-delayed', 'beta', 'decay-rate', 'delayed-nu-fission matrix'} value." }, { "instruction": "What does the domain parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter domain", "output": "The domain parameter openmc.regularmesh the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or value." }, { "instruction": "What does the domain_type parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter domain_type", "output": "The domain_type parameter the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the energy_groups parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter energy_groups", "output": "The energy_groups parameter the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter by_nuclide", "output": "The by_nuclide parameter if true, computes cross sections for each nuclide in domain. defaults to false. It should be a bool value." }, { "instruction": "What does the name parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter name", "output": "The name parameter name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file. defaults to the empty string.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter delayed_groups", "output": "The delayed_groups parameter delayed groups to filter out the xs. It should be a list of int, optional value." }, { "instruction": "What does the num_polar parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter num_polar", "output": "The num_polar parameter number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do in the get_mgxs() method?", "input": "OpenMC Python API MDGXS.get_mgxs() parameter num_azimuthal", "output": "The num_azimuthal parameter number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the get_xs() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_xs() method", "output": "The get_xs() method returns an array of multi-delayed-group cross sections. this method constructs a 4d numpy array for the requested multi-delayed-group cross section data for one or more subdomains (1st dimension), delayed groups (2nd demension), energy groups (3rd dimension), and nuclides (4th dimension). It's used for mdgxs operations." }, { "instruction": "How do you call the get_xs() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, groups: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, value: Any, delayed_groups: Any, squeeze: Any). It takes 9 parameters." }, { "instruction": "What does the groups parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the delayed_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter delayed_groups", "output": "The delayed_groups parameter delayed groups of interest. defaults to 'all'.. It should be a list of int or 'all' value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API MDGXS.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_slice() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_slice() method", "output": "The get_slice() method build a sliced mdgxs for the specified nuclides, energy groups, and delayed groups. this method constructs a new mdgxs to encapsulate a subset of the data represented by this mdgxs. the subset of data to include in the tally slice is determined by the nuclides, energy groups, delayed groups specified in the input parameters. It's used for mdgxs operations." }, { "instruction": "How do you call the get_slice() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, nuclides: Any, groups: Any, delayed_groups: Any). It takes 4 parameters." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API MDGXS.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the groups parameter do in the get_slice() method?", "input": "OpenMC Python API MDGXS.get_slice() parameter groups", "output": "The groups parameter a list of energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the delayed_groups parameter do in the get_slice() method?", "input": "OpenMC Python API MDGXS.get_slice() parameter delayed_groups", "output": "The delayed_groups parameter a list of delayed group indices (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the merge() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS.merge() method", "output": "The merge() method merge another mgxs with this one mgxs are only mergeable if their energy groups and nuclides are either identical or mutually exclusive. if results have been loaded from a statepoint, then mgxs are only mergeable along one and only one of energy groups or nuclides. It's used for mdgxs operations." }, { "instruction": "How do you call the merge() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API MDGXS.merge() parameter other", "output": "The other parameter mdgxs to merge with this one. It should be a openmc.mgxs.MDGXS value." }, { "instruction": "What does the merge() method return in the MDGXS class?", "input": "OpenMC Python API MDGXS.merge() return value", "output": "The merge() method returns merged mdgxs. The return type is openmc.mgxs.MDGXS." }, { "instruction": "What does the print_xs() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS.print_xs() method", "output": "The print_xs() method print a string representation for the multi-group cross section. It's used for mdgxs operations." }, { "instruction": "How do you call the print_xs() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.print_xs() method signature", "output": "To call the print_xs() method, use: def print_xs(self: Any, subdomains: Any, nuclides: Any, xs_type: Any). It takes 4 parameters." }, { "instruction": "What does the subdomains parameter do in the print_xs() method?", "input": "OpenMC Python API MDGXS.print_xs() parameter subdomains", "output": "The subdomains parameter the subdomain ids of the cross sections to include in the report. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the print_xs() method?", "input": "OpenMC Python API MDGXS.print_xs() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the report. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will report the cross sections for all nuclides in the spatial domain. the special string 'sum' will report the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the print_xs() method?", "input": "OpenMC Python API MDGXS.print_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the export_xs_data() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS.export_xs_data() method", "output": "The export_xs_data() method export the multi-delayed-group cross section data to a file. this method leverages the functionality in the pandas library to export the multi-group cross section data in a variety of output file formats for storage and/or post-processing. It's used for mdgxs operations." }, { "instruction": "How do you call the export_xs_data() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.export_xs_data() method signature", "output": "To call the export_xs_data() method, use: def export_xs_data(self: Any, filename: Any, directory: Any, format: Any, groups: Any, xs_type: Any, delayed_groups: Any). It takes 7 parameters." }, { "instruction": "What does the filename parameter do in the export_xs_data() method?", "input": "OpenMC Python API MDGXS.export_xs_data() parameter filename", "output": "The filename parameter filename for the exported file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the directory parameter do in the export_xs_data() method?", "input": "OpenMC Python API MDGXS.export_xs_data() parameter directory", "output": "The directory parameter directory for the exported file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the format parameter do in the export_xs_data() method?", "input": "OpenMC Python API MDGXS.export_xs_data() parameter format", "output": "The format parameter the format for the exported data file. defaults to 'csv'.. It should be a {'csv', 'excel', 'pickle', 'latex'} value." }, { "instruction": "What does the groups parameter do in the export_xs_data() method?", "input": "OpenMC Python API MDGXS.export_xs_data() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the xs_type parameter do in the export_xs_data() method?", "input": "OpenMC Python API MDGXS.export_xs_data() parameter xs_type", "output": "The xs_type parameter store the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the delayed_groups parameter do in the export_xs_data() method?", "input": "OpenMC Python API MDGXS.export_xs_data() parameter delayed_groups", "output": "The delayed_groups parameter delayed groups of interest. defaults to 'all'.. It should be a list of int or 'all' value." }, { "instruction": "What does the get_pandas_dataframe() method do in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method build a pandas dataframe for the mdgxs data. this method leverages :meth:`openmc.tally.get_pandas_dataframe`, but renames the columns with terminology appropriate for cross section data. It's used for mdgxs operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the MDGXS class?", "input": "OpenMC Python API MDGXS.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, groups: Any, nuclides: Any, xs_type: Any, paths: Any, delayed_groups: Any). It takes 6 parameters." }, { "instruction": "What does the groups parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MDGXS.get_pandas_dataframe() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MDGXS.get_pandas_dataframe() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the dataframe. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will include the cross sections for all nuclides in the spatial domain. the special string 'sum' will include the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MDGXS.get_pandas_dataframe() parameter xs_type", "output": "The xs_type parameter return macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the paths parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MDGXS.get_pandas_dataframe() parameter paths", "output": "The paths parameter construct columns for distribcell tally filters (default is true). the geometric information in the summary object is embedded into a multi-index column with a geometric \"path\" to each distribcell instance.. It should be a bool, optional value." }, { "instruction": "What does the delayed_groups parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MDGXS.get_pandas_dataframe() parameter delayed_groups", "output": "The delayed_groups parameter delayed groups of interest. defaults to 'all'.. It should be a list of int or 'all' value." }, { "instruction": "What is the ChiDelayed class in OpenMC's Python API?", "input": "OpenMC Python API ChiDelayed class", "output": "The ChiDelayed class represents the delayed fission spectrum. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`chidelayed.energy_groups` and :attr:`chidelayed.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`chidelayed.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`chidelayed.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the delayed fission spectrum is calculated as: .. math:: \\begin{aligned} \\langle \\nu^d \\sigma_{f,g' \\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\chi_g^d &= \\frac{\\langle \\nu^d \\sigma_{f,g' \\rightarrow g} \\phi \\rangle} {\\langle \\nu^d \\sigma_f \\phi \\rangle} \\end{aligned}. It provides 10 methods and 0 properties for working with chidelayed data in OpenMC." }, { "instruction": "What does the ChiDelayed class do in OpenMC's Python API?", "input": "OpenMC Python API ChiDelayed class description", "output": "The ChiDelayed class the delayed fission spectrum. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`chidelayed.energy_groups` and :attr:`chidelayed.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`chidelayed.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`chidelayed.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the delayed fission spectrum is calculated as: .. math:: \\begin{aligned} \\langle \\nu^d \\sigma_{f,g' \\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\chi_g^d &= \\frac{\\langle \\nu^d \\sigma_{f,g' \\rightarrow g} \\phi \\rangle} {\\langle \\nu^d \\sigma_f \\phi \\rangle} \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter domain", "output": "When creating a ChiDelayed, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter domain_type", "output": "When creating a ChiDelayed, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter groups", "output": "When creating a ChiDelayed, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter by_nuclide", "output": "When creating a ChiDelayed, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter name", "output": "When creating a ChiDelayed, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter delayed_groups", "output": "When creating a ChiDelayed, the delayed_groups parameter specifies delayed groups to filter out the xs. It should be a list of int value." }, { "instruction": "What does the num_polar parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter num_polar", "output": "When creating a ChiDelayed, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a ChiDelayed?", "input": "OpenMC Python API ChiDelayed constructor parameter num_azimuthal", "output": "When creating a ChiDelayed, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute name", "output": "The name attribute of a ChiDelayed contains name of the multi-group cross section. It's a str, optional value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the rxn_type attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute rxn_type", "output": "The rxn_type attribute of a ChiDelayed contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the by_nuclide attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute by_nuclide", "output": "The by_nuclide attribute of a ChiDelayed contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the domain attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute domain", "output": "The domain attribute of a ChiDelayed contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the domain_type attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute domain_type", "output": "The domain_type attribute of a ChiDelayed contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the energy_groups attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute energy_groups", "output": "The energy_groups attribute of a ChiDelayed contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the delayed_groups attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute delayed_groups", "output": "The delayed_groups attribute of a ChiDelayed contains delayed groups to filter out the xs. It's a list of int value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the num_polar attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute num_polar", "output": "The num_polar attribute of a ChiDelayed contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the num_azimuthal attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute num_azimuthal", "output": "The num_azimuthal attribute of a ChiDelayed contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the tally_trigger attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute tally_trigger", "output": "The tally_trigger attribute of a ChiDelayed contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the scores attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute scores", "output": "The scores attribute of a ChiDelayed contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the filters attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute filters", "output": "The filters attribute of a ChiDelayed contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the tally_keys attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute tally_keys", "output": "The tally_keys attribute of a ChiDelayed contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the estimator attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute estimator", "output": "The estimator attribute of a ChiDelayed contains the tally estimator used to compute the multi-group cross section. It's a 'analog' value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the tallies attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute tallies", "output": "The tallies attribute of a ChiDelayed contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`chidelayed.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the rxn_rate_tally attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a ChiDelayed contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the xs_tally attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute xs_tally", "output": "The xs_tally attribute of a ChiDelayed contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the num_subdomains attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute num_subdomains", "output": "The num_subdomains attribute of a ChiDelayed contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the num_nuclides attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute num_nuclides", "output": "The num_nuclides attribute of a ChiDelayed contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the nuclides attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute nuclides", "output": "The nuclides attribute of a ChiDelayed contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the sparse attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute sparse", "output": "The sparse attribute of a ChiDelayed contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the loaded_sp attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute loaded_sp", "output": "The loaded_sp attribute of a ChiDelayed contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the derived attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute derived", "output": "The derived attribute of a ChiDelayed contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a ChiDelayed instance." }, { "instruction": "What is the mgxs_type attribute of a ChiDelayed?", "input": "OpenMC Python API ChiDelayed attribute mgxs_type", "output": "The mgxs_type attribute of a ChiDelayed contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a ChiDelayed instance." }, { "instruction": "How do you call the __init__() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, delayed_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "How do you call the scores() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_keys() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.tally_keys() method signature", "output": "To call the tally_keys() method, use: @property def tally_keys(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_homogenized_mgxs() method do in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.get_homogenized_mgxs() method", "output": "The get_homogenized_mgxs() method construct a homogenized mgxs with other mgxs objects. this method constructs a new mgxs object that is the flux-weighted combination of two mgxs objects. it is equivalent to what one would obtain if the tally spatial domain were designed to encompass the individual domains for both mgxs objects. It's used for chidelayed operations." }, { "instruction": "How do you call the get_homogenized_mgxs() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.get_homogenized_mgxs() method signature", "output": "To call the get_homogenized_mgxs() method, use: def get_homogenized_mgxs(self: Any, other_mgxs: Any). It takes 2 parameters." }, { "instruction": "What does the other_mgxs parameter do in the get_homogenized_mgxs() method?", "input": "OpenMC Python API ChiDelayed.get_homogenized_mgxs() parameter other_mgxs", "output": "The other_mgxs parameter the mgxs to homogenize with this one.. It should be a openmc.mgxs.MGXS or Iterable of openmc.mgxs.MGXS value." }, { "instruction": "What does the get_slice() method do in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.get_slice() method", "output": "The get_slice() method build a sliced chidelayed for the specified nuclides and energy groups. this method constructs a new mgxs to encapsulate a subset of the data represented by this mgxs. the subset of data to include in the tally slice is determined by the nuclides and energy groups specified in the input parameters. It's used for chidelayed operations." }, { "instruction": "How do you call the get_slice() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, nuclides: Any, groups: Any, delayed_groups: Any). It takes 4 parameters." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API ChiDelayed.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the groups parameter do in the get_slice() method?", "input": "OpenMC Python API ChiDelayed.get_slice() parameter groups", "output": "The groups parameter a list of energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of Integral value." }, { "instruction": "What does the delayed_groups parameter do in the get_slice() method?", "input": "OpenMC Python API ChiDelayed.get_slice() parameter delayed_groups", "output": "The delayed_groups parameter a list of delayed group indices (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the merge() method do in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.merge() method", "output": "The merge() method merge another chidelayed with this one if results have been loaded from a statepoint, then chidelayed are only mergeable along one and only one of energy groups or nuclides. It's used for chidelayed operations." }, { "instruction": "How do you call the merge() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API ChiDelayed.merge() parameter other", "output": "The other parameter mgxs to merge with this one. It should be a openmc.mdgxs.MGXS value." }, { "instruction": "What does the merge() method return in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.merge() return value", "output": "The merge() method returns merged mdgxs. The return type is openmc.mgxs.MDGXS." }, { "instruction": "What does the get_xs() method do in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.get_xs() method", "output": "The get_xs() method returns an array of the delayed fission spectrum. this method constructs a 4d numpy array for the requested multi-delayed-group cross section data for one or more subdomains (1st dimension), delayed groups (2nd demension), energy groups (3rd dimension), and nuclides (4th dimension). It's used for chidelayed operations." }, { "instruction": "How do you call the get_xs() method in the ChiDelayed class?", "input": "OpenMC Python API ChiDelayed.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, groups: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, value: Any, delayed_groups: Any, squeeze: Any). It takes 9 parameters." }, { "instruction": "What does the groups parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the delayed_groups parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter delayed_groups", "output": "The delayed_groups parameter delayed groups of interest. defaults to 'all'.. It should be a list of int or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter xs_type", "output": "The xs_type parameter this parameter is not relevant for chi but is included here to mirror the parent mgxs.get_xs(...) class method. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API ChiDelayed.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What is the DelayedNuFissionXS class in OpenMC's Python API?", "input": "OpenMC Python API DelayedNuFissionXS class", "output": "The DelayedNuFissionXS class represents a fission delayed neutron production multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group fission neutron production cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`delayednufissionxs.energy_groups` and :attr:`delayednufissionxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`delayednufissionxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`delayednufissionxs.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the fission delayed neutron production cross section is calculated as: .. math:: \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\nu^d \\sigma_f (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. It provides 1 methods and 0 properties for working with delayednufissionxs data in OpenMC." }, { "instruction": "What does the DelayedNuFissionXS class do in OpenMC's Python API?", "input": "OpenMC Python API DelayedNuFissionXS class description", "output": "The DelayedNuFissionXS class a fission delayed neutron production multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group fission neutron production cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`delayednufissionxs.energy_groups` and :attr:`delayednufissionxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`delayednufissionxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`delayednufissionxs.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the fission delayed neutron production cross section is calculated as: .. math:: \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\nu^d \\sigma_f (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter domain", "output": "When creating a DelayedNuFissionXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter domain_type", "output": "When creating a DelayedNuFissionXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter groups", "output": "When creating a DelayedNuFissionXS, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter by_nuclide", "output": "When creating a DelayedNuFissionXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter name", "output": "When creating a DelayedNuFissionXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter delayed_groups", "output": "When creating a DelayedNuFissionXS, the delayed_groups parameter specifies delayed groups to filter out the xs. It should be a list of int value." }, { "instruction": "What does the num_polar parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter num_polar", "output": "When creating a DelayedNuFissionXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS constructor parameter num_azimuthal", "output": "When creating a DelayedNuFissionXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute name", "output": "The name attribute of a DelayedNuFissionXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the rxn_type attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute rxn_type", "output": "The rxn_type attribute of a DelayedNuFissionXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the by_nuclide attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute by_nuclide", "output": "The by_nuclide attribute of a DelayedNuFissionXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the domain attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute domain", "output": "The domain attribute of a DelayedNuFissionXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the domain_type attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute domain_type", "output": "The domain_type attribute of a DelayedNuFissionXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the energy_groups attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute energy_groups", "output": "The energy_groups attribute of a DelayedNuFissionXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the delayed_groups attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute delayed_groups", "output": "The delayed_groups attribute of a DelayedNuFissionXS contains delayed groups to filter out the xs. It's a list of int value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the num_polar attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute num_polar", "output": "The num_polar attribute of a DelayedNuFissionXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the num_azimuthal attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a DelayedNuFissionXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the tally_trigger attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute tally_trigger", "output": "The tally_trigger attribute of a DelayedNuFissionXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the scores attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute scores", "output": "The scores attribute of a DelayedNuFissionXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the filters attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute filters", "output": "The filters attribute of a DelayedNuFissionXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the tally_keys attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute tally_keys", "output": "The tally_keys attribute of a DelayedNuFissionXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the estimator attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute estimator", "output": "The estimator attribute of a DelayedNuFissionXS contains the tally estimator used to compute the multi-group cross section. It's a {'tracklength', 'analog'} value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the tallies attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute tallies", "output": "The tallies attribute of a DelayedNuFissionXS contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`delayednufissionxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a DelayedNuFissionXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the xs_tally attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute xs_tally", "output": "The xs_tally attribute of a DelayedNuFissionXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the num_subdomains attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute num_subdomains", "output": "The num_subdomains attribute of a DelayedNuFissionXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the num_nuclides attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute num_nuclides", "output": "The num_nuclides attribute of a DelayedNuFissionXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the nuclides attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute nuclides", "output": "The nuclides attribute of a DelayedNuFissionXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the sparse attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute sparse", "output": "The sparse attribute of a DelayedNuFissionXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the loaded_sp attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute loaded_sp", "output": "The loaded_sp attribute of a DelayedNuFissionXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the derived attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute derived", "output": "The derived attribute of a DelayedNuFissionXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "What is the mgxs_type attribute of a DelayedNuFissionXS?", "input": "OpenMC Python API DelayedNuFissionXS attribute mgxs_type", "output": "The mgxs_type attribute of a DelayedNuFissionXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a DelayedNuFissionXS instance." }, { "instruction": "How do you call the __init__() method in the DelayedNuFissionXS class?", "input": "OpenMC Python API DelayedNuFissionXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, delayed_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "What is the Beta class in OpenMC's Python API?", "input": "OpenMC Python API Beta class", "output": "The Beta class represents the delayed neutron fraction. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`beta.energy_groups` and :attr:`beta.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`beta.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`beta.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the delayed neutron fraction is calculated as: .. math:: \\begin{aligned} \\langle \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\langle \\nu \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\beta_{d,g} &= \\frac{\\langle \\nu^d \\sigma_f \\phi \\rangle} {\\langle \\nu \\sigma_f \\phi \\rangle} \\end{aligned} note: the beta mgxs is the delayed neutron fraction computed directly from the nuclear data. often the delayed neutron fraction is \"importance-weighted\" by the adjoint flux and called \"beta-effective\". it is important to make clear that this beta is not importance-weighted. It provides 6 methods and 0 properties for working with beta data in OpenMC." }, { "instruction": "What does the Beta class do in OpenMC's Python API?", "input": "OpenMC Python API Beta class description", "output": "The Beta class the delayed neutron fraction. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`beta.energy_groups` and :attr:`beta.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`beta.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`beta.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the delayed neutron fraction is calculated as: .. math:: \\begin{aligned} \\langle \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\langle \\nu \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\beta_{d,g} &= \\frac{\\langle \\nu^d \\sigma_f \\phi \\rangle} {\\langle \\nu \\sigma_f \\phi \\rangle} \\end{aligned} note: the beta mgxs is the delayed neutron fraction computed directly from the nuclear data. often the delayed neutron fraction is \"importance-weighted\" by the adjoint flux and called \"beta-effective\". it is important to make clear that this beta is not importance-weighted. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter domain", "output": "When creating a Beta, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter domain_type", "output": "When creating a Beta, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter groups", "output": "When creating a Beta, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter by_nuclide", "output": "When creating a Beta, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter name", "output": "When creating a Beta, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter delayed_groups", "output": "When creating a Beta, the delayed_groups parameter specifies delayed groups to filter out the xs. It should be a list of int value." }, { "instruction": "What does the num_polar parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter num_polar", "output": "When creating a Beta, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a Beta?", "input": "OpenMC Python API Beta constructor parameter num_azimuthal", "output": "When creating a Beta, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a Beta?", "input": "OpenMC Python API Beta attribute name", "output": "The name attribute of a Beta contains name of the multi-group cross section. It's a str, optional value that you can access after creating a Beta instance." }, { "instruction": "What is the rxn_type attribute of a Beta?", "input": "OpenMC Python API Beta attribute rxn_type", "output": "The rxn_type attribute of a Beta contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a Beta instance." }, { "instruction": "What is the by_nuclide attribute of a Beta?", "input": "OpenMC Python API Beta attribute by_nuclide", "output": "The by_nuclide attribute of a Beta contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a Beta instance." }, { "instruction": "What is the domain attribute of a Beta?", "input": "OpenMC Python API Beta attribute domain", "output": "The domain attribute of a Beta contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a Beta instance." }, { "instruction": "What is the domain_type attribute of a Beta?", "input": "OpenMC Python API Beta attribute domain_type", "output": "The domain_type attribute of a Beta contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a Beta instance." }, { "instruction": "What is the energy_groups attribute of a Beta?", "input": "OpenMC Python API Beta attribute energy_groups", "output": "The energy_groups attribute of a Beta contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a Beta instance." }, { "instruction": "What is the delayed_groups attribute of a Beta?", "input": "OpenMC Python API Beta attribute delayed_groups", "output": "The delayed_groups attribute of a Beta contains delayed groups to filter out the xs. It's a list of int value that you can access after creating a Beta instance." }, { "instruction": "What is the num_polar attribute of a Beta?", "input": "OpenMC Python API Beta attribute num_polar", "output": "The num_polar attribute of a Beta contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a Beta instance." }, { "instruction": "What is the num_azimuthal attribute of a Beta?", "input": "OpenMC Python API Beta attribute num_azimuthal", "output": "The num_azimuthal attribute of a Beta contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a Beta instance." }, { "instruction": "What is the tally_trigger attribute of a Beta?", "input": "OpenMC Python API Beta attribute tally_trigger", "output": "The tally_trigger attribute of a Beta contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a Beta instance." }, { "instruction": "What is the scores attribute of a Beta?", "input": "OpenMC Python API Beta attribute scores", "output": "The scores attribute of a Beta contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a Beta instance." }, { "instruction": "What is the filters attribute of a Beta?", "input": "OpenMC Python API Beta attribute filters", "output": "The filters attribute of a Beta contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a Beta instance." }, { "instruction": "What is the tally_keys attribute of a Beta?", "input": "OpenMC Python API Beta attribute tally_keys", "output": "The tally_keys attribute of a Beta contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a Beta instance." }, { "instruction": "What is the estimator attribute of a Beta?", "input": "OpenMC Python API Beta attribute estimator", "output": "The estimator attribute of a Beta contains the tally estimator used to compute the multi-group cross section. It's a {'tracklength', 'analog'} value that you can access after creating a Beta instance." }, { "instruction": "What is the tallies attribute of a Beta?", "input": "OpenMC Python API Beta attribute tallies", "output": "The tallies attribute of a Beta contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`beta.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a Beta instance." }, { "instruction": "What is the rxn_rate_tally attribute of a Beta?", "input": "OpenMC Python API Beta attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a Beta contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a Beta instance." }, { "instruction": "What is the xs_tally attribute of a Beta?", "input": "OpenMC Python API Beta attribute xs_tally", "output": "The xs_tally attribute of a Beta contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a Beta instance." }, { "instruction": "What is the num_subdomains attribute of a Beta?", "input": "OpenMC Python API Beta attribute num_subdomains", "output": "The num_subdomains attribute of a Beta contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a Beta instance." }, { "instruction": "What is the num_nuclides attribute of a Beta?", "input": "OpenMC Python API Beta attribute num_nuclides", "output": "The num_nuclides attribute of a Beta contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a Beta instance." }, { "instruction": "What is the nuclides attribute of a Beta?", "input": "OpenMC Python API Beta attribute nuclides", "output": "The nuclides attribute of a Beta contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a Beta instance." }, { "instruction": "What is the sparse attribute of a Beta?", "input": "OpenMC Python API Beta attribute sparse", "output": "The sparse attribute of a Beta contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a Beta instance." }, { "instruction": "What is the loaded_sp attribute of a Beta?", "input": "OpenMC Python API Beta attribute loaded_sp", "output": "The loaded_sp attribute of a Beta contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a Beta instance." }, { "instruction": "What is the derived attribute of a Beta?", "input": "OpenMC Python API Beta attribute derived", "output": "The derived attribute of a Beta contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a Beta instance." }, { "instruction": "What is the mgxs_type attribute of a Beta?", "input": "OpenMC Python API Beta attribute mgxs_type", "output": "The mgxs_type attribute of a Beta contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a Beta instance." }, { "instruction": "How do you call the __init__() method in the Beta class?", "input": "OpenMC Python API Beta.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, delayed_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "How do you call the scores() method in the Beta class?", "input": "OpenMC Python API Beta.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_keys() method in the Beta class?", "input": "OpenMC Python API Beta.tally_keys() method signature", "output": "To call the tally_keys() method, use: @property def tally_keys(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the Beta class?", "input": "OpenMC Python API Beta.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the Beta class?", "input": "OpenMC Python API Beta.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_homogenized_mgxs() method do in the Beta class?", "input": "OpenMC Python API Beta.get_homogenized_mgxs() method", "output": "The get_homogenized_mgxs() method construct a homogenized mgxs with other mgxs objects. this method constructs a new mgxs object that is the flux-weighted combination of two mgxs objects. it is equivalent to what one would obtain if the tally spatial domain were designed to encompass the individual domains for both mgxs objects. It's used for beta operations." }, { "instruction": "How do you call the get_homogenized_mgxs() method in the Beta class?", "input": "OpenMC Python API Beta.get_homogenized_mgxs() method signature", "output": "To call the get_homogenized_mgxs() method, use: def get_homogenized_mgxs(self: Any, other_mgxs: Any). It takes 2 parameters." }, { "instruction": "What does the other_mgxs parameter do in the get_homogenized_mgxs() method?", "input": "OpenMC Python API Beta.get_homogenized_mgxs() parameter other_mgxs", "output": "The other_mgxs parameter the mgxs to homogenize with this one.. It should be a openmc.mgxs.MGXS or Iterable of openmc.mgxs.MGXS value." }, { "instruction": "What is the DecayRate class in OpenMC's Python API?", "input": "OpenMC Python API DecayRate class", "output": "The DecayRate class represents the decay rate for delayed neutron precursors. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`decayrate.energy_groups` and :attr:`decayrate.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`decayrate.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`decayrate.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the decay rate is calculated as: .. math:: \\begin{aligned} \\langle \\lambda_d \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\lambda_d \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\langle \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\lambda_d &= \\frac{\\langle \\lambda_d \\nu^d \\sigma_f \\phi \\rangle} {\\langle \\nu^d \\sigma_f \\phi \\rangle} \\end{aligned}. It provides 7 methods and 0 properties for working with decayrate data in OpenMC." }, { "instruction": "What does the DecayRate class do in OpenMC's Python API?", "input": "OpenMC Python API DecayRate class description", "output": "The DecayRate class the decay rate for delayed neutron precursors. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`decayrate.energy_groups` and :attr:`decayrate.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`decayrate.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`decayrate.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the decay rate is calculated as: .. math:: \\begin{aligned} \\langle \\lambda_d \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\lambda_d \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\langle \\nu^d \\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu^d \\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\lambda_d &= \\frac{\\langle \\lambda_d \\nu^d \\sigma_f \\phi \\rangle} {\\langle \\nu^d \\sigma_f \\phi \\rangle} \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter domain", "output": "When creating a DecayRate, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter domain_type", "output": "When creating a DecayRate, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter groups", "output": "When creating a DecayRate, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter by_nuclide", "output": "When creating a DecayRate, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter name", "output": "When creating a DecayRate, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter delayed_groups", "output": "When creating a DecayRate, the delayed_groups parameter specifies delayed groups to filter out the xs. It should be a list of int value." }, { "instruction": "What does the num_polar parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter num_polar", "output": "When creating a DecayRate, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a DecayRate?", "input": "OpenMC Python API DecayRate constructor parameter num_azimuthal", "output": "When creating a DecayRate, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute name", "output": "The name attribute of a DecayRate contains name of the multi-group cross section. It's a str, optional value that you can access after creating a DecayRate instance." }, { "instruction": "What is the rxn_type attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute rxn_type", "output": "The rxn_type attribute of a DecayRate contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a DecayRate instance." }, { "instruction": "What is the by_nuclide attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute by_nuclide", "output": "The by_nuclide attribute of a DecayRate contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a DecayRate instance." }, { "instruction": "What is the domain attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute domain", "output": "The domain attribute of a DecayRate contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a DecayRate instance." }, { "instruction": "What is the domain_type attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute domain_type", "output": "The domain_type attribute of a DecayRate contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a DecayRate instance." }, { "instruction": "What is the energy_groups attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute energy_groups", "output": "The energy_groups attribute of a DecayRate contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a DecayRate instance." }, { "instruction": "What is the delayed_groups attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute delayed_groups", "output": "The delayed_groups attribute of a DecayRate contains delayed groups to filter out the xs. It's a list of int value that you can access after creating a DecayRate instance." }, { "instruction": "What is the num_polar attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute num_polar", "output": "The num_polar attribute of a DecayRate contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a DecayRate instance." }, { "instruction": "What is the num_azimuthal attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute num_azimuthal", "output": "The num_azimuthal attribute of a DecayRate contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a DecayRate instance." }, { "instruction": "What is the tally_trigger attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute tally_trigger", "output": "The tally_trigger attribute of a DecayRate contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a DecayRate instance." }, { "instruction": "What is the scores attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute scores", "output": "The scores attribute of a DecayRate contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DecayRate instance." }, { "instruction": "What is the filters attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute filters", "output": "The filters attribute of a DecayRate contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a DecayRate instance." }, { "instruction": "What is the tally_keys attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute tally_keys", "output": "The tally_keys attribute of a DecayRate contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DecayRate instance." }, { "instruction": "What is the estimator attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute estimator", "output": "The estimator attribute of a DecayRate contains the tally estimator used to compute the multi-group cross section. It's a {'tracklength', 'analog'} value that you can access after creating a DecayRate instance." }, { "instruction": "What is the tallies attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute tallies", "output": "The tallies attribute of a DecayRate contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`decayrate.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a DecayRate instance." }, { "instruction": "What is the rxn_rate_tally attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a DecayRate contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DecayRate instance." }, { "instruction": "What is the xs_tally attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute xs_tally", "output": "The xs_tally attribute of a DecayRate contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DecayRate instance." }, { "instruction": "What is the num_subdomains attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute num_subdomains", "output": "The num_subdomains attribute of a DecayRate contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a DecayRate instance." }, { "instruction": "What is the num_nuclides attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute num_nuclides", "output": "The num_nuclides attribute of a DecayRate contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a DecayRate instance." }, { "instruction": "What is the nuclides attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute nuclides", "output": "The nuclides attribute of a DecayRate contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a DecayRate instance." }, { "instruction": "What is the sparse attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute sparse", "output": "The sparse attribute of a DecayRate contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a DecayRate instance." }, { "instruction": "What is the loaded_sp attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute loaded_sp", "output": "The loaded_sp attribute of a DecayRate contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a DecayRate instance." }, { "instruction": "What is the derived attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute derived", "output": "The derived attribute of a DecayRate contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a DecayRate instance." }, { "instruction": "What is the mgxs_type attribute of a DecayRate?", "input": "OpenMC Python API DecayRate attribute mgxs_type", "output": "The mgxs_type attribute of a DecayRate contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a DecayRate instance." }, { "instruction": "How do you call the __init__() method in the DecayRate class?", "input": "OpenMC Python API DecayRate.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, delayed_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "How do you call the scores() method in the DecayRate class?", "input": "OpenMC Python API DecayRate.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_keys() method in the DecayRate class?", "input": "OpenMC Python API DecayRate.tally_keys() method signature", "output": "To call the tally_keys() method, use: @property def tally_keys(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the DecayRate class?", "input": "OpenMC Python API DecayRate.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the DecayRate class?", "input": "OpenMC Python API DecayRate.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_homogenized_mgxs() method do in the DecayRate class?", "input": "OpenMC Python API DecayRate.get_homogenized_mgxs() method", "output": "The get_homogenized_mgxs() method construct a homogenized mgxs with other mgxs objects. this method constructs a new mgxs object that is the flux-weighted combination of two mgxs objects. it is equivalent to what one would obtain if the tally spatial domain were designed to encompass the individual domains for both mgxs objects. It's used for decayrate operations." }, { "instruction": "How do you call the get_homogenized_mgxs() method in the DecayRate class?", "input": "OpenMC Python API DecayRate.get_homogenized_mgxs() method signature", "output": "To call the get_homogenized_mgxs() method, use: def get_homogenized_mgxs(self: Any, other_mgxs: Any). It takes 2 parameters." }, { "instruction": "What does the other_mgxs parameter do in the get_homogenized_mgxs() method?", "input": "OpenMC Python API DecayRate.get_homogenized_mgxs() parameter other_mgxs", "output": "The other_mgxs parameter the mgxs to homogenize with this one.. It should be a openmc.mgxs.MGXS or Iterable of openmc.mgxs.MGXS value." }, { "instruction": "What does the get_xs() method do in the DecayRate class?", "input": "OpenMC Python API DecayRate.get_xs() method", "output": "The get_xs() method returns an array of multi-delayed-group cross sections. this method constructs a 4d numpy array for the requested multi-delayed-group cross section data for one or more subdomains (1st dimension), delayed groups (2nd demension), energy groups (3rd dimension), and nuclides (4th dimension). It's used for decayrate operations." }, { "instruction": "How do you call the get_xs() method in the DecayRate class?", "input": "OpenMC Python API DecayRate.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, value: Any, delayed_groups: Any, squeeze: Any). It takes 8 parameters." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API DecayRate.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API DecayRate.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API DecayRate.get_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API DecayRate.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API DecayRate.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the delayed_groups parameter do in the get_xs() method?", "input": "OpenMC Python API DecayRate.get_xs() parameter delayed_groups", "output": "The delayed_groups parameter delayed groups of interest. defaults to 'all'.. It should be a list of int or 'all' value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API DecayRate.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What is the MatrixMDGXS class in OpenMC's Python API?", "input": "OpenMC Python API MatrixMDGXS class", "output": "The MatrixMDGXS class represents an abstract multi-delayed-group cross section for some energy group and delayed group structure within some spatial domain. this class is specifically intended for cross sections which depend on both the incoming and outgoing energy groups and are therefore represented by matrices. an example of this is the delayed-nu-fission matrix. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed-group cross sections for downstream neutronics calculations. note: users should instantiate the subclasses of this abstract class. It provides 5 methods and 0 properties for working with matrixmdgxs data in OpenMC." }, { "instruction": "What does the MatrixMDGXS class do in OpenMC's Python API?", "input": "OpenMC Python API MatrixMDGXS class description", "output": "The MatrixMDGXS class an abstract multi-delayed-group cross section for some energy group and delayed group structure within some spatial domain. this class is specifically intended for cross sections which depend on both the incoming and outgoing energy groups and are therefore represented by matrices. an example of this is the delayed-nu-fission matrix. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group and multi-delayed-group cross sections for downstream neutronics calculations. note: users should instantiate the subclasses of this abstract class. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter domain", "output": "When creating a MatrixMDGXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter domain_type", "output": "When creating a MatrixMDGXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the energy_groups parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter energy_groups", "output": "When creating a MatrixMDGXS, the energy_groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter by_nuclide", "output": "When creating a MatrixMDGXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter name", "output": "When creating a MatrixMDGXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter delayed_groups", "output": "When creating a MatrixMDGXS, the delayed_groups parameter specifies delayed groups to filter out the xs. It should be a list of int value." }, { "instruction": "What does the num_polar parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter num_polar", "output": "When creating a MatrixMDGXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS constructor parameter num_azimuthal", "output": "When creating a MatrixMDGXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute name", "output": "The name attribute of a MatrixMDGXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the rxn_type attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute rxn_type", "output": "The rxn_type attribute of a MatrixMDGXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the by_nuclide attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute by_nuclide", "output": "The by_nuclide attribute of a MatrixMDGXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the domain attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute domain", "output": "The domain attribute of a MatrixMDGXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the domain_type attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute domain_type", "output": "The domain_type attribute of a MatrixMDGXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the energy_groups attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute energy_groups", "output": "The energy_groups attribute of a MatrixMDGXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the delayed_groups attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute delayed_groups", "output": "The delayed_groups attribute of a MatrixMDGXS contains delayed groups to filter out the xs. It's a list of int value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the num_polar attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute num_polar", "output": "The num_polar attribute of a MatrixMDGXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the num_azimuthal attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a MatrixMDGXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the tally_trigger attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute tally_trigger", "output": "The tally_trigger attribute of a MatrixMDGXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the scores attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute scores", "output": "The scores attribute of a MatrixMDGXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the filters attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute filters", "output": "The filters attribute of a MatrixMDGXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the tally_keys attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute tally_keys", "output": "The tally_keys attribute of a MatrixMDGXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the estimator attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute estimator", "output": "The estimator attribute of a MatrixMDGXS contains the tally estimator used to compute the multi-group cross section. It's a {'tracklength', 'collision', 'analog'} value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the tallies attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute tallies", "output": "The tallies attribute of a MatrixMDGXS contains openmc tallies needed to compute the multi-group cross section. It's a dict value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a MatrixMDGXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the xs_tally attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute xs_tally", "output": "The xs_tally attribute of a MatrixMDGXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the num_subdomains attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute num_subdomains", "output": "The num_subdomains attribute of a MatrixMDGXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file) and the number of mesh cells for 'mesh' domain types.. It's a int value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the num_nuclides attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute num_nuclides", "output": "The num_nuclides attribute of a MatrixMDGXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the nuclides attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute nuclides", "output": "The nuclides attribute of a MatrixMDGXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the sparse attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute sparse", "output": "The sparse attribute of a MatrixMDGXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the loaded_sp attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute loaded_sp", "output": "The loaded_sp attribute of a MatrixMDGXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the derived attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute derived", "output": "The derived attribute of a MatrixMDGXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What is the mgxs_type attribute of a MatrixMDGXS?", "input": "OpenMC Python API MatrixMDGXS attribute mgxs_type", "output": "The mgxs_type attribute of a MatrixMDGXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a MatrixMDGXS instance." }, { "instruction": "What does the _dont_squeeze() method do in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS._dont_squeeze() method", "output": "The _dont_squeeze() method create a tuple of axes which should not be removed during the get_xs\n process. It's used for matrixmdgxs operations." }, { "instruction": "How do you call the _dont_squeeze() method in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS._dont_squeeze() method signature", "output": "To call the _dont_squeeze() method, use: @property def _dont_squeeze(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_xs() method do in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS.get_xs() method", "output": "The get_xs() method returns an array of multi-group cross sections. this method constructs a 4d numpy array for the requested multi-group cross section data for one or more subdomains (1st dimension), delayed groups (2nd dimension), energy groups in (3rd dimension), energy groups out (4th dimension), and nuclides (5th dimension). It's used for matrixmdgxs operations." }, { "instruction": "How do you call the get_xs() method in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, in_groups: Any, out_groups: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, row_column: Any, value: Any, delayed_groups: Any, squeeze: Any). It takes 11 parameters." }, { "instruction": "What does the in_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter in_groups", "output": "The in_groups parameter incoming energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the out_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter out_groups", "output": "The out_groups parameter outgoing energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the row_column parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter row_column", "output": "The row_column parameter return the cross section indexed first by incoming group and second by outgoing group ('inout'), or vice versa ('outin'). defaults to 'inout'.. It should be a {'inout', 'outin'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the delayed_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter delayed_groups", "output": "The delayed_groups parameter delayed groups of interest. defaults to 'all'.. It should be a list of int or 'all' value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMDGXS.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_slice() method do in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS.get_slice() method", "output": "The get_slice() method build a sliced matrixmdgxs object for the specified nuclides and energy groups. this method constructs a new mdgxs to encapsulate a subset of the data represented by this mdgxs. the subset of data to include in the tally slice is determined by the nuclides, energy groups, and delayed groups specified in the input parameters. It's used for matrixmdgxs operations." }, { "instruction": "How do you call the get_slice() method in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, nuclides: Any, in_groups: Any, out_groups: Any, delayed_groups: Any). It takes 5 parameters." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API MatrixMDGXS.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the in_groups parameter do in the get_slice() method?", "input": "OpenMC Python API MatrixMDGXS.get_slice() parameter in_groups", "output": "The in_groups parameter a list of incoming energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the out_groups parameter do in the get_slice() method?", "input": "OpenMC Python API MatrixMDGXS.get_slice() parameter out_groups", "output": "The out_groups parameter a list of outgoing energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the delayed_groups parameter do in the get_slice() method?", "input": "OpenMC Python API MatrixMDGXS.get_slice() parameter delayed_groups", "output": "The delayed_groups parameter a list of delayed group indices (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the print_xs() method do in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS.print_xs() method", "output": "The print_xs() method prints a string representation for the multi-group cross section. It's used for matrixmdgxs operations." }, { "instruction": "How do you call the print_xs() method in the MatrixMDGXS class?", "input": "OpenMC Python API MatrixMDGXS.print_xs() method signature", "output": "To call the print_xs() method, use: def print_xs(self: Any, subdomains: Any, nuclides: Any, xs_type: Any). It takes 4 parameters." }, { "instruction": "What does the subdomains parameter do in the print_xs() method?", "input": "OpenMC Python API MatrixMDGXS.print_xs() parameter subdomains", "output": "The subdomains parameter the subdomain ids of the cross sections to include in the report. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the print_xs() method?", "input": "OpenMC Python API MatrixMDGXS.print_xs() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the report. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will report the cross sections for all nuclides in the spatial domain. the special string 'sum' will report the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the print_xs() method?", "input": "OpenMC Python API MatrixMDGXS.print_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What is the DelayedNuFissionMatrixXS class in OpenMC's Python API?", "input": "OpenMC Python API DelayedNuFissionMatrixXS class", "output": "The DelayedNuFissionMatrixXS class represents a fission delayed neutron production matrix multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group fission neutron production cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`delayednufissionmatrixxs.energy_groups` and :attr:`delayednufissionmatrixxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`delayednufissionmatrixxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`delayednufissionmatrixxs.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the fission delayed neutron production cross section is calculated as: .. math:: \\begin{aligned} \\langle \\nu\\sigma_{f,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu\\sigma_f^d (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\nu\\sigma_{f,g'\\rightarrow g} &= \\frac{\\langle \\nu\\sigma_{f,g'\\rightarrow g}^d \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned}. It provides 1 methods and 0 properties for working with delayednufissionmatrixxs data in OpenMC." }, { "instruction": "What does the DelayedNuFissionMatrixXS class do in OpenMC's Python API?", "input": "OpenMC Python API DelayedNuFissionMatrixXS class description", "output": "The DelayedNuFissionMatrixXS class a fission delayed neutron production matrix multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group fission neutron production cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`delayednufissionmatrixxs.energy_groups` and :attr:`delayednufissionmatrixxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`delayednufissionmatrixxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`delayednufissionmatrixxs.xs_tally` property. for a spatial domain :math:`v`, energy group :math:`[e_g,e_{g-1}]`, and delayed group :math:`d`, the fission delayed neutron production cross section is calculated as: .. math:: \\begin{aligned} \\langle \\nu\\sigma_{f,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu\\sigma_f^d (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\nu\\sigma_{f,g'\\rightarrow g} &= \\frac{\\langle \\nu\\sigma_{f,g'\\rightarrow g}^d \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter domain", "output": "When creating a DelayedNuFissionMatrixXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter domain_type", "output": "When creating a DelayedNuFissionMatrixXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter groups", "output": "When creating a DelayedNuFissionMatrixXS, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter by_nuclide", "output": "When creating a DelayedNuFissionMatrixXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter name", "output": "When creating a DelayedNuFissionMatrixXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the delayed_groups parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter delayed_groups", "output": "When creating a DelayedNuFissionMatrixXS, the delayed_groups parameter specifies delayed groups to filter out the xs. It should be a list of int value." }, { "instruction": "What does the num_polar parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter num_polar", "output": "When creating a DelayedNuFissionMatrixXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS constructor parameter num_azimuthal", "output": "When creating a DelayedNuFissionMatrixXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute name", "output": "The name attribute of a DelayedNuFissionMatrixXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the rxn_type attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute rxn_type", "output": "The rxn_type attribute of a DelayedNuFissionMatrixXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the by_nuclide attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute by_nuclide", "output": "The by_nuclide attribute of a DelayedNuFissionMatrixXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the domain attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute domain", "output": "The domain attribute of a DelayedNuFissionMatrixXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the domain_type attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute domain_type", "output": "The domain_type attribute of a DelayedNuFissionMatrixXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the energy_groups attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute energy_groups", "output": "The energy_groups attribute of a DelayedNuFissionMatrixXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the delayed_groups attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute delayed_groups", "output": "The delayed_groups attribute of a DelayedNuFissionMatrixXS contains delayed groups to filter out the xs. It's a list of int value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the num_polar attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute num_polar", "output": "The num_polar attribute of a DelayedNuFissionMatrixXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the num_azimuthal attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a DelayedNuFissionMatrixXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the tally_trigger attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute tally_trigger", "output": "The tally_trigger attribute of a DelayedNuFissionMatrixXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the scores attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute scores", "output": "The scores attribute of a DelayedNuFissionMatrixXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the filters attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute filters", "output": "The filters attribute of a DelayedNuFissionMatrixXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the tally_keys attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute tally_keys", "output": "The tally_keys attribute of a DelayedNuFissionMatrixXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the estimator attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute estimator", "output": "The estimator attribute of a DelayedNuFissionMatrixXS contains the tally estimator used to compute the multi-group cross section. It's a 'analog' value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the tallies attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute tallies", "output": "The tallies attribute of a DelayedNuFissionMatrixXS contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`delayednufissionxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a DelayedNuFissionMatrixXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the xs_tally attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute xs_tally", "output": "The xs_tally attribute of a DelayedNuFissionMatrixXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the num_subdomains attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute num_subdomains", "output": "The num_subdomains attribute of a DelayedNuFissionMatrixXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the num_nuclides attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute num_nuclides", "output": "The num_nuclides attribute of a DelayedNuFissionMatrixXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the nuclides attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute nuclides", "output": "The nuclides attribute of a DelayedNuFissionMatrixXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the sparse attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute sparse", "output": "The sparse attribute of a DelayedNuFissionMatrixXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the loaded_sp attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute loaded_sp", "output": "The loaded_sp attribute of a DelayedNuFissionMatrixXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the derived attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute derived", "output": "The derived attribute of a DelayedNuFissionMatrixXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "What is the mgxs_type attribute of a DelayedNuFissionMatrixXS?", "input": "OpenMC Python API DelayedNuFissionMatrixXS attribute mgxs_type", "output": "The mgxs_type attribute of a DelayedNuFissionMatrixXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a DelayedNuFissionMatrixXS instance." }, { "instruction": "How do you call the __init__() method in the DelayedNuFissionMatrixXS class?", "input": "OpenMC Python API DelayedNuFissionMatrixXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, delayed_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "What is the MGXS class in OpenMC's Python API?", "input": "OpenMC Python API MGXS class", "output": "The MGXS class represents an abstract multi-group cross section for some energy group structure\n within some spatial domain.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations.\n\n .. note:: users should instantiate the subclasses of this abstract class.. It provides 61 methods and 0 properties for working with mgxs data in OpenMC." }, { "instruction": "What does the MGXS class do in OpenMC's Python API?", "input": "OpenMC Python API MGXS class description", "output": "The MGXS class an abstract multi-group cross section for some energy group structure\n within some spatial domain.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations.\n\n .. note:: users should instantiate the subclasses of this abstract class.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the MGXS class?", "input": "OpenMC Python API MGXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the MGXS class?", "input": "OpenMC Python API MGXS.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the _add_angle_filters() method do in the MGXS class?", "input": "OpenMC Python API MGXS._add_angle_filters() method", "output": "The _add_angle_filters() method add the azimuthal and polar bins to the mgxs filters if needed. filters will be provided as a ragged 2d list of openmc.filter objects. It's used for mgxs operations." }, { "instruction": "How do you call the _add_angle_filters() method in the MGXS class?", "input": "OpenMC Python API MGXS._add_angle_filters() method signature", "output": "To call the _add_angle_filters() method, use: def _add_angle_filters(self: Any, filters: Any). It takes 2 parameters." }, { "instruction": "What does the filters parameter do in the _add_angle_filters() method?", "input": "OpenMC Python API MGXS._add_angle_filters() parameter filters", "output": "The filters parameter ragged 2d list of openmc.filter objects for the energy and spatial domains. the angle filters will be added to the list.. It should be a Iterable of Iterable of openmc.Filter value." }, { "instruction": "What does the _squeeze_xs() method do in the MGXS class?", "input": "OpenMC Python API MGXS._squeeze_xs() method", "output": "The _squeeze_xs() method remove dimensions which are not needed from a cross section array due to user options. this is used by the openmc.mgxs.get_xs(...) method. It's used for mgxs operations." }, { "instruction": "How do you call the _squeeze_xs() method in the MGXS class?", "input": "OpenMC Python API MGXS._squeeze_xs() method signature", "output": "To call the _squeeze_xs() method, use: def _squeeze_xs(self: Any, xs: Any). It takes 2 parameters." }, { "instruction": "What does the xs parameter do in the _squeeze_xs() method?", "input": "OpenMC Python API MGXS._squeeze_xs() parameter xs", "output": "The xs parameter cross sections array with dimensions to be squeezed. It should be a np.ndarray value." }, { "instruction": "What does the _df_convert_columns_to_bins() method do in the MGXS class?", "input": "OpenMC Python API MGXS._df_convert_columns_to_bins() method", "output": "The _df_convert_columns_to_bins() method this method converts all relevant and present dataframe columns from their bin boundaries to the index for each bin. this method operates on the dataframe, df, in place. the method returns a list of the columns in which it has operated on. It's used for mgxs operations." }, { "instruction": "How do you call the _df_convert_columns_to_bins() method in the MGXS class?", "input": "OpenMC Python API MGXS._df_convert_columns_to_bins() method signature", "output": "To call the _df_convert_columns_to_bins() method, use: def _df_convert_columns_to_bins(self: Any, df: Any). It takes 2 parameters." }, { "instruction": "What does the df parameter do in the _df_convert_columns_to_bins() method?", "input": "OpenMC Python API MGXS._df_convert_columns_to_bins() parameter df", "output": "The df parameter a pandas dataframe containing the cross section data.. It should be a pandas.DataFrame value." }, { "instruction": "What does the _df_convert_columns_to_bins() method return in the MGXS class?", "input": "OpenMC Python API MGXS._df_convert_columns_to_bins() return value", "output": "The _df_convert_columns_to_bins() method returns names of the re-named and re-valued columns. The return type is Iterable of str." }, { "instruction": "What does the _dont_squeeze() method do in the MGXS class?", "input": "OpenMC Python API MGXS._dont_squeeze() method", "output": "The _dont_squeeze() method create a tuple of axes which should not be removed during the get_xs\n process. It's used for mgxs operations." }, { "instruction": "How do you call the _dont_squeeze() method in the MGXS class?", "input": "OpenMC Python API MGXS._dont_squeeze() method signature", "output": "To call the _dont_squeeze() method, use: @property def _dont_squeeze(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the MGXS class?", "input": "OpenMC Python API MGXS.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the MGXS class?", "input": "OpenMC Python API MGXS.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the rxn_type() method in the MGXS class?", "input": "OpenMC Python API MGXS.rxn_type() method signature", "output": "To call the rxn_type() method, use: @property def rxn_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the by_nuclide() method in the MGXS class?", "input": "OpenMC Python API MGXS.by_nuclide() method signature", "output": "To call the by_nuclide() method, use: @property def by_nuclide(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the by_nuclide() method in the MGXS class?", "input": "OpenMC Python API MGXS.by_nuclide() method signature", "output": "To call the by_nuclide() method, use: @by_nuclide.setter def by_nuclide(self: Any, by_nuclide: Any). It takes 2 parameters." }, { "instruction": "How do you call the domain() method in the MGXS class?", "input": "OpenMC Python API MGXS.domain() method signature", "output": "To call the domain() method, use: @property def domain(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the domain() method in the MGXS class?", "input": "OpenMC Python API MGXS.domain() method signature", "output": "To call the domain() method, use: @domain.setter def domain(self: Any, domain: Any). It takes 2 parameters." }, { "instruction": "How do you call the domain_type() method in the MGXS class?", "input": "OpenMC Python API MGXS.domain_type() method signature", "output": "To call the domain_type() method, use: @property def domain_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the domain_type() method in the MGXS class?", "input": "OpenMC Python API MGXS.domain_type() method signature", "output": "To call the domain_type() method, use: @domain_type.setter def domain_type(self: Any, domain_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_groups() method in the MGXS class?", "input": "OpenMC Python API MGXS.energy_groups() method signature", "output": "To call the energy_groups() method, use: @property def energy_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_groups() method in the MGXS class?", "input": "OpenMC Python API MGXS.energy_groups() method signature", "output": "To call the energy_groups() method, use: @energy_groups.setter def energy_groups(self: Any, energy_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_polar() method in the MGXS class?", "input": "OpenMC Python API MGXS.num_polar() method signature", "output": "To call the num_polar() method, use: @property def num_polar(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_polar() method in the MGXS class?", "input": "OpenMC Python API MGXS.num_polar() method signature", "output": "To call the num_polar() method, use: @num_polar.setter def num_polar(self: Any, num_polar: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_azimuthal() method in the MGXS class?", "input": "OpenMC Python API MGXS.num_azimuthal() method signature", "output": "To call the num_azimuthal() method, use: @property def num_azimuthal(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_azimuthal() method in the MGXS class?", "input": "OpenMC Python API MGXS.num_azimuthal() method signature", "output": "To call the num_azimuthal() method, use: @num_azimuthal.setter def num_azimuthal(self: Any, num_azimuthal: Any). It takes 2 parameters." }, { "instruction": "How do you call the tally_trigger() method in the MGXS class?", "input": "OpenMC Python API MGXS.tally_trigger() method signature", "output": "To call the tally_trigger() method, use: @property def tally_trigger(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_trigger() method in the MGXS class?", "input": "OpenMC Python API MGXS.tally_trigger() method signature", "output": "To call the tally_trigger() method, use: @tally_trigger.setter def tally_trigger(self: Any, tally_trigger: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_groups() method in the MGXS class?", "input": "OpenMC Python API MGXS.num_groups() method signature", "output": "To call the num_groups() method, use: @property def num_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the MGXS class?", "input": "OpenMC Python API MGXS.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the MGXS class?", "input": "OpenMC Python API MGXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_keys() method in the MGXS class?", "input": "OpenMC Python API MGXS.tally_keys() method signature", "output": "To call the tally_keys() method, use: @property def tally_keys(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the estimator() method in the MGXS class?", "input": "OpenMC Python API MGXS.estimator() method signature", "output": "To call the estimator() method, use: @property def estimator(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the estimator() method in the MGXS class?", "input": "OpenMC Python API MGXS.estimator() method signature", "output": "To call the estimator() method, use: @estimator.setter def estimator(self: Any, estimator: Any). It takes 2 parameters." }, { "instruction": "How do you call the tallies() method in the MGXS class?", "input": "OpenMC Python API MGXS.tallies() method signature", "output": "To call the tallies() method, use: @property def tallies(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the MGXS class?", "input": "OpenMC Python API MGXS.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the MGXS class?", "input": "OpenMC Python API MGXS.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sparse() method in the MGXS class?", "input": "OpenMC Python API MGXS.sparse() method signature", "output": "To call the sparse() method, use: @property def sparse(self: Any). It takes 1 parameters." }, { "instruction": "What does the sparse() method do in the MGXS class?", "input": "OpenMC Python API MGXS.sparse() method", "output": "The sparse() method convert tally data from numpy arrays to scipy list of lists (lil)\n sparse matrices, and vice versa.\n\n this property may be used to reduce the amount of data in memory during\n tally data processing. the tally data will be stored as scipy lil\n matrices internally within the tally object. all tally data access\n properties and methods will return data as a dense numpy array.. It's used for mgxs operations." }, { "instruction": "How do you call the sparse() method in the MGXS class?", "input": "OpenMC Python API MGXS.sparse() method signature", "output": "To call the sparse() method, use: @sparse.setter def sparse(self: Any, sparse: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_subdomains() method in the MGXS class?", "input": "OpenMC Python API MGXS.num_subdomains() method signature", "output": "To call the num_subdomains() method, use: @property def num_subdomains(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_nuclides() method in the MGXS class?", "input": "OpenMC Python API MGXS.num_nuclides() method signature", "output": "To call the num_nuclides() method, use: @property def num_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the MGXS class?", "input": "OpenMC Python API MGXS.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the MGXS class?", "input": "OpenMC Python API MGXS.nuclides() method signature", "output": "To call the nuclides() method, use: @nuclides.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "How do you call the loaded_sp() method in the MGXS class?", "input": "OpenMC Python API MGXS.loaded_sp() method signature", "output": "To call the loaded_sp() method, use: @property def loaded_sp(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the derived() method in the MGXS class?", "input": "OpenMC Python API MGXS.derived() method signature", "output": "To call the derived() method, use: @property def derived(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mgxs_type() method in the MGXS class?", "input": "OpenMC Python API MGXS.mgxs_type() method signature", "output": "To call the mgxs_type() method, use: @property def mgxs_type(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_mgxs() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_mgxs() method", "output": "The get_mgxs() method return a mgxs subclass object for some energy group structure within some spatial domain for some reaction type. this is a factory method which can be used to quickly create mgxs subclass objects for various reaction types. It's used for mgxs operations." }, { "instruction": "How do you call the get_mgxs() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_mgxs() method signature", "output": "To call the get_mgxs() method, use: @staticmethod def get_mgxs(mgxs_type: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "What does the mgxs_type parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter mgxs_type", "output": "The mgxs_type parameter the type of multi-group cross section object to return; valid values are members of mgxs_types, or the reaction types that are the keys of reaction_mt. note that if a reaction type from reaction_mt is used, it can be appended with ' matrix' to obtain a multigroup matrix (from incoming to outgoing energy groups) for reactions with a neutron in an outgoing channel.. It should be a str or Integral value." }, { "instruction": "What does the domain parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter domain", "output": "The domain parameter the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter domain_type", "output": "The domain_type parameter the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the energy_groups parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter energy_groups", "output": "The energy_groups parameter the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter by_nuclide", "output": "The by_nuclide parameter if true, computes cross sections for each nuclide in domain. defaults to false. It should be a bool value." }, { "instruction": "What does the name parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter name", "output": "The name parameter name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file. defaults to the empty string.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter num_polar", "output": "The num_polar parameter number of equi-width polar angles for angle discretization; defaults to no discretization. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do in the get_mgxs() method?", "input": "OpenMC Python API MGXS.get_mgxs() parameter num_azimuthal", "output": "The num_azimuthal parameter number of equi-width azimuthal angles for angle discretization; defaults to no discretization. It should be a Integral, optional value." }, { "instruction": "What does the get_nuclides() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_nuclides() method", "output": "The get_nuclides() method get all nuclides in the cross section's spatial domain. It's used for mgxs operations." }, { "instruction": "How do you call the get_nuclides() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_nuclides() method signature", "output": "To call the get_nuclides() method, use: def get_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclide_density() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_nuclide_density() method", "output": "The get_nuclide_density() method get the atomic number density in units of atoms/b-cm for a nuclide in the cross section's spatial domain. It's used for mgxs operations." }, { "instruction": "How do you call the get_nuclide_density() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_nuclide_density() method signature", "output": "To call the get_nuclide_density() method, use: def get_nuclide_density(self: Any, nuclide: Any). It takes 2 parameters." }, { "instruction": "What does the nuclide parameter do in the get_nuclide_density() method?", "input": "OpenMC Python API MGXS.get_nuclide_density() parameter nuclide", "output": "The nuclide parameter a nuclide name string (e.g., 'u235'). It should be a str value." }, { "instruction": "What does the get_nuclide_densities() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_nuclide_densities() method", "output": "The get_nuclide_densities() method get an array of atomic number densities in units of atom/b-cm for all nuclides in the cross section's spatial domain. It's used for mgxs operations." }, { "instruction": "How do you call the get_nuclide_densities() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_nuclide_densities() method signature", "output": "To call the get_nuclide_densities() method, use: def get_nuclide_densities(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides parameter do in the get_nuclide_densities() method?", "input": "OpenMC Python API MGXS.get_nuclide_densities() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the atom densities for all nuclides in the spatial domain. the special string 'sum' will return the atom density summed across all nuclides in the spatial domain. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the _compute_xs() method do in the MGXS class?", "input": "OpenMC Python API MGXS._compute_xs() method", "output": "The _compute_xs() method performs generic cleanup after a subclass' uses tally arithmetic to\n compute a multi-group cross section as a derived tally.\n\n this method replaces crossnuclides generated by tally arithmetic with\n the original nuclide objects in the xs_tally instance attribute. the\n simple nuclides allow for cleaner output through pandas dataframes as\n well as simpler data access through the get_xs(...) class method.\n\n in addition, this routine resets nans in the multi group cross section\n array to 0.0. this may be needed occur if no events were scored in\n certain tally bins, which will lead to a divide-by-zero situation.. It's used for mgxs operations." }, { "instruction": "How do you call the _compute_xs() method in the MGXS class?", "input": "OpenMC Python API MGXS._compute_xs() method signature", "output": "To call the _compute_xs() method, use: def _compute_xs(self: Any). It takes 1 parameters." }, { "instruction": "What does the load_from_statepoint() method do in the MGXS class?", "input": "OpenMC Python API MGXS.load_from_statepoint() method", "output": "The load_from_statepoint() method extracts tallies in an openmc statepoint with the data needed to compute multi-group cross sections. this method is needed to compute cross section data from tallies in an openmc statepoint object. .. note:: the statepoint must be linked with an openmc summary object. It's used for mgxs operations." }, { "instruction": "How do you call the load_from_statepoint() method in the MGXS class?", "input": "OpenMC Python API MGXS.load_from_statepoint() method signature", "output": "To call the load_from_statepoint() method, use: def load_from_statepoint(self: Any, statepoint: Any). It takes 2 parameters." }, { "instruction": "What does the statepoint parameter do in the load_from_statepoint() method?", "input": "OpenMC Python API MGXS.load_from_statepoint() parameter statepoint", "output": "The statepoint parameter an openmc statepoint object with tally data. It should be a openmc.StatePoint value." }, { "instruction": "What does the get_xs() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_xs() method", "output": "The get_xs() method returns an array of multi-group cross sections. this method constructs a 3d numpy array for the requested multi-group cross section data for one or more subdomains (1st dimension), energy groups (2nd dimension), and nuclides (3rd dimension). It's used for mgxs operations." }, { "instruction": "How do you call the get_xs() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, groups: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, value: Any, squeeze: Any). It takes 8 parameters." }, { "instruction": "What does the groups parameter do in the get_xs() method?", "input": "OpenMC Python API MGXS.get_xs() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API MGXS.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API MGXS.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API MGXS.get_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MGXS.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API MGXS.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API MGXS.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_flux() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_flux() method", "output": "The get_flux() method returns an array of the fluxes used to weight the mgxs. this method constructs a 2d numpy array for the requested weighting flux for one or more subdomains (1st dimension), and energy groups (2nd dimension). It's used for mgxs operations." }, { "instruction": "How do you call the get_flux() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_flux() method signature", "output": "To call the get_flux() method, use: def get_flux(self: Any, groups: Any, subdomains: Any, order_groups: Any, value: Any, squeeze: Any). It takes 6 parameters." }, { "instruction": "What does the groups parameter do in the get_flux() method?", "input": "OpenMC Python API MGXS.get_flux() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_flux() method?", "input": "OpenMC Python API MGXS.get_flux() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the order_groups parameter do in the get_flux() method?", "input": "OpenMC Python API MGXS.get_flux() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the value parameter do in the get_flux() method?", "input": "OpenMC Python API MGXS.get_flux() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the squeeze parameter do in the get_flux() method?", "input": "OpenMC Python API MGXS.get_flux() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_condensed_xs() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_condensed_xs() method", "output": "The get_condensed_xs() method construct an energy-condensed version of this cross section. It's used for mgxs operations." }, { "instruction": "How do you call the get_condensed_xs() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_condensed_xs() method signature", "output": "To call the get_condensed_xs() method, use: def get_condensed_xs(self: Any, coarse_groups: Any). It takes 2 parameters." }, { "instruction": "What does the coarse_groups parameter do in the get_condensed_xs() method?", "input": "OpenMC Python API MGXS.get_condensed_xs() parameter coarse_groups", "output": "The coarse_groups parameter the coarse energy group structure of interest. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the get_subdomain_avg_xs() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_subdomain_avg_xs() method", "output": "The get_subdomain_avg_xs() method construct a subdomain-averaged version of this cross section. this method is useful for averaging cross sections across distribcell instances. the method performs spatial homogenization to compute the scalar flux-weighted average cross section across the subdomains. It's used for mgxs operations." }, { "instruction": "How do you call the get_subdomain_avg_xs() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_subdomain_avg_xs() method signature", "output": "To call the get_subdomain_avg_xs() method, use: def get_subdomain_avg_xs(self: Any, subdomains: Any). It takes 2 parameters." }, { "instruction": "What does the subdomains parameter do in the get_subdomain_avg_xs() method?", "input": "OpenMC Python API MGXS.get_subdomain_avg_xs() parameter subdomains", "output": "The subdomains parameter the subdomain ids to average across. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the _get_homogenized_mgxs() method do in the MGXS class?", "input": "OpenMC Python API MGXS._get_homogenized_mgxs() method", "output": "The _get_homogenized_mgxs() method construct a homogenized mgxs with other mgxs objects. this method constructs a new mgxs object that is the flux-weighted combination of two mgxs objects. it is equivalent to what one would obtain if the tally spatial domain were designed to encompass the individual domains for both mgxs objects. this is accomplished by summing the rxn rate (numerator) tally and the denominator tally (often a tally of the flux over the spatial domain) that are used to compute a multi-group cross-section. It's used for mgxs operations." }, { "instruction": "How do you call the _get_homogenized_mgxs() method in the MGXS class?", "input": "OpenMC Python API MGXS._get_homogenized_mgxs() method signature", "output": "To call the _get_homogenized_mgxs() method, use: def _get_homogenized_mgxs(self: Any, other_mgxs: Any, denom_score: Any). It takes 3 parameters." }, { "instruction": "What does the other_mgxs parameter do in the _get_homogenized_mgxs() method?", "input": "OpenMC Python API MGXS._get_homogenized_mgxs() parameter other_mgxs", "output": "The other_mgxs parameter the mgxs to homogenize with this one.. It should be a openmc.mgxs.MGXS or Iterable of openmc.mgxs.MGXS value." }, { "instruction": "What does the denom_score parameter do in the _get_homogenized_mgxs() method?", "input": "OpenMC Python API MGXS._get_homogenized_mgxs() parameter denom_score", "output": "The denom_score parameter the denominator score in the denominator of computing the mgxs.. It should be a str value." }, { "instruction": "What does the get_homogenized_mgxs() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_homogenized_mgxs() method", "output": "The get_homogenized_mgxs() method construct a homogenized mgxs with other mgxs objects. It's used for mgxs operations." }, { "instruction": "How do you call the get_homogenized_mgxs() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_homogenized_mgxs() method signature", "output": "To call the get_homogenized_mgxs() method, use: def get_homogenized_mgxs(self: Any, other_mgxs: Any). It takes 2 parameters." }, { "instruction": "What does the other_mgxs parameter do in the get_homogenized_mgxs() method?", "input": "OpenMC Python API MGXS.get_homogenized_mgxs() parameter other_mgxs", "output": "The other_mgxs parameter the mgxs to homogenize with this one.. It should be a openmc.mgxs.MGXS or Iterable of openmc.mgxs.MGXS value." }, { "instruction": "What does the get_slice() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_slice() method", "output": "The get_slice() method build a sliced mgxs for the specified nuclides and energy groups. this method constructs a new mgxs to encapsulate a subset of the data represented by this mgxs. the subset of data to include in the tally slice is determined by the nuclides and energy groups specified in the input parameters. It's used for mgxs operations." }, { "instruction": "How do you call the get_slice() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, nuclides: Any, groups: Any). It takes 3 parameters." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API MGXS.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the groups parameter do in the get_slice() method?", "input": "OpenMC Python API MGXS.get_slice() parameter groups", "output": "The groups parameter a list of energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the can_merge() method do in the MGXS class?", "input": "OpenMC Python API MGXS.can_merge() method", "output": "The can_merge() method determine if another mgxs can be merged with this one if results have been loaded from a statepoint, then mgxs are only mergeable along one and only one of enegy groups or nuclides. It's used for mgxs operations." }, { "instruction": "How do you call the can_merge() method in the MGXS class?", "input": "OpenMC Python API MGXS.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the can_merge() method?", "input": "OpenMC Python API MGXS.can_merge() parameter other", "output": "The other parameter mgxs to check for merging. It should be a openmc.mgxs.MGXS value." }, { "instruction": "What does the merge() method do in the MGXS class?", "input": "OpenMC Python API MGXS.merge() method", "output": "The merge() method merge another mgxs with this one mgxs are only mergeable if their energy groups and nuclides are either identical or mutually exclusive. if results have been loaded from a statepoint, then mgxs are only mergeable along one and only one of energy groups or nuclides. It's used for mgxs operations." }, { "instruction": "How do you call the merge() method in the MGXS class?", "input": "OpenMC Python API MGXS.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API MGXS.merge() parameter other", "output": "The other parameter mgxs to merge with this one. It should be a openmc.mgxs.MGXS value." }, { "instruction": "What does the merge() method return in the MGXS class?", "input": "OpenMC Python API MGXS.merge() return value", "output": "The merge() method returns merged mgxs. The return type is openmc.mgxs.MGXS." }, { "instruction": "What does the print_xs() method do in the MGXS class?", "input": "OpenMC Python API MGXS.print_xs() method", "output": "The print_xs() method print a string representation for the multi-group cross section. It's used for mgxs operations." }, { "instruction": "How do you call the print_xs() method in the MGXS class?", "input": "OpenMC Python API MGXS.print_xs() method signature", "output": "To call the print_xs() method, use: def print_xs(self: Any, subdomains: Any, nuclides: Any, xs_type: Any). It takes 4 parameters." }, { "instruction": "What does the subdomains parameter do in the print_xs() method?", "input": "OpenMC Python API MGXS.print_xs() parameter subdomains", "output": "The subdomains parameter the subdomain ids of the cross sections to include in the report. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the print_xs() method?", "input": "OpenMC Python API MGXS.print_xs() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the report. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will report the cross sections for all nuclides in the spatial domain. the special string 'sum' will report the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the print_xs() method?", "input": "OpenMC Python API MGXS.print_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the build_hdf5_store() method do in the MGXS class?", "input": "OpenMC Python API MGXS.build_hdf5_store() method", "output": "The build_hdf5_store() method export the multi-group cross section data to an hdf5 binary file. this method constructs an hdf5 file which stores the multi-group cross section data. the data is stored in a hierarchy of hdf5 groups from the domain type, domain id, subdomain id (for distribcell domains), nuclides and cross section type. two datasets for the mean and standard deviation are stored for each subdomain entry in the hdf5 file. .. note:: this requires the h5py python package. It's used for mgxs operations." }, { "instruction": "How do you call the build_hdf5_store() method in the MGXS class?", "input": "OpenMC Python API MGXS.build_hdf5_store() method signature", "output": "To call the build_hdf5_store() method, use: def build_hdf5_store(self: Any, filename: Any, directory: Any, subdomains: Any, nuclides: Any, xs_type: Any, row_column: Any, append: Any, libver: Any). It takes 9 parameters." }, { "instruction": "What does the filename parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter filename", "output": "The filename parameter filename for the hdf5 file. defaults to 'mgxs.h5'.. It should be a str value." }, { "instruction": "What does the directory parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter directory", "output": "The directory parameter directory for the hdf5 file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the subdomains parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter subdomains", "output": "The subdomains parameter the subdomain ids of the cross sections to include in the report. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the report. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will report the cross sections for all nuclides in the spatial domain. the special string 'sum' will report the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter xs_type", "output": "The xs_type parameter store the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the row_column parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter row_column", "output": "The row_column parameter store scattering matrices indexed first by incoming group and second by outgoing group ('inout'), or vice versa ('outin'). defaults to 'inout'.. It should be a {'inout', 'outin'} value." }, { "instruction": "What does the append parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter append", "output": "The append parameter if true, appends to an existing hdf5 file with the same filename directory (if one exists). defaults to true.. It should be a bool value." }, { "instruction": "What does the libver parameter do in the build_hdf5_store() method?", "input": "OpenMC Python API MGXS.build_hdf5_store() parameter libver", "output": "The libver parameter compatibility mode for the hdf5 file. 'latest' will produce files that are less backwards compatible but have performance benefits.. It should be a {'earliest', 'latest'} value." }, { "instruction": "What does the export_xs_data() method do in the MGXS class?", "input": "OpenMC Python API MGXS.export_xs_data() method", "output": "The export_xs_data() method export the multi-group cross section data to a file. this method leverages the functionality in the pandas library to export the multi-group cross section data in a variety of output file formats for storage and/or post-processing. It's used for mgxs operations." }, { "instruction": "How do you call the export_xs_data() method in the MGXS class?", "input": "OpenMC Python API MGXS.export_xs_data() method signature", "output": "To call the export_xs_data() method, use: def export_xs_data(self: Any, filename: Any, directory: Any, format: Any, groups: Any, xs_type: Any). It takes 6 parameters." }, { "instruction": "What does the filename parameter do in the export_xs_data() method?", "input": "OpenMC Python API MGXS.export_xs_data() parameter filename", "output": "The filename parameter filename for the exported file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the directory parameter do in the export_xs_data() method?", "input": "OpenMC Python API MGXS.export_xs_data() parameter directory", "output": "The directory parameter directory for the exported file. defaults to 'mgxs'.. It should be a str value." }, { "instruction": "What does the format parameter do in the export_xs_data() method?", "input": "OpenMC Python API MGXS.export_xs_data() parameter format", "output": "The format parameter the format for the exported data file. defaults to 'csv'.. It should be a {'csv', 'excel', 'pickle', 'latex'} value." }, { "instruction": "What does the groups parameter do in the export_xs_data() method?", "input": "OpenMC Python API MGXS.export_xs_data() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the xs_type parameter do in the export_xs_data() method?", "input": "OpenMC Python API MGXS.export_xs_data() parameter xs_type", "output": "The xs_type parameter store the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the get_pandas_dataframe() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method build a pandas dataframe for the mgxs data. this method leverages :meth:`openmc.tally.get_pandas_dataframe`, but renames the columns with terminology appropriate for cross section data. It's used for mgxs operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, groups: Any, nuclides: Any, xs_type: Any, paths: Any). It takes 5 parameters." }, { "instruction": "What does the groups parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MGXS.get_pandas_dataframe() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MGXS.get_pandas_dataframe() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the dataframe. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will include the cross sections for all nuclides in the spatial domain. the special string 'sum' will include the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MGXS.get_pandas_dataframe() parameter xs_type", "output": "The xs_type parameter return macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the paths parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MGXS.get_pandas_dataframe() parameter paths", "output": "The paths parameter construct columns for distribcell tally filters (default is true). the geometric information in the summary object is embedded into a multi-index column with a geometric \"path\" to each distribcell instance.. It should be a bool, optional value." }, { "instruction": "What does the get_units() method do in the MGXS class?", "input": "OpenMC Python API MGXS.get_units() method", "output": "The get_units() method this method returns the units of a mgxs based on a desired xs_type. It's used for mgxs operations." }, { "instruction": "How do you call the get_units() method in the MGXS class?", "input": "OpenMC Python API MGXS.get_units() method signature", "output": "To call the get_units() method, use: def get_units(self: Any, xs_type: Any). It takes 2 parameters." }, { "instruction": "What does the xs_type parameter do in the get_units() method?", "input": "OpenMC Python API MGXS.get_units() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section units. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What is the MatrixMGXS class in OpenMC's Python API?", "input": "OpenMC Python API MatrixMGXS class", "output": "The MatrixMGXS class represents an abstract multi-group cross section for some energy group structure\n within some spatial domain. this class is specifically intended for\n cross sections which depend on both the incoming and outgoing energy groups\n and are therefore represented by matrices. examples of this include the\n scattering and nu-fission matrices.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations.\n\n .. note:: users should instantiate the subclasses of this abstract class.. It provides 5 methods and 0 properties for working with matrixmgxs data in OpenMC." }, { "instruction": "What does the MatrixMGXS class do in OpenMC's Python API?", "input": "OpenMC Python API MatrixMGXS class description", "output": "The MatrixMGXS class an abstract multi-group cross section for some energy group structure\n within some spatial domain. this class is specifically intended for\n cross sections which depend on both the incoming and outgoing energy groups\n and are therefore represented by matrices. examples of this include the\n scattering and nu-fission matrices.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations.\n\n .. note:: users should instantiate the subclasses of this abstract class.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the _dont_squeeze() method do in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS._dont_squeeze() method", "output": "The _dont_squeeze() method create a tuple of axes which should not be removed during the get_xs\n process. It's used for matrixmgxs operations." }, { "instruction": "How do you call the _dont_squeeze() method in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS._dont_squeeze() method signature", "output": "To call the _dont_squeeze() method, use: @property def _dont_squeeze(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_xs() method do in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS.get_xs() method", "output": "The get_xs() method returns an array of multi-group cross sections. this method constructs a 4d numpy array for the requested multi-group cross section data for one or more subdomains (1st dimension), energy groups in (2nd dimension), energy groups out (3rd dimension), and nuclides (4th dimension). It's used for matrixmgxs operations." }, { "instruction": "How do you call the get_xs() method in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, in_groups: Any, out_groups: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, row_column: Any, value: Any, squeeze: Any). It takes 10 parameters." }, { "instruction": "What does the in_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter in_groups", "output": "The in_groups parameter incoming energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the out_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter out_groups", "output": "The out_groups parameter outgoing energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the row_column parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter row_column", "output": "The row_column parameter return the cross section indexed first by incoming group and second by outgoing group ('inout'), or vice versa ('outin'). defaults to 'inout'.. It should be a {'inout', 'outin'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API MatrixMGXS.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_slice() method do in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS.get_slice() method", "output": "The get_slice() method build a sliced matrixmgxs object for the specified nuclides and energy groups. this method constructs a new mgxs to encapsulate a subset of the data represented by this mgxs. the subset of data to include in the tally slice is determined by the nuclides and energy groups specified in the input parameters. It's used for matrixmgxs operations." }, { "instruction": "How do you call the get_slice() method in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, nuclides: Any, in_groups: Any, out_groups: Any). It takes 4 parameters." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API MatrixMGXS.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the in_groups parameter do in the get_slice() method?", "input": "OpenMC Python API MatrixMGXS.get_slice() parameter in_groups", "output": "The in_groups parameter a list of incoming energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the out_groups parameter do in the get_slice() method?", "input": "OpenMC Python API MatrixMGXS.get_slice() parameter out_groups", "output": "The out_groups parameter a list of outgoing energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the print_xs() method do in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS.print_xs() method", "output": "The print_xs() method prints a string representation for the multi-group cross section. It's used for matrixmgxs operations." }, { "instruction": "How do you call the print_xs() method in the MatrixMGXS class?", "input": "OpenMC Python API MatrixMGXS.print_xs() method signature", "output": "To call the print_xs() method, use: def print_xs(self: Any, subdomains: Any, nuclides: Any, xs_type: Any). It takes 4 parameters." }, { "instruction": "What does the subdomains parameter do in the print_xs() method?", "input": "OpenMC Python API MatrixMGXS.print_xs() parameter subdomains", "output": "The subdomains parameter the subdomain ids of the cross sections to include in the report. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the print_xs() method?", "input": "OpenMC Python API MatrixMGXS.print_xs() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the report. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will report the cross sections for all nuclides in the spatial domain. the special string 'sum' will report the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the print_xs() method?", "input": "OpenMC Python API MatrixMGXS.print_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What is the TotalXS class in OpenMC's Python API?", "input": "OpenMC Python API TotalXS class", "output": "The TotalXS class represents a total multi-group cross section.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group total cross sections for multi-group neutronics calculations. at\n a minimum, one needs to set the :attr:`totalxs.energy_groups` and\n :attr:`totalxs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`totalxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`totalxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n total cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\sigma_t (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It provides 1 methods and 0 properties for working with totalxs data in OpenMC." }, { "instruction": "What does the TotalXS class do in OpenMC's Python API?", "input": "OpenMC Python API TotalXS class description", "output": "The TotalXS class a total multi-group cross section.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group total cross sections for multi-group neutronics calculations. at\n a minimum, one needs to set the :attr:`totalxs.energy_groups` and\n :attr:`totalxs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`totalxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`totalxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n total cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\sigma_t (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the TotalXS class?", "input": "OpenMC Python API TotalXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "What is the TransportXS class in OpenMC's Python API?", "input": "OpenMC Python API TransportXS class", "output": "The TransportXS class represents a transport-corrected total multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`transportxs.energy_groups` and :attr:`transportxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`transportxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`transportxs.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the transport-corrected total cross section is calculated as: .. math:: \\begin{aligned} \\langle \\sigma_t \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\sigma_t (r, e) \\psi (r, e, \\omega) \\\\ \\langle \\sigma_{s1} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{-1}^1 d\\mu \\; \\mu \\sigma_s (r, e' \\rightarrow e, \\omega' \\cdot \\omega) \\phi (r, e', \\omega) \\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\sigma_{tr} &= \\frac{\\langle \\sigma_t \\phi \\rangle - \\langle \\sigma_{s1} \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned} to incorporate the effect of scattering multiplication in the above relation, the `nu` parameter can be set to `true`. It provides 9 methods and 0 properties for working with transportxs data in OpenMC." }, { "instruction": "What does the TransportXS class do in OpenMC's Python API?", "input": "OpenMC Python API TransportXS class description", "output": "The TransportXS class a transport-corrected total multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`transportxs.energy_groups` and :attr:`transportxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`transportxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`transportxs.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the transport-corrected total cross section is calculated as: .. math:: \\begin{aligned} \\langle \\sigma_t \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\sigma_t (r, e) \\psi (r, e, \\omega) \\\\ \\langle \\sigma_{s1} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{-1}^1 d\\mu \\; \\mu \\sigma_s (r, e' \\rightarrow e, \\omega' \\cdot \\omega) \\phi (r, e', \\omega) \\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\sigma_{tr} &= \\frac{\\langle \\sigma_t \\phi \\rangle - \\langle \\sigma_{s1} \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned} to incorporate the effect of scattering multiplication in the above relation, the `nu` parameter can be set to `true`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter domain", "output": "When creating a TransportXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter domain_type", "output": "When creating a TransportXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter groups", "output": "When creating a TransportXS, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the nu parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter nu", "output": "When creating a TransportXS, the nu parameter specifies if true, the cross section data will include neutron multiplication; defaults to false.. It should be a bool value." }, { "instruction": "What does the by_nuclide parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter by_nuclide", "output": "When creating a TransportXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter name", "output": "When creating a TransportXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter num_polar", "output": "When creating a TransportXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a TransportXS?", "input": "OpenMC Python API TransportXS constructor parameter num_azimuthal", "output": "When creating a TransportXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute name", "output": "The name attribute of a TransportXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a TransportXS instance." }, { "instruction": "What is the rxn_type attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute rxn_type", "output": "The rxn_type attribute of a TransportXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a TransportXS instance." }, { "instruction": "What is the nu attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute nu", "output": "The nu attribute of a TransportXS contains if true, the cross section data will include neutron multiplication. It's a bool value that you can access after creating a TransportXS instance." }, { "instruction": "What is the by_nuclide attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute by_nuclide", "output": "The by_nuclide attribute of a TransportXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a TransportXS instance." }, { "instruction": "What is the domain attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute domain", "output": "The domain attribute of a TransportXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a TransportXS instance." }, { "instruction": "What is the domain_type attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute domain_type", "output": "The domain_type attribute of a TransportXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a TransportXS instance." }, { "instruction": "What is the energy_groups attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute energy_groups", "output": "The energy_groups attribute of a TransportXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a TransportXS instance." }, { "instruction": "What is the num_polar attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute num_polar", "output": "The num_polar attribute of a TransportXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a TransportXS instance." }, { "instruction": "What is the num_azimuthal attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a TransportXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a TransportXS instance." }, { "instruction": "What is the tally_trigger attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute tally_trigger", "output": "The tally_trigger attribute of a TransportXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a TransportXS instance." }, { "instruction": "What is the scores attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute scores", "output": "The scores attribute of a TransportXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a TransportXS instance." }, { "instruction": "What is the filters attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute filters", "output": "The filters attribute of a TransportXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a TransportXS instance." }, { "instruction": "What is the tally_keys attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute tally_keys", "output": "The tally_keys attribute of a TransportXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a TransportXS instance." }, { "instruction": "What is the estimator attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute estimator", "output": "The estimator attribute of a TransportXS contains the tally estimator used to compute the multi-group cross section. It's a 'analog' value that you can access after creating a TransportXS instance." }, { "instruction": "What is the tallies attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute tallies", "output": "The tallies attribute of a TransportXS contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`transportxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a TransportXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a TransportXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a TransportXS instance." }, { "instruction": "What is the xs_tally attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute xs_tally", "output": "The xs_tally attribute of a TransportXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a TransportXS instance." }, { "instruction": "What is the num_subdomains attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute num_subdomains", "output": "The num_subdomains attribute of a TransportXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a TransportXS instance." }, { "instruction": "What is the num_nuclides attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute num_nuclides", "output": "The num_nuclides attribute of a TransportXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a TransportXS instance." }, { "instruction": "What is the nuclides attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute nuclides", "output": "The nuclides attribute of a TransportXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a TransportXS instance." }, { "instruction": "What is the sparse attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute sparse", "output": "The sparse attribute of a TransportXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a TransportXS instance." }, { "instruction": "What is the loaded_sp attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute loaded_sp", "output": "The loaded_sp attribute of a TransportXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a TransportXS instance." }, { "instruction": "What is the derived attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute derived", "output": "The derived attribute of a TransportXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a TransportXS instance." }, { "instruction": "What is the mgxs_type attribute of a TransportXS?", "input": "OpenMC Python API TransportXS attribute mgxs_type", "output": "The mgxs_type attribute of a TransportXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a TransportXS instance." }, { "instruction": "How do you call the __init__() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, nu: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the scores() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_keys() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.tally_keys() method signature", "output": "To call the tally_keys() method, use: @property def tally_keys(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nu() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.nu() method signature", "output": "To call the nu() method, use: @property def nu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nu() method in the TransportXS class?", "input": "OpenMC Python API TransportXS.nu() method signature", "output": "To call the nu() method, use: @nu.setter def nu(self: Any, nu: Any). It takes 2 parameters." }, { "instruction": "What is the DiffusionCoefficient class in OpenMC's Python API?", "input": "OpenMC Python API DiffusionCoefficient class", "output": "The DiffusionCoefficient class represents a diffusion coefficient multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`diffusioncoefficient.energy_groups` and :attr:`diffusioncoefficient.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`diffusioncoefficient.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`diffusioncoefficient.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the diffusion coefficient is calculated as: .. math:: \\begin{aligned} \\langle \\sigma_t \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\sigma_t (r, e) \\psi (r, e, \\omega) \\\\ \\langle \\sigma_{s1} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{-1}^1 d\\mu \\; \\mu \\sigma_s (r, e' \\rightarrow e, \\omega' \\cdot \\omega) \\phi (r, e', \\omega) \\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\sigma_{tr} &= \\frac{\\langle \\sigma_t \\phi \\rangle - \\langle \\sigma_{s1} \\phi \\rangle}{\\langle \\phi \\rangle} \\\\ d = \\frac{1}{3 \\sigma_{tr}} \\end{aligned} to incorporate the effect of scattering multiplication in the above relation, the `nu` parameter can be set to `true`. .. versionadded:: 0.12.1. It provides 4 methods and 0 properties for working with diffusioncoefficient data in OpenMC." }, { "instruction": "What does the DiffusionCoefficient class do in OpenMC's Python API?", "input": "OpenMC Python API DiffusionCoefficient class description", "output": "The DiffusionCoefficient class a diffusion coefficient multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`diffusioncoefficient.energy_groups` and :attr:`diffusioncoefficient.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`diffusioncoefficient.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`diffusioncoefficient.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the diffusion coefficient is calculated as: .. math:: \\begin{aligned} \\langle \\sigma_t \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\sigma_t (r, e) \\psi (r, e, \\omega) \\\\ \\langle \\sigma_{s1} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{-1}^1 d\\mu \\; \\mu \\sigma_s (r, e' \\rightarrow e, \\omega' \\cdot \\omega) \\phi (r, e', \\omega) \\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\sigma_{tr} &= \\frac{\\langle \\sigma_t \\phi \\rangle - \\langle \\sigma_{s1} \\phi \\rangle}{\\langle \\phi \\rangle} \\\\ d = \\frac{1}{3 \\sigma_{tr}} \\end{aligned} to incorporate the effect of scattering multiplication in the above relation, the `nu` parameter can be set to `true`. .. versionadded:: 0.12.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter domain", "output": "When creating a DiffusionCoefficient, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter domain_type", "output": "When creating a DiffusionCoefficient, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter groups", "output": "When creating a DiffusionCoefficient, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the nu parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter nu", "output": "When creating a DiffusionCoefficient, the nu parameter specifies if true, the cross section data will include neutron multiplication; defaults to false.. It should be a bool value." }, { "instruction": "What does the by_nuclide parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter by_nuclide", "output": "When creating a DiffusionCoefficient, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter name", "output": "When creating a DiffusionCoefficient, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter num_polar", "output": "When creating a DiffusionCoefficient, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient constructor parameter num_azimuthal", "output": "When creating a DiffusionCoefficient, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute name", "output": "The name attribute of a DiffusionCoefficient contains name of the multi-group cross section. It's a str, optional value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the rxn_type attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute rxn_type", "output": "The rxn_type attribute of a DiffusionCoefficient contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the nu attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute nu", "output": "The nu attribute of a DiffusionCoefficient contains if true, the cross section data will include neutron multiplication. It's a bool value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the by_nuclide attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute by_nuclide", "output": "The by_nuclide attribute of a DiffusionCoefficient contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the domain attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute domain", "output": "The domain attribute of a DiffusionCoefficient contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the domain_type attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute domain_type", "output": "The domain_type attribute of a DiffusionCoefficient contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the energy_groups attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute energy_groups", "output": "The energy_groups attribute of a DiffusionCoefficient contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the num_polar attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute num_polar", "output": "The num_polar attribute of a DiffusionCoefficient contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the num_azimuthal attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute num_azimuthal", "output": "The num_azimuthal attribute of a DiffusionCoefficient contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the tally_trigger attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute tally_trigger", "output": "The tally_trigger attribute of a DiffusionCoefficient contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the scores attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute scores", "output": "The scores attribute of a DiffusionCoefficient contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the filters attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute filters", "output": "The filters attribute of a DiffusionCoefficient contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the tally_keys attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute tally_keys", "output": "The tally_keys attribute of a DiffusionCoefficient contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the estimator attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute estimator", "output": "The estimator attribute of a DiffusionCoefficient contains the tally estimator used to compute the multi-group cross section. It's a 'analog' value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the tallies attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute tallies", "output": "The tallies attribute of a DiffusionCoefficient contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`transportxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the rxn_rate_tally attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a DiffusionCoefficient contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the xs_tally attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute xs_tally", "output": "The xs_tally attribute of a DiffusionCoefficient contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the num_subdomains attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute num_subdomains", "output": "The num_subdomains attribute of a DiffusionCoefficient contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the num_nuclides attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute num_nuclides", "output": "The num_nuclides attribute of a DiffusionCoefficient contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the nuclides attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute nuclides", "output": "The nuclides attribute of a DiffusionCoefficient contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the sparse attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute sparse", "output": "The sparse attribute of a DiffusionCoefficient contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the loaded_sp attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute loaded_sp", "output": "The loaded_sp attribute of a DiffusionCoefficient contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the derived attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute derived", "output": "The derived attribute of a DiffusionCoefficient contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "What is the mgxs_type attribute of a DiffusionCoefficient?", "input": "OpenMC Python API DiffusionCoefficient attribute mgxs_type", "output": "The mgxs_type attribute of a DiffusionCoefficient contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a DiffusionCoefficient instance." }, { "instruction": "How do you call the __init__() method in the DiffusionCoefficient class?", "input": "OpenMC Python API DiffusionCoefficient.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, nu: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the DiffusionCoefficient class?", "input": "OpenMC Python API DiffusionCoefficient.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the DiffusionCoefficient class?", "input": "OpenMC Python API DiffusionCoefficient.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_condensed_xs() method do in the DiffusionCoefficient class?", "input": "OpenMC Python API DiffusionCoefficient.get_condensed_xs() method", "output": "The get_condensed_xs() method construct an energy-condensed version of this cross section. It's used for diffusioncoefficient operations." }, { "instruction": "How do you call the get_condensed_xs() method in the DiffusionCoefficient class?", "input": "OpenMC Python API DiffusionCoefficient.get_condensed_xs() method signature", "output": "To call the get_condensed_xs() method, use: def get_condensed_xs(self: Any, coarse_groups: Any). It takes 2 parameters." }, { "instruction": "What does the coarse_groups parameter do in the get_condensed_xs() method?", "input": "OpenMC Python API DiffusionCoefficient.get_condensed_xs() parameter coarse_groups", "output": "The coarse_groups parameter the coarse energy group structure of interest. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What is the AbsorptionXS class in OpenMC's Python API?", "input": "OpenMC Python API AbsorptionXS class", "output": "The AbsorptionXS class represents an absorption multi-group cross section.\n\n absorption is defined as all reactions that do not produce secondary\n neutrons (disappearance) plus fission reactions.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group absorption cross sections for multi-group neutronics\n calculations. at a minimum, one needs to set the\n :attr:`absorptionxs.energy_groups` and :attr:`absorptionxs.domain`\n properties. tallies for the flux and appropriate reaction rates over the\n specified domain are generated automatically via the\n :attr:`absorptionxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`absorptionxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n absorption cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\sigma_a (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It provides 1 methods and 0 properties for working with absorptionxs data in OpenMC." }, { "instruction": "What does the AbsorptionXS class do in OpenMC's Python API?", "input": "OpenMC Python API AbsorptionXS class description", "output": "The AbsorptionXS class an absorption multi-group cross section.\n\n absorption is defined as all reactions that do not produce secondary\n neutrons (disappearance) plus fission reactions.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group absorption cross sections for multi-group neutronics\n calculations. at a minimum, one needs to set the\n :attr:`absorptionxs.energy_groups` and :attr:`absorptionxs.domain`\n properties. tallies for the flux and appropriate reaction rates over the\n specified domain are generated automatically via the\n :attr:`absorptionxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`absorptionxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n absorption cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\sigma_a (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the AbsorptionXS class?", "input": "OpenMC Python API AbsorptionXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "What is the ReducedAbsorptionXS class in OpenMC's Python API?", "input": "OpenMC Python API ReducedAbsorptionXS class", "output": "The ReducedAbsorptionXS class represents a reduced absorption multi-group cross section.\n\n the reduced absorption reaction rate is defined as the difference between\n absorption and the production of neutrons due to (n,xn) reactions.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group capture cross sections for multi-group neutronics calculations.\n at a minimum, one needs to set the :attr:`capturexs.energy_groups` and\n :attr:`capturexs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`capturexs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`capturexs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n reduced absorption cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\left(\\sigma_a (r, e) - \\sigma_{n,2n}(r,e) - 2\\sigma_{n,3n}(r,e) -\n 3\\sigma_{n,4n}(r,e) \\right) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.\n\n .. versionadded:: 0.13.1. It provides 3 methods and 0 properties for working with reducedabsorptionxs data in OpenMC." }, { "instruction": "What does the ReducedAbsorptionXS class do in OpenMC's Python API?", "input": "OpenMC Python API ReducedAbsorptionXS class description", "output": "The ReducedAbsorptionXS class a reduced absorption multi-group cross section.\n\n the reduced absorption reaction rate is defined as the difference between\n absorption and the production of neutrons due to (n,xn) reactions.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group capture cross sections for multi-group neutronics calculations.\n at a minimum, one needs to set the :attr:`capturexs.energy_groups` and\n :attr:`capturexs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`capturexs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`capturexs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n reduced absorption cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\left(\\sigma_a (r, e) - \\sigma_{n,2n}(r,e) - 2\\sigma_{n,3n}(r,e) -\n 3\\sigma_{n,4n}(r,e) \\right) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.\n\n .. versionadded:: 0.13.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the ReducedAbsorptionXS class?", "input": "OpenMC Python API ReducedAbsorptionXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "How do you call the scores() method in the ReducedAbsorptionXS class?", "input": "OpenMC Python API ReducedAbsorptionXS.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the ReducedAbsorptionXS class?", "input": "OpenMC Python API ReducedAbsorptionXS.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "What is the CaptureXS class in OpenMC's Python API?", "input": "OpenMC Python API CaptureXS class", "output": "The CaptureXS class represents a capture multi-group cross section.\n\n the neutron capture reaction rate is defined as the difference between\n openmc's 'absorption' and 'fission' reaction rate score types. this includes\n not only radiative capture, but all forms of neutron disappearance aside\n from fission (i.e., mt > 100).\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group capture cross sections for multi-group neutronics\n calculations. at a minimum, one needs to set the\n :attr:`capturexs.energy_groups` and :attr:`capturexs.domain`\n properties. tallies for the flux and appropriate reaction rates over the\n specified domain are generated automatically via the\n :attr:`capturexs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`capturexs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n capture cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\left [ \\sigma_a (r, e) \\psi (r, e, \\omega) - \\sigma_f (r, e) \\psi (r, e,\n \\omega) \\right ]}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega\n \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It provides 3 methods and 0 properties for working with capturexs data in OpenMC." }, { "instruction": "What does the CaptureXS class do in OpenMC's Python API?", "input": "OpenMC Python API CaptureXS class description", "output": "The CaptureXS class a capture multi-group cross section.\n\n the neutron capture reaction rate is defined as the difference between\n openmc's 'absorption' and 'fission' reaction rate score types. this includes\n not only radiative capture, but all forms of neutron disappearance aside\n from fission (i.e., mt > 100).\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group capture cross sections for multi-group neutronics\n calculations. at a minimum, one needs to set the\n :attr:`capturexs.energy_groups` and :attr:`capturexs.domain`\n properties. tallies for the flux and appropriate reaction rates over the\n specified domain are generated automatically via the\n :attr:`capturexs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`capturexs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n capture cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\left [ \\sigma_a (r, e) \\psi (r, e, \\omega) - \\sigma_f (r, e) \\psi (r, e,\n \\omega) \\right ]}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega\n \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the CaptureXS class?", "input": "OpenMC Python API CaptureXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "How do you call the scores() method in the CaptureXS class?", "input": "OpenMC Python API CaptureXS.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the CaptureXS class?", "input": "OpenMC Python API CaptureXS.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "What is the FissionXS class in OpenMC's Python API?", "input": "OpenMC Python API FissionXS class", "output": "The FissionXS class represents a fission multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group fission cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`fissionxs.energy_groups` and :attr:`fissionxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`fissionxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`fissionxs.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the fission cross section is calculated as: .. math:: \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\sigma_f (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. to incorporate the effect of neutron multiplication in the above relation, the `nu` parameter can be set to `true`. this class can also be used to gather a prompt-nu-fission cross section (which only includes the contributions from prompt neutrons). this is accomplished by setting the :attr:`fissionxs.prompt` attribute to `true`. since the prompt-nu-fission cross section requires neutron multiplication, the `nu` parameter will automatically be set to `true` if `prompt` is also `true`. It provides 6 methods and 0 properties for working with fissionxs data in OpenMC." }, { "instruction": "What does the FissionXS class do in OpenMC's Python API?", "input": "OpenMC Python API FissionXS class description", "output": "The FissionXS class a fission multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group fission cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`fissionxs.energy_groups` and :attr:`fissionxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`fissionxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`fissionxs.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the fission cross section is calculated as: .. math:: \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\sigma_f (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. to incorporate the effect of neutron multiplication in the above relation, the `nu` parameter can be set to `true`. this class can also be used to gather a prompt-nu-fission cross section (which only includes the contributions from prompt neutrons). this is accomplished by setting the :attr:`fissionxs.prompt` attribute to `true`. since the prompt-nu-fission cross section requires neutron multiplication, the `nu` parameter will automatically be set to `true` if `prompt` is also `true`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter domain", "output": "When creating a FissionXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter domain_type", "output": "When creating a FissionXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter groups", "output": "When creating a FissionXS, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the nu parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter nu", "output": "When creating a FissionXS, the nu parameter specifies if true, the cross section data will include neutron multiplication; defaults to false. It should be a bool value." }, { "instruction": "What does the prompt parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter prompt", "output": "When creating a FissionXS, the prompt parameter specifies if true, computes cross sections which only includes prompt neutrons; defaults to false which includes prompt and delayed in total. setting this to true will also set nu to true. It should be a bool value." }, { "instruction": "What does the by_nuclide parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter by_nuclide", "output": "When creating a FissionXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter name", "output": "When creating a FissionXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter num_polar", "output": "When creating a FissionXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a FissionXS?", "input": "OpenMC Python API FissionXS constructor parameter num_azimuthal", "output": "When creating a FissionXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute name", "output": "The name attribute of a FissionXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a FissionXS instance." }, { "instruction": "What is the rxn_type attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute rxn_type", "output": "The rxn_type attribute of a FissionXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a FissionXS instance." }, { "instruction": "What is the nu attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute nu", "output": "The nu attribute of a FissionXS contains if true, the cross section data will include neutron multiplication. It's a bool value that you can access after creating a FissionXS instance." }, { "instruction": "What is the prompt attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute prompt", "output": "The prompt attribute of a FissionXS contains if true, computes cross sections which only includes prompt neutrons. It's a bool value that you can access after creating a FissionXS instance." }, { "instruction": "What is the by_nuclide attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute by_nuclide", "output": "The by_nuclide attribute of a FissionXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a FissionXS instance." }, { "instruction": "What is the domain attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute domain", "output": "The domain attribute of a FissionXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a FissionXS instance." }, { "instruction": "What is the domain_type attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute domain_type", "output": "The domain_type attribute of a FissionXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a FissionXS instance." }, { "instruction": "What is the energy_groups attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute energy_groups", "output": "The energy_groups attribute of a FissionXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a FissionXS instance." }, { "instruction": "What is the num_polar attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute num_polar", "output": "The num_polar attribute of a FissionXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a FissionXS instance." }, { "instruction": "What is the num_azimuthal attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a FissionXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a FissionXS instance." }, { "instruction": "What is the tally_trigger attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute tally_trigger", "output": "The tally_trigger attribute of a FissionXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a FissionXS instance." }, { "instruction": "What is the scores attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute scores", "output": "The scores attribute of a FissionXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a FissionXS instance." }, { "instruction": "What is the filters attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute filters", "output": "The filters attribute of a FissionXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a FissionXS instance." }, { "instruction": "What is the tally_keys attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute tally_keys", "output": "The tally_keys attribute of a FissionXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a FissionXS instance." }, { "instruction": "What is the estimator attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute estimator", "output": "The estimator attribute of a FissionXS contains the tally estimator used to compute the multi-group cross section. It's a {'tracklength', 'collision', 'analog'} value that you can access after creating a FissionXS instance." }, { "instruction": "What is the tallies attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute tallies", "output": "The tallies attribute of a FissionXS contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`fissionxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a FissionXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a FissionXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a FissionXS instance." }, { "instruction": "What is the xs_tally attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute xs_tally", "output": "The xs_tally attribute of a FissionXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a FissionXS instance." }, { "instruction": "What is the num_subdomains attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute num_subdomains", "output": "The num_subdomains attribute of a FissionXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a FissionXS instance." }, { "instruction": "What is the num_nuclides attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute num_nuclides", "output": "The num_nuclides attribute of a FissionXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a FissionXS instance." }, { "instruction": "What is the nuclides attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute nuclides", "output": "The nuclides attribute of a FissionXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a FissionXS instance." }, { "instruction": "What is the sparse attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute sparse", "output": "The sparse attribute of a FissionXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a FissionXS instance." }, { "instruction": "What is the loaded_sp attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute loaded_sp", "output": "The loaded_sp attribute of a FissionXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a FissionXS instance." }, { "instruction": "What is the derived attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute derived", "output": "The derived attribute of a FissionXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a FissionXS instance." }, { "instruction": "What is the mgxs_type attribute of a FissionXS?", "input": "OpenMC Python API FissionXS attribute mgxs_type", "output": "The mgxs_type attribute of a FissionXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a FissionXS instance." }, { "instruction": "How do you call the __init__() method in the FissionXS class?", "input": "OpenMC Python API FissionXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, nu: Any, prompt: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 10 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the FissionXS class?", "input": "OpenMC Python API FissionXS.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the nu() method in the FissionXS class?", "input": "OpenMC Python API FissionXS.nu() method signature", "output": "To call the nu() method, use: @property def nu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nu() method in the FissionXS class?", "input": "OpenMC Python API FissionXS.nu() method signature", "output": "To call the nu() method, use: @nu.setter def nu(self: Any, nu: Any). It takes 2 parameters." }, { "instruction": "How do you call the prompt() method in the FissionXS class?", "input": "OpenMC Python API FissionXS.prompt() method signature", "output": "To call the prompt() method, use: @property def prompt(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the prompt() method in the FissionXS class?", "input": "OpenMC Python API FissionXS.prompt() method signature", "output": "To call the prompt() method, use: @prompt.setter def prompt(self: Any, prompt: Any). It takes 2 parameters." }, { "instruction": "What is the KappaFissionXS class in OpenMC's Python API?", "input": "OpenMC Python API KappaFissionXS class", "output": "The KappaFissionXS class represents a recoverable fission energy production rate multi-group cross section.\n\n the recoverable energy per fission, :math:`\\kappa`, is defined as the\n fission product kinetic energy, prompt and delayed neutron kinetic energies,\n prompt and delayed :math:`\\gamma`-ray total energies, and the total energy\n released by the delayed :math:`\\beta` particles. the neutrino energy does\n not contribute to this response. the prompt and delayed :math:`\\gamma`-rays\n are assumed to deposit their energy locally.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`kappafissionxs.energy_groups` and\n :attr:`kappafissionxs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`kappafissionxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`kappafissionxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n recoverable fission energy production rate cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\kappa\\sigma_f (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It provides 1 methods and 0 properties for working with kappafissionxs data in OpenMC." }, { "instruction": "What does the KappaFissionXS class do in OpenMC's Python API?", "input": "OpenMC Python API KappaFissionXS class description", "output": "The KappaFissionXS class a recoverable fission energy production rate multi-group cross section.\n\n the recoverable energy per fission, :math:`\\kappa`, is defined as the\n fission product kinetic energy, prompt and delayed neutron kinetic energies,\n prompt and delayed :math:`\\gamma`-ray total energies, and the total energy\n released by the delayed :math:`\\beta` particles. the neutrino energy does\n not contribute to this response. the prompt and delayed :math:`\\gamma`-rays\n are assumed to deposit their energy locally.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`kappafissionxs.energy_groups` and\n :attr:`kappafissionxs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`kappafissionxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`kappafissionxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n recoverable fission energy production rate cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\kappa\\sigma_f (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the KappaFissionXS class?", "input": "OpenMC Python API KappaFissionXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "What is the ScatterXS class in OpenMC's Python API?", "input": "OpenMC Python API ScatterXS class", "output": "The ScatterXS class represents a scattering multi-group cross section. the scattering cross section is defined as the difference between the total and absorption cross sections. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`scatterxs.energy_groups` and :attr:`scatterxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`scatterxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`scatterxs.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the scattering cross section is calculated as: .. math:: \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\left [ \\sigma_t (r, e) \\psi (r, e, \\omega) - \\sigma_a (r, e) \\psi (r, e, \\omega) \\right ]}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. to incorporate the effect of scattering multiplication from (n,xn) reactions in the above relation, the `nu` parameter can be set to `true`. It provides 4 methods and 0 properties for working with scatterxs data in OpenMC." }, { "instruction": "What does the ScatterXS class do in OpenMC's Python API?", "input": "OpenMC Python API ScatterXS class description", "output": "The ScatterXS class a scattering multi-group cross section. the scattering cross section is defined as the difference between the total and absorption cross sections. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`scatterxs.energy_groups` and :attr:`scatterxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`scatterxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`scatterxs.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the scattering cross section is calculated as: .. math:: \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\left [ \\sigma_t (r, e) \\psi (r, e, \\omega) - \\sigma_a (r, e) \\psi (r, e, \\omega) \\right ]}{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. to incorporate the effect of scattering multiplication from (n,xn) reactions in the above relation, the `nu` parameter can be set to `true`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter domain", "output": "When creating a ScatterXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter domain_type", "output": "When creating a ScatterXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter groups", "output": "When creating a ScatterXS, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter by_nuclide", "output": "When creating a ScatterXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter name", "output": "When creating a ScatterXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter num_polar", "output": "When creating a ScatterXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter num_azimuthal", "output": "When creating a ScatterXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the nu parameter do when creating a ScatterXS?", "input": "OpenMC Python API ScatterXS constructor parameter nu", "output": "When creating a ScatterXS, the nu parameter specifies if true, the cross section data will include neutron multiplication; defaults to false. It should be a bool value." }, { "instruction": "What is the name attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute name", "output": "The name attribute of a ScatterXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the rxn_type attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute rxn_type", "output": "The rxn_type attribute of a ScatterXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the nu attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute nu", "output": "The nu attribute of a ScatterXS contains if true, the cross section data will include neutron multiplication. It's a bool value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the by_nuclide attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute by_nuclide", "output": "The by_nuclide attribute of a ScatterXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the domain attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute domain", "output": "The domain attribute of a ScatterXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the domain_type attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute domain_type", "output": "The domain_type attribute of a ScatterXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the energy_groups attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute energy_groups", "output": "The energy_groups attribute of a ScatterXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the num_polar attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute num_polar", "output": "The num_polar attribute of a ScatterXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the num_azimuthal attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a ScatterXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the tally_trigger attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute tally_trigger", "output": "The tally_trigger attribute of a ScatterXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the scores attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute scores", "output": "The scores attribute of a ScatterXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the filters attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute filters", "output": "The filters attribute of a ScatterXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the tally_keys attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute tally_keys", "output": "The tally_keys attribute of a ScatterXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the estimator attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute estimator", "output": "The estimator attribute of a ScatterXS contains the tally estimator used to compute the multi-group cross section. It's a {'tracklength', 'collision', 'analog'} value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the tallies attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute tallies", "output": "The tallies attribute of a ScatterXS contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`scatterxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a ScatterXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the xs_tally attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute xs_tally", "output": "The xs_tally attribute of a ScatterXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the num_subdomains attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute num_subdomains", "output": "The num_subdomains attribute of a ScatterXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the num_nuclides attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute num_nuclides", "output": "The num_nuclides attribute of a ScatterXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the nuclides attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute nuclides", "output": "The nuclides attribute of a ScatterXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the sparse attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute sparse", "output": "The sparse attribute of a ScatterXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the loaded_sp attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute loaded_sp", "output": "The loaded_sp attribute of a ScatterXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the derived attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute derived", "output": "The derived attribute of a ScatterXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a ScatterXS instance." }, { "instruction": "What is the mgxs_type attribute of a ScatterXS?", "input": "OpenMC Python API ScatterXS attribute mgxs_type", "output": "The mgxs_type attribute of a ScatterXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a ScatterXS instance." }, { "instruction": "How do you call the __init__() method in the ScatterXS class?", "input": "OpenMC Python API ScatterXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any, nu: Any). It takes 9 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the ScatterXS class?", "input": "OpenMC Python API ScatterXS.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the nu() method in the ScatterXS class?", "input": "OpenMC Python API ScatterXS.nu() method signature", "output": "To call the nu() method, use: @property def nu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nu() method in the ScatterXS class?", "input": "OpenMC Python API ScatterXS.nu() method signature", "output": "To call the nu() method, use: @nu.setter def nu(self: Any, nu: Any). It takes 2 parameters." }, { "instruction": "What is the ArbitraryXS class in OpenMC's Python API?", "input": "OpenMC Python API ArbitraryXS class", "output": "The ArbitraryXS class represents a multi-group cross section for an arbitrary reaction type.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group total cross sections for multi-group neutronics calculations.\n at a minimum, one needs to set the :attr:`arbitraryxs.energy_groups` and\n :attr:`arbitraryxs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`arbitraryxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`arbitraryxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n requested cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\sigma_x (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}\n\n where :math:`\\sigma_x` is the requested reaction type of interest.. It provides 1 methods and 0 properties for working with arbitraryxs data in OpenMC." }, { "instruction": "What does the ArbitraryXS class do in OpenMC's Python API?", "input": "OpenMC Python API ArbitraryXS class description", "output": "The ArbitraryXS class a multi-group cross section for an arbitrary reaction type.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group total cross sections for multi-group neutronics calculations.\n at a minimum, one needs to set the :attr:`arbitraryxs.energy_groups` and\n :attr:`arbitraryxs.domain` properties. tallies for the flux and appropriate\n reaction rates over the specified domain are generated automatically via the\n :attr:`arbitraryxs.tallies` property, which can then be appended to a\n :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`arbitraryxs.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n requested cross section is calculated as:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\sigma_x (r, e) \\psi (r, e, \\omega)}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}\n\n where :math:`\\sigma_x` is the requested reaction type of interest.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the ArbitraryXS class?", "input": "OpenMC Python API ArbitraryXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, rxn_type: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "What is the ArbitraryMatrixXS class in OpenMC's Python API?", "input": "OpenMC Python API ArbitraryMatrixXS class", "output": "The ArbitraryMatrixXS class represents a multi-group matrix cross section for an arbitrary reaction type.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`arbitrarymatrixxs.energy_groups` and\n :attr:`arbitrarymatrixxs.domain` properties. tallies for the flux and\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`arbitrarymatrixxs.tallies` property, which can\n then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`arbitrarymatrixxs.xs_tally` property.\n\n for a spatial domain :math:`v`, incoming energy group\n :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`,\n the fission production is calculated as:\n\n .. math::\n\n \\begin{aligned}\n \\langle \\sigma_{x,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{e_g}^{e_{g-1}} de\n \\; \\chi(e) \\sigma_x (r, e') \\psi(r, e', \\omega')\\\\\n \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega\n \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\\n \\sigma_{x,g'\\rightarrow g} &= \\frac{\\langle \\sigma_{x,g'\\rightarrow\n g} \\phi \\rangle}{\\langle \\phi \\rangle}\n \\end{aligned}\n\n where :math:`\\sigma_x` is the requested reaction type of interest.. It provides 1 methods and 0 properties for working with arbitrarymatrixxs data in OpenMC." }, { "instruction": "What does the ArbitraryMatrixXS class do in OpenMC's Python API?", "input": "OpenMC Python API ArbitraryMatrixXS class description", "output": "The ArbitraryMatrixXS class a multi-group matrix cross section for an arbitrary reaction type.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`arbitrarymatrixxs.energy_groups` and\n :attr:`arbitrarymatrixxs.domain` properties. tallies for the flux and\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`arbitrarymatrixxs.tallies` property, which can\n then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`arbitrarymatrixxs.xs_tally` property.\n\n for a spatial domain :math:`v`, incoming energy group\n :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`,\n the fission production is calculated as:\n\n .. math::\n\n \\begin{aligned}\n \\langle \\sigma_{x,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{e_g}^{e_{g-1}} de\n \\; \\chi(e) \\sigma_x (r, e') \\psi(r, e', \\omega')\\\\\n \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega\n \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\\n \\sigma_{x,g'\\rightarrow g} &= \\frac{\\langle \\sigma_{x,g'\\rightarrow\n g} \\phi \\rangle}{\\langle \\phi \\rangle}\n \\end{aligned}\n\n where :math:`\\sigma_x` is the requested reaction type of interest.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the ArbitraryMatrixXS class?", "input": "OpenMC Python API ArbitraryMatrixXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, rxn_type: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "What is the ScatterMatrixXS class in OpenMC's Python API?", "input": "OpenMC Python API ScatterMatrixXS class", "output": "The ScatterMatrixXS class represents a scattering matrix multi-group cross section with the cosine of the change-in-angle represented as one or more legendre moments or a histogram. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`scattermatrixxs.energy_groups` and :attr:`scattermatrixxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`scattermatrixxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`scattermatrixxs.xs_tally` property. for a spatial domain :math:`v`, incoming energy group :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`, the legendre scattering moments are calculated as: .. math:: \\begin{aligned} \\langle \\sigma_{s,\\ell,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; p_\\ell (\\omega \\cdot \\omega') \\sigma_s (r, e' \\rightarrow e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega')\\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\sigma_{s,\\ell,g'\\rightarrow g} &= \\frac{\\langle \\sigma_{s,\\ell,g'\\rightarrow g} \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned} if the order is zero and a :math:`p_0` transport-correction is applied (default), the scattering matrix elements are: .. math:: \\sigma_{s,g'\\rightarrow g} = \\frac{\\langle \\sigma_{s,0,g'\\rightarrow g} \\phi \\rangle - \\delta_{gg'} \\sum_{g''} \\langle \\sigma_{s,1,g''\\rightarrow g} \\phi \\rangle}{\\langle \\phi \\rangle} to incorporate the effect of neutron multiplication from (n,xn) reactions in the above relation, the `nu` parameter can be set to `true`. an alternative form of the scattering matrix is computed when the `formulation` property is set to 'consistent' rather than the default of 'simple'. this formulation computes the scattering matrix multi-group cross section as the product of the scatter cross section and group-to-group scattering probabilities. unlike the default 'simple' formulation, the 'consistent' formulation is computed from the groupwise scattering cross section which uses a tracklength estimator. this ensures that reaction rate balance is exactly preserved with a :class:`totalxs` computed using a tracklength estimator. for a scattering probability matrix :math:`p_{s,\\ell,g'\\rightarrow g}` and scattering cross section :math:`\\sigma_s (r, e)` for incoming energy group :math:`[e_{g'},e_{g'-1}]` and outgoing energy group :math:`[e_g,e_{g-1}]`, the legendre scattering moments are calculated as: .. math:: \\sigma_{s,\\ell,g'\\rightarrow g} = \\sigma_s (r, e) \\times p_{s,\\ell,g'\\rightarrow g} to incorporate the effect of neutron multiplication from (n,xn) reactions in the 'consistent' scattering matrix, the `nu` parameter can be set to `true` such that the legendre scattering moments are calculated as: .. math:: \\sigma_{s,\\ell,g'\\rightarrow g} = \\upsilon_{g'\\rightarrow g} \\times \\sigma_s (r, e) \\times p_{s,\\ell,g'\\rightarrow g}. It provides 26 methods and 0 properties for working with scattermatrixxs data in OpenMC." }, { "instruction": "What does the ScatterMatrixXS class do in OpenMC's Python API?", "input": "OpenMC Python API ScatterMatrixXS class description", "output": "The ScatterMatrixXS class a scattering matrix multi-group cross section with the cosine of the change-in-angle represented as one or more legendre moments or a histogram. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`scattermatrixxs.energy_groups` and :attr:`scattermatrixxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`scattermatrixxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`scattermatrixxs.xs_tally` property. for a spatial domain :math:`v`, incoming energy group :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`, the legendre scattering moments are calculated as: .. math:: \\begin{aligned} \\langle \\sigma_{s,\\ell,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; p_\\ell (\\omega \\cdot \\omega') \\sigma_s (r, e' \\rightarrow e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega')\\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\sigma_{s,\\ell,g'\\rightarrow g} &= \\frac{\\langle \\sigma_{s,\\ell,g'\\rightarrow g} \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned} if the order is zero and a :math:`p_0` transport-correction is applied (default), the scattering matrix elements are: .. math:: \\sigma_{s,g'\\rightarrow g} = \\frac{\\langle \\sigma_{s,0,g'\\rightarrow g} \\phi \\rangle - \\delta_{gg'} \\sum_{g''} \\langle \\sigma_{s,1,g''\\rightarrow g} \\phi \\rangle}{\\langle \\phi \\rangle} to incorporate the effect of neutron multiplication from (n,xn) reactions in the above relation, the `nu` parameter can be set to `true`. an alternative form of the scattering matrix is computed when the `formulation` property is set to 'consistent' rather than the default of 'simple'. this formulation computes the scattering matrix multi-group cross section as the product of the scatter cross section and group-to-group scattering probabilities. unlike the default 'simple' formulation, the 'consistent' formulation is computed from the groupwise scattering cross section which uses a tracklength estimator. this ensures that reaction rate balance is exactly preserved with a :class:`totalxs` computed using a tracklength estimator. for a scattering probability matrix :math:`p_{s,\\ell,g'\\rightarrow g}` and scattering cross section :math:`\\sigma_s (r, e)` for incoming energy group :math:`[e_{g'},e_{g'-1}]` and outgoing energy group :math:`[e_g,e_{g-1}]`, the legendre scattering moments are calculated as: .. math:: \\sigma_{s,\\ell,g'\\rightarrow g} = \\sigma_s (r, e) \\times p_{s,\\ell,g'\\rightarrow g} to incorporate the effect of neutron multiplication from (n,xn) reactions in the 'consistent' scattering matrix, the `nu` parameter can be set to `true` such that the legendre scattering moments are calculated as: .. math:: \\sigma_{s,\\ell,g'\\rightarrow g} = \\upsilon_{g'\\rightarrow g} \\times \\sigma_s (r, e) \\times p_{s,\\ell,g'\\rightarrow g}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter domain", "output": "When creating a ScatterMatrixXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter domain_type", "output": "When creating a ScatterMatrixXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter groups", "output": "When creating a ScatterMatrixXS, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter by_nuclide", "output": "When creating a ScatterMatrixXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter name", "output": "When creating a ScatterMatrixXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter num_polar", "output": "When creating a ScatterMatrixXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a int, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter num_azimuthal", "output": "When creating a ScatterMatrixXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a int, optional value." }, { "instruction": "What does the nu parameter do when creating a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS constructor parameter nu", "output": "When creating a ScatterMatrixXS, the nu parameter specifies if true, the cross section data will include neutron multiplication; defaults to false. It should be a bool value." }, { "instruction": "What is the formulation attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute formulation", "output": "The formulation attribute of a ScatterMatrixXS contains the calculation approach to use ('simple' by default). the 'simple' formulation simply divides the group-to-group scattering rates by the groupwise flux, each computed from analog tally estimators. the 'consistent' formulation multiplies the groupwise scattering rates by the group-to-group scatter probability matrix, the former computed from tracklength tallies and the latter computed from analog tallies. the 'consistent' formulation is designed to better conserve reaction rate balance with the total and absorption cross sections computed using tracklength tally estimators.. It's a 'simple' or 'consistent' value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the correction attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute correction", "output": "The correction attribute of a ScatterMatrixXS contains apply the p0 correction to scattering matrices if set to 'p0'; this is used only if :attr:`scattermatrixxs.scatter_format` is 'legendre'. It's a 'P0' or None value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the scatter_format attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute scatter_format", "output": "The scatter_format attribute of a ScatterMatrixXS contains representation of the angular scattering distribution (default is 'legendre'). It's a {'legendre', or 'histogram'} value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the legendre_order attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute legendre_order", "output": "The legendre_order attribute of a ScatterMatrixXS contains the highest legendre moment in the scattering matrix; this is used if :attr:`scattermatrixxs.scatter_format` is 'legendre'. (default is 0). It's a int value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the histogram_bins attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute histogram_bins", "output": "The histogram_bins attribute of a ScatterMatrixXS contains the number of equally-spaced bins for the histogram representation of the angular scattering distribution; this is used if :attr:`scattermatrixxs.scatter_format` is 'histogram'. (default is 16). It's a int value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the name attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute name", "output": "The name attribute of a ScatterMatrixXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the rxn_type attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute rxn_type", "output": "The rxn_type attribute of a ScatterMatrixXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the nu attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute nu", "output": "The nu attribute of a ScatterMatrixXS contains if true, the cross section data will include neutron multiplication. It's a bool value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the by_nuclide attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute by_nuclide", "output": "The by_nuclide attribute of a ScatterMatrixXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the domain attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute domain", "output": "The domain attribute of a ScatterMatrixXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the domain_type attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute domain_type", "output": "The domain_type attribute of a ScatterMatrixXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the energy_groups attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute energy_groups", "output": "The energy_groups attribute of a ScatterMatrixXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the num_polar attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute num_polar", "output": "The num_polar attribute of a ScatterMatrixXS contains number of equi-width polar angle bins for angle discretization. It's a int value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the num_azimuthal attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a ScatterMatrixXS contains number of equi-width azimuthal angle bins for angle discretization. It's a int value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the tally_trigger attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute tally_trigger", "output": "The tally_trigger attribute of a ScatterMatrixXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the scores attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute scores", "output": "The scores attribute of a ScatterMatrixXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the filters attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute filters", "output": "The filters attribute of a ScatterMatrixXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the tally_keys attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute tally_keys", "output": "The tally_keys attribute of a ScatterMatrixXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the estimator attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute estimator", "output": "The estimator attribute of a ScatterMatrixXS contains the tally estimator used to compute the multi-group cross section. It's a 'analog' value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the tallies attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute tallies", "output": "The tallies attribute of a ScatterMatrixXS contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`scattermatrixxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a ScatterMatrixXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the xs_tally attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute xs_tally", "output": "The xs_tally attribute of a ScatterMatrixXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the num_subdomains attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute num_subdomains", "output": "The num_subdomains attribute of a ScatterMatrixXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the num_nuclides attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute num_nuclides", "output": "The num_nuclides attribute of a ScatterMatrixXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the nuclides attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute nuclides", "output": "The nuclides attribute of a ScatterMatrixXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the sparse attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute sparse", "output": "The sparse attribute of a ScatterMatrixXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the loaded_sp attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute loaded_sp", "output": "The loaded_sp attribute of a ScatterMatrixXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the derived attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute derived", "output": "The derived attribute of a ScatterMatrixXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "What is the mgxs_type attribute of a ScatterMatrixXS?", "input": "OpenMC Python API ScatterMatrixXS attribute mgxs_type", "output": "The mgxs_type attribute of a ScatterMatrixXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a ScatterMatrixXS instance." }, { "instruction": "How do you call the __init__() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any, nu: Any). It takes 9 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the _dont_squeeze() method do in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS._dont_squeeze() method", "output": "The _dont_squeeze() method create a tuple of axes which should not be removed during the get_xs\n process. It's used for scattermatrixxs operations." }, { "instruction": "How do you call the _dont_squeeze() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS._dont_squeeze() method signature", "output": "To call the _dont_squeeze() method, use: @property def _dont_squeeze(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the formulation() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.formulation() method signature", "output": "To call the formulation() method, use: @property def formulation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the formulation() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.formulation() method signature", "output": "To call the formulation() method, use: @formulation.setter def formulation(self: Any, formulation: Any). It takes 2 parameters." }, { "instruction": "How do you call the correction() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.correction() method signature", "output": "To call the correction() method, use: @property def correction(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the correction() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.correction() method signature", "output": "To call the correction() method, use: @correction.setter def correction(self: Any, correction: Any). It takes 2 parameters." }, { "instruction": "How do you call the scatter_format() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.scatter_format() method signature", "output": "To call the scatter_format() method, use: @property def scatter_format(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scatter_format() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.scatter_format() method signature", "output": "To call the scatter_format() method, use: @scatter_format.setter def scatter_format(self: Any, scatter_format: Any). It takes 2 parameters." }, { "instruction": "How do you call the legendre_order() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.legendre_order() method signature", "output": "To call the legendre_order() method, use: @property def legendre_order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the legendre_order() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.legendre_order() method signature", "output": "To call the legendre_order() method, use: @legendre_order.setter def legendre_order(self: Any, legendre_order: Any). It takes 2 parameters." }, { "instruction": "How do you call the histogram_bins() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.histogram_bins() method signature", "output": "To call the histogram_bins() method, use: @property def histogram_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the histogram_bins() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.histogram_bins() method signature", "output": "To call the histogram_bins() method, use: @histogram_bins.setter def histogram_bins(self: Any, histogram_bins: Any). It takes 2 parameters." }, { "instruction": "How do you call the nu() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.nu() method signature", "output": "To call the nu() method, use: @property def nu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nu() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.nu() method signature", "output": "To call the nu() method, use: @nu.setter def nu(self: Any, nu: Any). It takes 2 parameters." }, { "instruction": "How do you call the scores() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_keys() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.tally_keys() method signature", "output": "To call the tally_keys() method, use: @property def tally_keys(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the estimator() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.estimator() method signature", "output": "To call the estimator() method, use: @property def estimator(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What does the load_from_statepoint() method do in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.load_from_statepoint() method", "output": "The load_from_statepoint() method extracts tallies in an openmc statepoint with the data needed to compute multi-group cross sections. this method is needed to compute cross section data from tallies in an openmc statepoint object. .. note:: the statepoint must be linked with an openmc summary object. It's used for scattermatrixxs operations." }, { "instruction": "How do you call the load_from_statepoint() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.load_from_statepoint() method signature", "output": "To call the load_from_statepoint() method, use: def load_from_statepoint(self: Any, statepoint: Any). It takes 2 parameters." }, { "instruction": "What does the statepoint parameter do in the load_from_statepoint() method?", "input": "OpenMC Python API ScatterMatrixXS.load_from_statepoint() parameter statepoint", "output": "The statepoint parameter an openmc statepoint object with tally data. It should be a openmc.StatePoint value." }, { "instruction": "What does the get_slice() method do in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.get_slice() method", "output": "The get_slice() method build a sliced scattermatrix for the specified nuclides and energy groups. this method constructs a new mgxs to encapsulate a subset of the data represented by this mgxs. the subset of data to include in the tally slice is determined by the nuclides and energy groups specified in the input parameters. It's used for scattermatrixxs operations." }, { "instruction": "How do you call the get_slice() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, nuclides: Any, in_groups: Any, out_groups: Any, legendre_order: Any). It takes 5 parameters." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API ScatterMatrixXS.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the in_groups parameter do in the get_slice() method?", "input": "OpenMC Python API ScatterMatrixXS.get_slice() parameter in_groups", "output": "The in_groups parameter a list of incoming energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the out_groups parameter do in the get_slice() method?", "input": "OpenMC Python API ScatterMatrixXS.get_slice() parameter out_groups", "output": "The out_groups parameter a list of outgoing energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of int value." }, { "instruction": "What does the legendre_order parameter do in the get_slice() method?", "input": "OpenMC Python API ScatterMatrixXS.get_slice() parameter legendre_order", "output": "The legendre_order parameter the highest legendre moment in the sliced mgxs. if order is 'same' then the sliced mgxs will have the same legendre moments as the original mgxs (default). if order is an integer less than the original mgxs' order, then only those legendre moments up to that order will be included in the sliced mgxs.. It should be a int or 'same' value." }, { "instruction": "What does the get_xs() method do in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() method", "output": "The get_xs() method returns an array of multi-group cross sections. this method constructs a 5d numpy array for the requested multi-group cross section data for one or more subdomains (1st dimension), energy groups in (2nd dimension), energy groups out (3rd dimension), nuclides (4th dimension), and moments/histograms (5th dimension). .. note:: the scattering moments are not multiplied by the :math:`(2\\ell+1)/2` prefactor in the expansion of the scattering source into legendre moments in the neutron transport equation. It's used for scattermatrixxs operations." }, { "instruction": "How do you call the get_xs() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, in_groups: Any, out_groups: Any, subdomains: Any, nuclides: Any, moment: Any, xs_type: Any, order_groups: Any, row_column: Any, value: Any, squeeze: Any). It takes 11 parameters." }, { "instruction": "What does the in_groups parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter in_groups", "output": "The in_groups parameter incoming energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the out_groups parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter out_groups", "output": "The out_groups parameter outgoing energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the moment parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter moment", "output": "The moment parameter the scattering matrix moment to return. all moments will be returned if the moment is 'all' (default); otherwise, a specific moment will be returned.. It should be a int or 'all' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the row_column parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter row_column", "output": "The row_column parameter return the cross section indexed first by incoming group and second by outgoing group ('inout'), or vice versa ('outin'). defaults to 'inout'.. It should be a {'inout', 'outin'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_pandas_dataframe() method do in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method build a pandas dataframe for the mgxs data. this method leverages :meth:`openmc.tally.get_pandas_dataframe`, but renames the columns with terminology appropriate for cross section data. It's used for scattermatrixxs operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, groups: Any, nuclides: Any, xs_type: Any, paths: Any). It takes 5 parameters." }, { "instruction": "What does the groups parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API ScatterMatrixXS.get_pandas_dataframe() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API ScatterMatrixXS.get_pandas_dataframe() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the dataframe. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will include the cross sections for all nuclides in the spatial domain. the special string 'sum' will include the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API ScatterMatrixXS.get_pandas_dataframe() parameter xs_type", "output": "The xs_type parameter return macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the paths parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API ScatterMatrixXS.get_pandas_dataframe() parameter paths", "output": "The paths parameter construct columns for distribcell tally filters (default is true). the geometric information in the summary object is embedded into a multi-index column with a geometric \"path\" to each distribcell instance.. It should be a bool, optional value." }, { "instruction": "What does the print_xs() method do in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.print_xs() method", "output": "The print_xs() method prints a string representation for the multi-group cross section. It's used for scattermatrixxs operations." }, { "instruction": "How do you call the print_xs() method in the ScatterMatrixXS class?", "input": "OpenMC Python API ScatterMatrixXS.print_xs() method signature", "output": "To call the print_xs() method, use: def print_xs(self: Any, subdomains: Any, nuclides: Any, xs_type: Any, moment: Any). It takes 5 parameters." }, { "instruction": "What does the subdomains parameter do in the print_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.print_xs() parameter subdomains", "output": "The subdomains parameter the subdomain ids of the cross sections to include in the report. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the print_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.print_xs() parameter nuclides", "output": "The nuclides parameter the nuclides of the cross-sections to include in the report. this may be a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will report the cross sections for all nuclides in the spatial domain. the special string 'sum' will report the cross sections summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the print_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.print_xs() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the moment parameter do in the print_xs() method?", "input": "OpenMC Python API ScatterMatrixXS.print_xs() parameter moment", "output": "The moment parameter the scattering moment to print (default is 0). It should be a int value." }, { "instruction": "What is the MultiplicityMatrixXS class in OpenMC's Python API?", "input": "OpenMC Python API MultiplicityMatrixXS class", "output": "The MultiplicityMatrixXS class represents the scattering multiplicity matrix.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`multiplicitymatrixxs.energy_groups` and\n :attr:`multiplicitymatrixxs.domain` properties. tallies for the flux and\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`multiplicitymatrixxs.tallies` property, which\n can then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`multiplicitymatrixxs.xs_tally`\n property.\n\n for a spatial domain :math:`v`, incoming energy group\n :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`,\n the multiplicity is calculated as:\n\n .. math::\n\n \\begin{aligned}\n \\langle \\upsilon \\sigma_{s,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in\n d} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\sum_i \\upsilon_i \\sigma_i (r, e' \\rightarrow\n e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega') \\\\\n \\langle \\sigma_{s,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in\n d} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\sum_i \\upsilon_i \\sigma_i (r, e' \\rightarrow\n e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega') \\\\\n \\upsilon_{g'\\rightarrow g} &= \\frac{\\langle \\upsilon\n \\sigma_{s,g'\\rightarrow g} \\rangle}{\\langle \\sigma_{s,g'\\rightarrow g}\n \\rangle}\n \\end{aligned}\n\n where :math:`\\upsilon_i` is the multiplicity for the :math:`i`-th reaction.. It provides 5 methods and 0 properties for working with multiplicitymatrixxs data in OpenMC." }, { "instruction": "What does the MultiplicityMatrixXS class do in OpenMC's Python API?", "input": "OpenMC Python API MultiplicityMatrixXS class description", "output": "The MultiplicityMatrixXS class the scattering multiplicity matrix.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`multiplicitymatrixxs.energy_groups` and\n :attr:`multiplicitymatrixxs.domain` properties. tallies for the flux and\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`multiplicitymatrixxs.tallies` property, which\n can then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`multiplicitymatrixxs.xs_tally`\n property.\n\n for a spatial domain :math:`v`, incoming energy group\n :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`,\n the multiplicity is calculated as:\n\n .. math::\n\n \\begin{aligned}\n \\langle \\upsilon \\sigma_{s,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in\n d} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\sum_i \\upsilon_i \\sigma_i (r, e' \\rightarrow\n e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega') \\\\\n \\langle \\sigma_{s,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in\n d} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\sum_i \\upsilon_i \\sigma_i (r, e' \\rightarrow\n e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega') \\\\\n \\upsilon_{g'\\rightarrow g} &= \\frac{\\langle \\upsilon\n \\sigma_{s,g'\\rightarrow g} \\rangle}{\\langle \\sigma_{s,g'\\rightarrow g}\n \\rangle}\n \\end{aligned}\n\n where :math:`\\upsilon_i` is the multiplicity for the :math:`i`-th reaction.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the MultiplicityMatrixXS class?", "input": "OpenMC Python API MultiplicityMatrixXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "How do you call the scores() method in the MultiplicityMatrixXS class?", "input": "OpenMC Python API MultiplicityMatrixXS.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the MultiplicityMatrixXS class?", "input": "OpenMC Python API MultiplicityMatrixXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the MultiplicityMatrixXS class?", "input": "OpenMC Python API MultiplicityMatrixXS.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the MultiplicityMatrixXS class?", "input": "OpenMC Python API MultiplicityMatrixXS.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What is the ScatterProbabilityMatrix class in OpenMC's Python API?", "input": "OpenMC Python API ScatterProbabilityMatrix class", "output": "The ScatterProbabilityMatrix class represents the group-to-group scattering probability matrix.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`scatterprobabilitymatrix.energy_groups`\n and :attr:`scatterprobabilitymatrix.domain` properties. tallies for the\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`scatterprobabilitymatrix.tallies` property,\n which can then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`scatterprobabilitymatrix.xs_tally`\n property.\n\n for a spatial domain :math:`v`, incoming energy group\n :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`,\n the group-to-group scattering probabilities are calculated as:\n\n .. math::\n\n \\begin{aligned}\n \\langle \\sigma_{s,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi} d\\omega\n \\int_{e_g}^{e_{g-1}} de \\; \\sigma_{s} (r, e' \\rightarrow e, \\omega'\n \\cdot \\omega) \\psi(r, e', \\omega')\\\\\n \\langle \\sigma_{s,0,g'} \\phi \\rangle &= \\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi} d\\omega\n \\int_{0}^{\\infty} de \\; \\sigma_s (r, e'\n \\rightarrow e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega')\\\\\n p_{s,g'\\rightarrow g} &= \\frac{\\langle\n \\sigma_{s,g'\\rightarrow g} \\phi \\rangle}{\\langle\n \\sigma_{s,g'} \\phi \\rangle}\n \\end{aligned}. It provides 5 methods and 0 properties for working with scatterprobabilitymatrix data in OpenMC." }, { "instruction": "What does the ScatterProbabilityMatrix class do in OpenMC's Python API?", "input": "OpenMC Python API ScatterProbabilityMatrix class description", "output": "The ScatterProbabilityMatrix class the group-to-group scattering probability matrix.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group cross sections for multi-group neutronics calculations. at a\n minimum, one needs to set the :attr:`scatterprobabilitymatrix.energy_groups`\n and :attr:`scatterprobabilitymatrix.domain` properties. tallies for the\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`scatterprobabilitymatrix.tallies` property,\n which can then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`scatterprobabilitymatrix.xs_tally`\n property.\n\n for a spatial domain :math:`v`, incoming energy group\n :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`,\n the group-to-group scattering probabilities are calculated as:\n\n .. math::\n\n \\begin{aligned}\n \\langle \\sigma_{s,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi} d\\omega\n \\int_{e_g}^{e_{g-1}} de \\; \\sigma_{s} (r, e' \\rightarrow e, \\omega'\n \\cdot \\omega) \\psi(r, e', \\omega')\\\\\n \\langle \\sigma_{s,0,g'} \\phi \\rangle &= \\int_{r \\in v} dr\n \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{4\\pi} d\\omega\n \\int_{0}^{\\infty} de \\; \\sigma_s (r, e'\n \\rightarrow e, \\omega' \\cdot \\omega) \\psi(r, e', \\omega')\\\\\n p_{s,g'\\rightarrow g} &= \\frac{\\langle\n \\sigma_{s,g'\\rightarrow g} \\phi \\rangle}{\\langle\n \\sigma_{s,g'} \\phi \\rangle}\n \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the ScatterProbabilityMatrix class?", "input": "OpenMC Python API ScatterProbabilityMatrix.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "How do you call the scores() method in the ScatterProbabilityMatrix class?", "input": "OpenMC Python API ScatterProbabilityMatrix.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the ScatterProbabilityMatrix class?", "input": "OpenMC Python API ScatterProbabilityMatrix.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the ScatterProbabilityMatrix class?", "input": "OpenMC Python API ScatterProbabilityMatrix.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the ScatterProbabilityMatrix class?", "input": "OpenMC Python API ScatterProbabilityMatrix.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What is the NuFissionMatrixXS class in OpenMC's Python API?", "input": "OpenMC Python API NuFissionMatrixXS class", "output": "The NuFissionMatrixXS class represents a fission production matrix multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`nufissionmatrixxs.energy_groups` and :attr:`nufissionmatrixxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`nufissionmatrixxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`nufissionmatrixxs.xs_tally` property. for a spatial domain :math:`v`, incoming energy group :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`, the fission production is calculated as: .. math:: \\begin{aligned} \\langle \\nu\\sigma_{f,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu\\sigma_f (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\nu\\sigma_{f,g'\\rightarrow g} &= \\frac{\\langle \\nu\\sigma_{f,g'\\rightarrow g} \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned}. It provides 4 methods and 0 properties for working with nufissionmatrixxs data in OpenMC." }, { "instruction": "What does the NuFissionMatrixXS class do in OpenMC's Python API?", "input": "OpenMC Python API NuFissionMatrixXS class description", "output": "The NuFissionMatrixXS class a fission production matrix multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`nufissionmatrixxs.energy_groups` and :attr:`nufissionmatrixxs.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`nufissionmatrixxs.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`nufissionmatrixxs.xs_tally` property. for a spatial domain :math:`v`, incoming energy group :math:`[e_{g'},e_{g'-1}]`, and outgoing energy group :math:`[e_g,e_{g-1}]`, the fission production is calculated as: .. math:: \\begin{aligned} \\langle \\nu\\sigma_{f,g'\\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_{e_{g'}}^{e_{g'-1}} de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu\\sigma_f (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega) \\\\ \\nu\\sigma_{f,g'\\rightarrow g} &= \\frac{\\langle \\nu\\sigma_{f,g'\\rightarrow g} \\phi \\rangle}{\\langle \\phi \\rangle} \\end{aligned}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter domain", "output": "When creating a NuFissionMatrixXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter domain_type", "output": "When creating a NuFissionMatrixXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter groups", "output": "When creating a NuFissionMatrixXS, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter by_nuclide", "output": "When creating a NuFissionMatrixXS, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter name", "output": "When creating a NuFissionMatrixXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter num_polar", "output": "When creating a NuFissionMatrixXS, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter num_azimuthal", "output": "When creating a NuFissionMatrixXS, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the prompt parameter do when creating a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS constructor parameter prompt", "output": "When creating a NuFissionMatrixXS, the prompt parameter specifies if true, computes cross sections which only includes prompt neutrons; defaults to false which includes prompt and delayed in total. It should be a bool value." }, { "instruction": "What is the name attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute name", "output": "The name attribute of a NuFissionMatrixXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the rxn_type attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute rxn_type", "output": "The rxn_type attribute of a NuFissionMatrixXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the prompt attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute prompt", "output": "The prompt attribute of a NuFissionMatrixXS contains if true, computes cross sections which only includes prompt neutrons. It's a bool value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the by_nuclide attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute by_nuclide", "output": "The by_nuclide attribute of a NuFissionMatrixXS contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the domain attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute domain", "output": "The domain attribute of a NuFissionMatrixXS contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the domain_type attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute domain_type", "output": "The domain_type attribute of a NuFissionMatrixXS contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the energy_groups attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute energy_groups", "output": "The energy_groups attribute of a NuFissionMatrixXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the num_polar attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute num_polar", "output": "The num_polar attribute of a NuFissionMatrixXS contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the num_azimuthal attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute num_azimuthal", "output": "The num_azimuthal attribute of a NuFissionMatrixXS contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the tally_trigger attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute tally_trigger", "output": "The tally_trigger attribute of a NuFissionMatrixXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the scores attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute scores", "output": "The scores attribute of a NuFissionMatrixXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the filters attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute filters", "output": "The filters attribute of a NuFissionMatrixXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the tally_keys attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute tally_keys", "output": "The tally_keys attribute of a NuFissionMatrixXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the estimator attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute estimator", "output": "The estimator attribute of a NuFissionMatrixXS contains the tally estimator used to compute the multi-group cross section. It's a 'analog' value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the tallies attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute tallies", "output": "The tallies attribute of a NuFissionMatrixXS contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`nufissionmatrixxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a NuFissionMatrixXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the xs_tally attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute xs_tally", "output": "The xs_tally attribute of a NuFissionMatrixXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the num_subdomains attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute num_subdomains", "output": "The num_subdomains attribute of a NuFissionMatrixXS contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the num_nuclides attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute num_nuclides", "output": "The num_nuclides attribute of a NuFissionMatrixXS contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the nuclides attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute nuclides", "output": "The nuclides attribute of a NuFissionMatrixXS contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the sparse attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute sparse", "output": "The sparse attribute of a NuFissionMatrixXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the loaded_sp attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute loaded_sp", "output": "The loaded_sp attribute of a NuFissionMatrixXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the derived attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute derived", "output": "The derived attribute of a NuFissionMatrixXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "What is the mgxs_type attribute of a NuFissionMatrixXS?", "input": "OpenMC Python API NuFissionMatrixXS attribute mgxs_type", "output": "The mgxs_type attribute of a NuFissionMatrixXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a NuFissionMatrixXS instance." }, { "instruction": "How do you call the __init__() method in the NuFissionMatrixXS class?", "input": "OpenMC Python API NuFissionMatrixXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any, prompt: Any). It takes 9 parameters." }, { "instruction": "How do you call the prompt() method in the NuFissionMatrixXS class?", "input": "OpenMC Python API NuFissionMatrixXS.prompt() method signature", "output": "To call the prompt() method, use: @property def prompt(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the prompt() method in the NuFissionMatrixXS class?", "input": "OpenMC Python API NuFissionMatrixXS.prompt() method signature", "output": "To call the prompt() method, use: @prompt.setter def prompt(self: Any, prompt: Any). It takes 2 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the NuFissionMatrixXS class?", "input": "OpenMC Python API NuFissionMatrixXS.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What is the Chi class in OpenMC's Python API?", "input": "OpenMC Python API Chi class", "output": "The Chi class represents the fission spectrum. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`chi.energy_groups` and :attr:`chi.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`chi.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`chi.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the fission spectrum is calculated as: .. math:: \\begin{aligned} \\langle \\nu\\sigma_{f,g' \\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu\\sigma_f (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\nu\\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu\\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\chi_g &= \\frac{\\langle \\nu\\sigma_{f,g' \\rightarrow g} \\phi \\rangle} {\\langle \\nu\\sigma_f \\phi \\rangle} \\end{aligned} this class can also be used to gather a prompt-chi (which only includes the outgoing energy spectrum of prompt neutrons). this is accomplished by setting the :attr:`chi.prompt` attribute to `true`. It provides 15 methods and 0 properties for working with chi data in OpenMC." }, { "instruction": "What does the Chi class do in OpenMC's Python API?", "input": "OpenMC Python API Chi class description", "output": "The Chi class the fission spectrum. this class can be used for both openmc input generation and tally data post-processing to compute spatially-homogenized and energy-integrated multi-group cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`chi.energy_groups` and :attr:`chi.domain` properties. tallies for the flux and appropriate reaction rates over the specified domain are generated automatically via the :attr:`chi.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`chi.xs_tally` property. for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the fission spectrum is calculated as: .. math:: \\begin{aligned} \\langle \\nu\\sigma_{f,g' \\rightarrow g} \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_{e_g}^{e_{g-1}} de \\; \\chi(e) \\nu\\sigma_f (r, e') \\psi(r, e', \\omega')\\\\ \\langle \\nu\\sigma_f \\phi \\rangle &= \\int_{r \\in v} dr \\int_{4\\pi} d\\omega' \\int_0^\\infty de' \\int_0^\\infty de \\; \\chi(e) \\nu\\sigma_f (r, e') \\psi(r, e', \\omega') \\\\ \\chi_g &= \\frac{\\langle \\nu\\sigma_{f,g' \\rightarrow g} \\phi \\rangle} {\\langle \\nu\\sigma_f \\phi \\rangle} \\end{aligned} this class can also be used to gather a prompt-chi (which only includes the outgoing energy spectrum of prompt neutrons). this is accomplished by setting the :attr:`chi.prompt` attribute to `true`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter domain", "output": "When creating a Chi, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter domain_type", "output": "When creating a Chi, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value." }, { "instruction": "What does the groups parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter groups", "output": "When creating a Chi, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the prompt parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter prompt", "output": "When creating a Chi, the prompt parameter specifies if true, computes cross sections which only includes prompt neutrons; defaults to false which includes prompt and delayed in total. It should be a bool value." }, { "instruction": "What does the by_nuclide parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter by_nuclide", "output": "When creating a Chi, the by_nuclide parameter specifies if true, computes cross sections for each nuclide in domain. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter name", "output": "When creating a Chi, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What does the num_polar parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter num_polar", "output": "When creating a Chi, the num_polar parameter specifies number of equi-width polar angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What does the num_azimuthal parameter do when creating a Chi?", "input": "OpenMC Python API Chi constructor parameter num_azimuthal", "output": "When creating a Chi, the num_azimuthal parameter specifies number of equi-width azimuthal angle bins for angle discretization; defaults to one bin. It should be a Integral, optional value." }, { "instruction": "What is the name attribute of a Chi?", "input": "OpenMC Python API Chi attribute name", "output": "The name attribute of a Chi contains name of the multi-group cross section. It's a str, optional value that you can access after creating a Chi instance." }, { "instruction": "What is the rxn_type attribute of a Chi?", "input": "OpenMC Python API Chi attribute rxn_type", "output": "The rxn_type attribute of a Chi contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a Chi instance." }, { "instruction": "What is the prompt attribute of a Chi?", "input": "OpenMC Python API Chi attribute prompt", "output": "The prompt attribute of a Chi contains if true, computes cross sections which only includes prompt neutrons. It's a bool value that you can access after creating a Chi instance." }, { "instruction": "What is the by_nuclide attribute of a Chi?", "input": "OpenMC Python API Chi attribute by_nuclide", "output": "The by_nuclide attribute of a Chi contains if true, computes cross sections for each nuclide in domain. It's a bool value that you can access after creating a Chi instance." }, { "instruction": "What is the domain attribute of a Chi?", "input": "OpenMC Python API Chi attribute domain", "output": "The domain attribute of a Chi contains domain for spatial homogenization. It's a openmc.Material or openmc.Cell or openmc.Universe or openmc.RegularMesh value that you can access after creating a Chi instance." }, { "instruction": "What is the domain_type attribute of a Chi?", "input": "OpenMC Python API Chi attribute domain_type", "output": "The domain_type attribute of a Chi contains domain type for spatial homogenization. It's a {'material', 'cell', 'distribcell', 'universe', 'mesh'} value that you can access after creating a Chi instance." }, { "instruction": "What is the energy_groups attribute of a Chi?", "input": "OpenMC Python API Chi attribute energy_groups", "output": "The energy_groups attribute of a Chi contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a Chi instance." }, { "instruction": "What is the num_polar attribute of a Chi?", "input": "OpenMC Python API Chi attribute num_polar", "output": "The num_polar attribute of a Chi contains number of equi-width polar angle bins for angle discretization. It's a Integral value that you can access after creating a Chi instance." }, { "instruction": "What is the num_azimuthal attribute of a Chi?", "input": "OpenMC Python API Chi attribute num_azimuthal", "output": "The num_azimuthal attribute of a Chi contains number of equi-width azimuthal angle bins for angle discretization. It's a Integral value that you can access after creating a Chi instance." }, { "instruction": "What is the tally_trigger attribute of a Chi?", "input": "OpenMC Python API Chi attribute tally_trigger", "output": "The tally_trigger attribute of a Chi contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a Chi instance." }, { "instruction": "What is the scores attribute of a Chi?", "input": "OpenMC Python API Chi attribute scores", "output": "The scores attribute of a Chi contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a Chi instance." }, { "instruction": "What is the filters attribute of a Chi?", "input": "OpenMC Python API Chi attribute filters", "output": "The filters attribute of a Chi contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a Chi instance." }, { "instruction": "What is the tally_keys attribute of a Chi?", "input": "OpenMC Python API Chi attribute tally_keys", "output": "The tally_keys attribute of a Chi contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a Chi instance." }, { "instruction": "What is the estimator attribute of a Chi?", "input": "OpenMC Python API Chi attribute estimator", "output": "The estimator attribute of a Chi contains the tally estimator used to compute the multi-group cross section. It's a 'analog' value that you can access after creating a Chi instance." }, { "instruction": "What is the tallies attribute of a Chi?", "input": "OpenMC Python API Chi attribute tallies", "output": "The tallies attribute of a Chi contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`chi.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a Chi instance." }, { "instruction": "What is the rxn_rate_tally attribute of a Chi?", "input": "OpenMC Python API Chi attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a Chi contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a Chi instance." }, { "instruction": "What is the xs_tally attribute of a Chi?", "input": "OpenMC Python API Chi attribute xs_tally", "output": "The xs_tally attribute of a Chi contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a Chi instance." }, { "instruction": "What is the num_subdomains attribute of a Chi?", "input": "OpenMC Python API Chi attribute num_subdomains", "output": "The num_subdomains attribute of a Chi contains the number of subdomains is unity for 'material', 'cell' and 'universe' domain types. this is equal to the number of cell instances for 'distribcell' domain types (it is equal to unity prior to loading tally data from a statepoint file).. It's a int value that you can access after creating a Chi instance." }, { "instruction": "What is the num_nuclides attribute of a Chi?", "input": "OpenMC Python API Chi attribute num_nuclides", "output": "The num_nuclides attribute of a Chi contains the number of nuclides for which the multi-group cross section is being tracked. this is unity if the by_nuclide attribute is false.. It's a int value that you can access after creating a Chi instance." }, { "instruction": "What is the nuclides attribute of a Chi?", "input": "OpenMC Python API Chi attribute nuclides", "output": "The nuclides attribute of a Chi contains the optional user-specified nuclides for which to compute cross sections (e.g., 'u238', 'o16'). if by_nuclide is true but nuclides are not specified by the user, all nuclides in the spatial domain are included. this attribute is 'sum' if by_nuclide is false.. It's a Iterable of str or 'sum' value that you can access after creating a Chi instance." }, { "instruction": "What is the sparse attribute of a Chi?", "input": "OpenMC Python API Chi attribute sparse", "output": "The sparse attribute of a Chi contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a Chi instance." }, { "instruction": "What is the loaded_sp attribute of a Chi?", "input": "OpenMC Python API Chi attribute loaded_sp", "output": "The loaded_sp attribute of a Chi contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a Chi instance." }, { "instruction": "What is the derived attribute of a Chi?", "input": "OpenMC Python API Chi attribute derived", "output": "The derived attribute of a Chi contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a Chi instance." }, { "instruction": "What is the mgxs_type attribute of a Chi?", "input": "OpenMC Python API Chi attribute mgxs_type", "output": "The mgxs_type attribute of a Chi contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a Chi instance." }, { "instruction": "How do you call the __init__() method in the Chi class?", "input": "OpenMC Python API Chi.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, prompt: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 9 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the Chi class?", "input": "OpenMC Python API Chi.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the prompt() method in the Chi class?", "input": "OpenMC Python API Chi.prompt() method signature", "output": "To call the prompt() method, use: @property def prompt(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the prompt() method in the Chi class?", "input": "OpenMC Python API Chi.prompt() method signature", "output": "To call the prompt() method, use: @prompt.setter def prompt(self: Any, prompt: Any). It takes 2 parameters." }, { "instruction": "What does the _dont_squeeze() method do in the Chi class?", "input": "OpenMC Python API Chi._dont_squeeze() method", "output": "The _dont_squeeze() method create a tuple of axes which should not be removed during the get_xs\n process. It's used for chi operations." }, { "instruction": "How do you call the _dont_squeeze() method in the Chi class?", "input": "OpenMC Python API Chi._dont_squeeze() method signature", "output": "To call the _dont_squeeze() method, use: @property def _dont_squeeze(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the Chi class?", "input": "OpenMC Python API Chi.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the Chi class?", "input": "OpenMC Python API Chi.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_keys() method in the Chi class?", "input": "OpenMC Python API Chi.tally_keys() method signature", "output": "To call the tally_keys() method, use: @property def tally_keys(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rxn_rate_tally() method in the Chi class?", "input": "OpenMC Python API Chi.rxn_rate_tally() method signature", "output": "To call the rxn_rate_tally() method, use: @property def rxn_rate_tally(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the Chi class?", "input": "OpenMC Python API Chi.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_homogenized_mgxs() method do in the Chi class?", "input": "OpenMC Python API Chi.get_homogenized_mgxs() method", "output": "The get_homogenized_mgxs() method construct a homogenized mgxs with other mgxs objects. It's used for chi operations." }, { "instruction": "How do you call the get_homogenized_mgxs() method in the Chi class?", "input": "OpenMC Python API Chi.get_homogenized_mgxs() method signature", "output": "To call the get_homogenized_mgxs() method, use: def get_homogenized_mgxs(self: Any, other_mgxs: Any). It takes 2 parameters." }, { "instruction": "What does the other_mgxs parameter do in the get_homogenized_mgxs() method?", "input": "OpenMC Python API Chi.get_homogenized_mgxs() parameter other_mgxs", "output": "The other_mgxs parameter the mgxs to homogenize with this one.. It should be a openmc.mgxs.MGXS or Iterable of openmc.mgxs.MGXS value." }, { "instruction": "What does the get_slice() method do in the Chi class?", "input": "OpenMC Python API Chi.get_slice() method", "output": "The get_slice() method build a sliced chi for the specified nuclides and energy groups. this method constructs a new mgxs to encapsulate a subset of the data represented by this mgxs. the subset of data to include in the tally slice is determined by the nuclides and energy groups specified in the input parameters. It's used for chi operations." }, { "instruction": "How do you call the get_slice() method in the Chi class?", "input": "OpenMC Python API Chi.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, nuclides: Any, groups: Any). It takes 3 parameters." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API Chi.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the groups parameter do in the get_slice() method?", "input": "OpenMC Python API Chi.get_slice() parameter groups", "output": "The groups parameter a list of energy group indices starting at 1 for the high energies (e.g., [1, 2, 3]; default is []). It should be a list of Integral value." }, { "instruction": "What does the merge() method do in the Chi class?", "input": "OpenMC Python API Chi.merge() method", "output": "The merge() method merge another chi with this one if results have been loaded from a statepoint, then chi are only mergeable along one and only one of energy groups or nuclides. It's used for chi operations." }, { "instruction": "How do you call the merge() method in the Chi class?", "input": "OpenMC Python API Chi.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API Chi.merge() parameter other", "output": "The other parameter mgxs to merge with this one. It should be a openmc.mgxs.MGXS value." }, { "instruction": "What does the merge() method return in the Chi class?", "input": "OpenMC Python API Chi.merge() return value", "output": "The merge() method returns merged mgxs. The return type is openmc.mgxs.MGXS." }, { "instruction": "What does the get_xs() method do in the Chi class?", "input": "OpenMC Python API Chi.get_xs() method", "output": "The get_xs() method returns an array of the fission spectrum. this method constructs a 3d numpy array for the requested multi-group cross section data for one or more subdomains (1st dimension), energy groups (2nd dimension), and nuclides (3rd dimension). It's used for chi operations." }, { "instruction": "How do you call the get_xs() method in the Chi class?", "input": "OpenMC Python API Chi.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, groups: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, value: Any, squeeze: Any). It takes 8 parameters." }, { "instruction": "What does the groups parameter do in the get_xs() method?", "input": "OpenMC Python API Chi.get_xs() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API Chi.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API Chi.get_xs() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). the special string 'all' will return the cross sections for all nuclides in the spatial domain. the special string 'sum' will return the cross section summed over all nuclides. defaults to 'all'.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API Chi.get_xs() parameter xs_type", "output": "The xs_type parameter this parameter is not relevant for chi but is included here to mirror the parent mgxs.get_xs(...) class method. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API Chi.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API Chi.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API Chi.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_units() method do in the Chi class?", "input": "OpenMC Python API Chi.get_units() method", "output": "The get_units() method returns the units of chi. this method returns the units of chi, which is \"%\" for both macro and micro xs types. It's used for chi operations." }, { "instruction": "How do you call the get_units() method in the Chi class?", "input": "OpenMC Python API Chi.get_units() method signature", "output": "To call the get_units() method, use: def get_units(self: Any, xs_type: Any). It takes 2 parameters." }, { "instruction": "What does the xs_type parameter do in the get_units() method?", "input": "OpenMC Python API Chi.get_units() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section units. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What is the InverseVelocity class in OpenMC's Python API?", "input": "OpenMC Python API InverseVelocity class", "output": "The InverseVelocity class represents an inverse velocity multi-group cross section.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group neutron inverse velocities for multi-group neutronics\n calculations. the units of inverse velocity are seconds per centimeter. at a\n minimum, one needs to set the :attr:`inversevelocity.energy_groups` and\n :attr:`inversevelocity.domain` properties. tallies for the flux and\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`inversevelocity.tallies` property, which can\n then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`inversevelocity.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n neutron inverse velocities are calculated by tallying the flux-weighted\n inverse velocity and the flux. the inverse velocity is then the\n flux-weighted inverse velocity divided by the flux:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\frac{\\psi (r, e, \\omega)}{v (r, e)}}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. It provides 2 methods and 0 properties for working with inversevelocity data in OpenMC." }, { "instruction": "What does the InverseVelocity class do in OpenMC's Python API?", "input": "OpenMC Python API InverseVelocity class description", "output": "The InverseVelocity class an inverse velocity multi-group cross section.\n\n this class can be used for both openmc input generation and tally data\n post-processing to compute spatially-homogenized and energy-integrated\n multi-group neutron inverse velocities for multi-group neutronics\n calculations. the units of inverse velocity are seconds per centimeter. at a\n minimum, one needs to set the :attr:`inversevelocity.energy_groups` and\n :attr:`inversevelocity.domain` properties. tallies for the flux and\n appropriate reaction rates over the specified domain are generated\n automatically via the :attr:`inversevelocity.tallies` property, which can\n then be appended to a :class:`openmc.tallies` instance.\n\n for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the\n necessary data to compute multi-group cross sections from a\n :class:`openmc.statepoint` instance. the derived multi-group cross section\n can then be obtained from the :attr:`inversevelocity.xs_tally` property.\n\n for a spatial domain :math:`v` and energy group :math:`[e_g,e_{g-1}]`, the\n neutron inverse velocities are calculated by tallying the flux-weighted\n inverse velocity and the flux. the inverse velocity is then the\n flux-weighted inverse velocity divided by the flux:\n\n .. math::\n\n \\frac{\\int_{r \\in v} dr \\int_{4\\pi} d\\omega \\int_{e_g}^{e_{g-1}} de \\;\n \\frac{\\psi (r, e, \\omega)}{v (r, e)}}{\\int_{r \\in v} dr \\int_{4\\pi}\n d\\omega \\int_{e_g}^{e_{g-1}} de \\; \\psi (r, e, \\omega)}. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the InverseVelocity class?", "input": "OpenMC Python API InverseVelocity.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any, num_polar: Any, num_azimuthal: Any). It takes 8 parameters." }, { "instruction": "What does the get_units() method do in the InverseVelocity class?", "input": "OpenMC Python API InverseVelocity.get_units() method", "output": "The get_units() method returns the units of inversevelocity. this method returns the units of an inversevelocity based on a desired xs_type. It's used for inversevelocity operations." }, { "instruction": "How do you call the get_units() method in the InverseVelocity class?", "input": "OpenMC Python API InverseVelocity.get_units() method signature", "output": "To call the get_units() method, use: def get_units(self: Any, xs_type: Any). It takes 2 parameters." }, { "instruction": "What does the xs_type parameter do in the get_units() method?", "input": "OpenMC Python API InverseVelocity.get_units() parameter xs_type", "output": "The xs_type parameter return the macro or micro cross section units. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What is the MeshSurfaceMGXS class in OpenMC's Python API?", "input": "OpenMC Python API MeshSurfaceMGXS class", "output": "The MeshSurfaceMGXS class represents an abstract multi-group cross section for some energy group structure on the surfaces of a mesh domain. this class can be used for both openmc input generation and tally data post-processing to compute surface- and energy-integrated multi-group cross sections for multi-group neutronics calculations. .. note:: users should instantiate the subclasses of this abstract class. .. versionadded:: 0.12.1. It provides 11 methods and 0 properties for working with meshsurfacemgxs data in OpenMC." }, { "instruction": "What does the MeshSurfaceMGXS class do in OpenMC's Python API?", "input": "OpenMC Python API MeshSurfaceMGXS class description", "output": "The MeshSurfaceMGXS class an abstract multi-group cross section for some energy group structure on the surfaces of a mesh domain. this class can be used for both openmc input generation and tally data post-processing to compute surface- and energy-integrated multi-group cross sections for multi-group neutronics calculations. .. note:: users should instantiate the subclasses of this abstract class. .. versionadded:: 0.12.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS constructor parameter domain", "output": "When creating a MeshSurfaceMGXS, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS constructor parameter domain_type", "output": "When creating a MeshSurfaceMGXS, the domain_type parameter specifies the domain type for spatial homogenization. It should be a {'mesh'} value." }, { "instruction": "What does the energy_groups parameter do when creating a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS constructor parameter energy_groups", "output": "When creating a MeshSurfaceMGXS, the energy_groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS constructor parameter by_nuclide", "output": "When creating a MeshSurfaceMGXS, the by_nuclide parameter specifies unused in meshsurfacemgxs. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS constructor parameter name", "output": "When creating a MeshSurfaceMGXS, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What is the name attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute name", "output": "The name attribute of a MeshSurfaceMGXS contains name of the multi-group cross section. It's a str, optional value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the rxn_type attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute rxn_type", "output": "The rxn_type attribute of a MeshSurfaceMGXS contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the by_nuclide attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute by_nuclide", "output": "The by_nuclide attribute of a MeshSurfaceMGXS contains unused in meshsurfacemgxs. It's a bool value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the domain attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute domain", "output": "The domain attribute of a MeshSurfaceMGXS contains domain for spatial homogenization. It's a Mesh value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the domain_type attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute domain_type", "output": "The domain_type attribute of a MeshSurfaceMGXS contains domain type for spatial homogenization. It's a {'mesh'} value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the energy_groups attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute energy_groups", "output": "The energy_groups attribute of a MeshSurfaceMGXS contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the tally_trigger attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute tally_trigger", "output": "The tally_trigger attribute of a MeshSurfaceMGXS contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the scores attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute scores", "output": "The scores attribute of a MeshSurfaceMGXS contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the filters attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute filters", "output": "The filters attribute of a MeshSurfaceMGXS contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the tally_keys attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute tally_keys", "output": "The tally_keys attribute of a MeshSurfaceMGXS contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the estimator attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute estimator", "output": "The estimator attribute of a MeshSurfaceMGXS contains the tally estimator used to compute the multi-group cross section. It's a {'analog'} value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the tallies attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute tallies", "output": "The tallies attribute of a MeshSurfaceMGXS contains openmc tallies needed to compute the multi-group cross section. It's a dict value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the rxn_rate_tally attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a MeshSurfaceMGXS contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the xs_tally attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute xs_tally", "output": "The xs_tally attribute of a MeshSurfaceMGXS contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the num_subdomains attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute num_subdomains", "output": "The num_subdomains attribute of a MeshSurfaceMGXS contains the number of subdomains is equal to the number of mesh surfaces times two to account for both the incoming and outgoing current from the mesh cell surfaces.. It's a int value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the num_nuclides attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute num_nuclides", "output": "The num_nuclides attribute of a MeshSurfaceMGXS contains unused in meshsurfacemgxs. It's a int value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the nuclides attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute nuclides", "output": "The nuclides attribute of a MeshSurfaceMGXS contains unused in meshsurfacemgxs. It's a Iterable of str or 'sum' value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the sparse attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute sparse", "output": "The sparse attribute of a MeshSurfaceMGXS contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the loaded_sp attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute loaded_sp", "output": "The loaded_sp attribute of a MeshSurfaceMGXS contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the derived attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute derived", "output": "The derived attribute of a MeshSurfaceMGXS contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "What is the mgxs_type attribute of a MeshSurfaceMGXS?", "input": "OpenMC Python API MeshSurfaceMGXS attribute mgxs_type", "output": "The mgxs_type attribute of a MeshSurfaceMGXS contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a MeshSurfaceMGXS instance." }, { "instruction": "How do you call the __init__() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any). It takes 6 parameters." }, { "instruction": "How do you call the scores() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the domain() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.domain() method signature", "output": "To call the domain() method, use: @property def domain(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the domain() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.domain() method signature", "output": "To call the domain() method, use: @domain.setter def domain(self: Any, domain: Any). It takes 2 parameters." }, { "instruction": "How do you call the domain_type() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.domain_type() method signature", "output": "To call the domain_type() method, use: @property def domain_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the domain_type() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.domain_type() method signature", "output": "To call the domain_type() method, use: @domain_type.setter def domain_type(self: Any, domain_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the filters() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_tally() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.xs_tally() method signature", "output": "To call the xs_tally() method, use: @property def xs_tally(self: Any). It takes 1 parameters." }, { "instruction": "What does the load_from_statepoint() method do in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.load_from_statepoint() method", "output": "The load_from_statepoint() method extracts tallies in an openmc statepoint with the data needed to compute multi-group cross sections. this method is needed to compute cross section data from tallies in an openmc statepoint object. .. note:: the statepoint must first be linked with a :class:`openmc.summary` object. It's used for meshsurfacemgxs operations." }, { "instruction": "How do you call the load_from_statepoint() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.load_from_statepoint() method signature", "output": "To call the load_from_statepoint() method, use: def load_from_statepoint(self: Any, statepoint: Any). It takes 2 parameters." }, { "instruction": "What does the statepoint parameter do in the load_from_statepoint() method?", "input": "OpenMC Python API MeshSurfaceMGXS.load_from_statepoint() parameter statepoint", "output": "The statepoint parameter an openmc statepoint object with tally data. It should be a openmc.StatePoint value." }, { "instruction": "What does the get_xs() method do in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() method", "output": "The get_xs() method returns an array of multi-group cross sections. this method constructs a 3d numpy array for the requested multi-group cross section data for one or more subdomains (1st dimension), energy groups (2nd dimension), and nuclides (3rd dimension). It's used for meshsurfacemgxs operations." }, { "instruction": "How do you call the get_xs() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() method signature", "output": "To call the get_xs() method, use: def get_xs(self: Any, groups: Any, subdomains: Any, nuclides: Any, xs_type: Any, order_groups: Any, value: Any, squeeze: Any). It takes 8 parameters." }, { "instruction": "What does the groups parameter do in the get_xs() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the subdomains parameter do in the get_xs() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() parameter subdomains", "output": "The subdomains parameter subdomain ids of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_xs() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() parameter nuclides", "output": "The nuclides parameter unused in meshsurfacemgxs, its value will be ignored. the nuclides dimension of the resultant array will always have a length of 1.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_xs() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() parameter xs_type", "output": "The xs_type parameter the 'macro'/'micro' distinction does not apply to meshsurfacemgxs. the calculation of a 'micro' xs_type is omited in this class.. It should be a {'macro'} value." }, { "instruction": "What does the order_groups parameter do in the get_xs() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() parameter order_groups", "output": "The order_groups parameter return the cross section indexed according to increasing or decreasing energy groups (decreasing or increasing energies). defaults to 'increasing'.. It should be a {'increasing', 'decreasing'} value." }, { "instruction": "What does the value parameter do in the get_xs() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() parameter value", "output": "The value parameter a string for the type of value to return. defaults to 'mean'.. It should be a {'mean', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the squeeze parameter do in the get_xs() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_xs() parameter squeeze", "output": "The squeeze parameter a boolean representing whether to eliminate the extra dimensions of the multi-dimensional array to be returned. defaults to true.. It should be a bool value." }, { "instruction": "What does the get_pandas_dataframe() method do in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method build a pandas dataframe for the mgxs data. this method leverages :meth:`openmc.tally.get_pandas_dataframe`, but renames the columns with terminology appropriate for cross section data. It's used for meshsurfacemgxs operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the MeshSurfaceMGXS class?", "input": "OpenMC Python API MeshSurfaceMGXS.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, groups: Any, nuclides: Any, xs_type: Any, paths: Any). It takes 5 parameters." }, { "instruction": "What does the groups parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_pandas_dataframe() parameter groups", "output": "The groups parameter energy groups of interest. defaults to 'all'.. It should be a Iterable of Integral or 'all' value." }, { "instruction": "What does the nuclides parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_pandas_dataframe() parameter nuclides", "output": "The nuclides parameter unused in meshsurfacemgxs, its value will be ignored. the nuclides dimension of the resultant array will always have a length of 1.. It should be a Iterable of str or 'all' or 'sum' value." }, { "instruction": "What does the xs_type parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_pandas_dataframe() parameter xs_type", "output": "The xs_type parameter 'micro' unused in meshsurfacemgxs.. It should be a {'macro'} value." }, { "instruction": "What does the paths parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API MeshSurfaceMGXS.get_pandas_dataframe() parameter paths", "output": "The paths parameter construct columns for distribcell tally filters (default is true). the geometric information in the summary object is embedded into a multi-index column with a geometric \"path\" to each distribcell instance.. It should be a bool, optional value." }, { "instruction": "What is the Current class in OpenMC's Python API?", "input": "OpenMC Python API Current class", "output": "The Current class represents a current multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute surface- and energy-integrated multi-group current cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`current.energy_groups` and :attr:`current.domain` properties. tallies for the appropriate reaction rates over the specified domain are generated automatically via the :attr:`current.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`current.xs_tally` property. for a spatial domain :math:`s` and energy group :math:`[e_g,e_{g-1}]`, the total cross section is calculated as: .. math:: \\frac{\\int_{r \\in s} ds \\int_{e_g}^{e_{g-1}} de \\; j(r, e)}{\\int_{r \\in s} ds \\int_{e_g}^{e_{g-1}} de}. .. versionadded:: 0.12.1. It provides 1 methods and 0 properties for working with current data in OpenMC." }, { "instruction": "What does the Current class do in OpenMC's Python API?", "input": "OpenMC Python API Current class description", "output": "The Current class a current multi-group cross section. this class can be used for both openmc input generation and tally data post-processing to compute surface- and energy-integrated multi-group current cross sections for multi-group neutronics calculations. at a minimum, one needs to set the :attr:`current.energy_groups` and :attr:`current.domain` properties. tallies for the appropriate reaction rates over the specified domain are generated automatically via the :attr:`current.tallies` property, which can then be appended to a :class:`openmc.tallies` instance. for post-processing, the :meth:`mgxs.load_from_statepoint` will pull in the necessary data to compute multi-group cross sections from a :class:`openmc.statepoint` instance. the derived multi-group cross section can then be obtained from the :attr:`current.xs_tally` property. for a spatial domain :math:`s` and energy group :math:`[e_g,e_{g-1}]`, the total cross section is calculated as: .. math:: \\frac{\\int_{r \\in s} ds \\int_{e_g}^{e_{g-1}} de \\; j(r, e)}{\\int_{r \\in s} ds \\int_{e_g}^{e_{g-1}} de}. .. versionadded:: 0.12.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domain parameter do when creating a Current?", "input": "OpenMC Python API Current constructor parameter domain", "output": "When creating a Current, the domain parameter specifies the domain for spatial homogenization. It should be a openmc.RegularMesh value." }, { "instruction": "What does the domain_type parameter do when creating a Current?", "input": "OpenMC Python API Current constructor parameter domain_type", "output": "When creating a Current, the domain_type parameter specifies the domain type for spatial homogenization. It should be a ('mesh'} value." }, { "instruction": "What does the groups parameter do when creating a Current?", "input": "OpenMC Python API Current constructor parameter groups", "output": "When creating a Current, the groups parameter specifies the energy group structure for energy condensation. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the by_nuclide parameter do when creating a Current?", "input": "OpenMC Python API Current constructor parameter by_nuclide", "output": "When creating a Current, the by_nuclide parameter specifies unused in meshsurfacemgxs. It should be a bool value." }, { "instruction": "What does the name parameter do when creating a Current?", "input": "OpenMC Python API Current constructor parameter name", "output": "When creating a Current, the name parameter specifies name of the multi-group cross section. used as a label to identify tallies in openmc 'tallies.xml' file.. It should be a str, optional value." }, { "instruction": "What is the name attribute of a Current?", "input": "OpenMC Python API Current attribute name", "output": "The name attribute of a Current contains name of the multi-group cross section. It's a str, optional value that you can access after creating a Current instance." }, { "instruction": "What is the rxn_type attribute of a Current?", "input": "OpenMC Python API Current attribute rxn_type", "output": "The rxn_type attribute of a Current contains reaction type (e.g., 'total', 'nu-fission', etc.). It's a str value that you can access after creating a Current instance." }, { "instruction": "What is the by_nuclide attribute of a Current?", "input": "OpenMC Python API Current attribute by_nuclide", "output": "The by_nuclide attribute of a Current contains unused in meshsurfacemgxs. It's a bool value that you can access after creating a Current instance." }, { "instruction": "What is the domain attribute of a Current?", "input": "OpenMC Python API Current attribute domain", "output": "The domain attribute of a Current contains domain for spatial homogenization. It's a openmc.RegularMesh value that you can access after creating a Current instance." }, { "instruction": "What is the domain_type attribute of a Current?", "input": "OpenMC Python API Current attribute domain_type", "output": "The domain_type attribute of a Current contains domain type for spatial homogenization. It's a {'mesh'} value that you can access after creating a Current instance." }, { "instruction": "What is the energy_groups attribute of a Current?", "input": "OpenMC Python API Current attribute energy_groups", "output": "The energy_groups attribute of a Current contains energy group structure for energy condensation. It's a openmc.mgxs.EnergyGroups value that you can access after creating a Current instance." }, { "instruction": "What is the tally_trigger attribute of a Current?", "input": "OpenMC Python API Current attribute tally_trigger", "output": "The tally_trigger attribute of a Current contains an (optional) tally precision trigger given to each tally used to compute the cross section. It's a openmc.Trigger value that you can access after creating a Current instance." }, { "instruction": "What is the scores attribute of a Current?", "input": "OpenMC Python API Current attribute scores", "output": "The scores attribute of a Current contains the scores in each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a Current instance." }, { "instruction": "What is the filters attribute of a Current?", "input": "OpenMC Python API Current attribute filters", "output": "The filters attribute of a Current contains the filters in each tally used to compute the multi-group cross section. It's a list of openmc.Filter value that you can access after creating a Current instance." }, { "instruction": "What is the tally_keys attribute of a Current?", "input": "OpenMC Python API Current attribute tally_keys", "output": "The tally_keys attribute of a Current contains the keys into the tallies dictionary for each tally used to compute the multi-group cross section. It's a list of str value that you can access after creating a Current instance." }, { "instruction": "What is the estimator attribute of a Current?", "input": "OpenMC Python API Current attribute estimator", "output": "The estimator attribute of a Current contains the tally estimator used to compute the multi-group cross section. It's a {'analog'} value that you can access after creating a Current instance." }, { "instruction": "What is the tallies attribute of a Current?", "input": "OpenMC Python API Current attribute tallies", "output": "The tallies attribute of a Current contains openmc tallies needed to compute the multi-group cross section. the keys are strings listed in the :attr:`totalxs.tally_keys` property and values are instances of :class:`openmc.tally`.. It's a dict value that you can access after creating a Current instance." }, { "instruction": "What is the rxn_rate_tally attribute of a Current?", "input": "OpenMC Python API Current attribute rxn_rate_tally", "output": "The rxn_rate_tally attribute of a Current contains derived tally for the reaction rate tally used in the numerator to compute the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a Current instance." }, { "instruction": "What is the xs_tally attribute of a Current?", "input": "OpenMC Python API Current attribute xs_tally", "output": "The xs_tally attribute of a Current contains derived tally for the multi-group cross section. this attribute is none unless the multi-group cross section has been computed.. It's a openmc.Tally value that you can access after creating a Current instance." }, { "instruction": "What is the num_subdomains attribute of a Current?", "input": "OpenMC Python API Current attribute num_subdomains", "output": "The num_subdomains attribute of a Current contains the number of subdomains is equal to the number of mesh surfaces times two to account for both the incoming and outgoing current from the mesh cell surfaces.. It's a int value that you can access after creating a Current instance." }, { "instruction": "What is the num_nuclides attribute of a Current?", "input": "OpenMC Python API Current attribute num_nuclides", "output": "The num_nuclides attribute of a Current contains unused in meshsurfacemgxs. It's a int value that you can access after creating a Current instance." }, { "instruction": "What is the nuclides attribute of a Current?", "input": "OpenMC Python API Current attribute nuclides", "output": "The nuclides attribute of a Current contains unused in meshsurfacemgxs. It's a Iterable of str or 'sum' value that you can access after creating a Current instance." }, { "instruction": "What is the sparse attribute of a Current?", "input": "OpenMC Python API Current attribute sparse", "output": "The sparse attribute of a Current contains whether or not the mgxs' tallies use scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a Current instance." }, { "instruction": "What is the loaded_sp attribute of a Current?", "input": "OpenMC Python API Current attribute loaded_sp", "output": "The loaded_sp attribute of a Current contains whether or not a statepoint file has been loaded with tally data. It's a bool value that you can access after creating a Current instance." }, { "instruction": "What is the derived attribute of a Current?", "input": "OpenMC Python API Current attribute derived", "output": "The derived attribute of a Current contains whether or not the mgxs is merged from one or more other mgxs. It's a bool value that you can access after creating a Current instance." }, { "instruction": "What is the mgxs_type attribute of a Current?", "input": "OpenMC Python API Current attribute mgxs_type", "output": "The mgxs_type attribute of a Current contains the name of this mgxs type, to be used when printing and indexing in an hdf5 data store .. versionadded:: 0.13.1. It's a str value that you can access after creating a Current instance." }, { "instruction": "How do you call the __init__() method in the Current class?", "input": "OpenMC Python API Current.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domain: Any, domain_type: Any, energy_groups: Any, by_nuclide: Any, name: Any). It takes 6 parameters." }, { "instruction": "What does the _df_column_convert_to_bin() function do in OpenMC's Python API?", "input": "OpenMC Python API _df_column_convert_to_bin() function", "output": "The _df_column_convert_to_bin() function convert a pandas dataframe column from the bin edges to an index for each bin. this method operates on the dataframe, df, in-place. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _df_column_convert_to_bin() function in OpenMC's Python API?", "input": "OpenMC Python API _df_column_convert_to_bin() function purpose", "output": "The _df_column_convert_to_bin() function convert a pandas dataframe column from the bin edges to an index for each bin. this method operates on the dataframe, df, in-place. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _df_column_convert_to_bin() function in OpenMC's Python API?", "input": "OpenMC Python API _df_column_convert_to_bin() function signature", "output": "To call the _df_column_convert_to_bin() function, use: def _df_column_convert_to_bin(df: Any, current_name: Any, new_name: Any, values_to_bin: Any, reverse_order: Any). It takes 5 parameters." }, { "instruction": "What does the df parameter do in the _df_column_convert_to_bin() function?", "input": "OpenMC Python API _df_column_convert_to_bin() parameter df", "output": "The df parameter a pandas dataframe containing the cross section data.. It should be a pandas.DataFrame value." }, { "instruction": "What does the current_name parameter do in the _df_column_convert_to_bin() function?", "input": "OpenMC Python API _df_column_convert_to_bin() parameter current_name", "output": "The current_name parameter name of the column to replace with bins. It should be a str value." }, { "instruction": "What does the new_name parameter do in the _df_column_convert_to_bin() function?", "input": "OpenMC Python API _df_column_convert_to_bin() parameter new_name", "output": "The new_name parameter new name for column after the data is replaced with bins. It should be a str value." }, { "instruction": "What does the values_to_bin parameter do in the _df_column_convert_to_bin() function?", "input": "OpenMC Python API _df_column_convert_to_bin() parameter values_to_bin", "output": "The values_to_bin parameter values of the bin edges to be used for identifying the bins. It should be a Iterable of Real value." }, { "instruction": "What does the reverse_order parameter do in the _df_column_convert_to_bin() function?", "input": "OpenMC Python API _df_column_convert_to_bin() parameter reverse_order", "output": "The reverse_order parameter whether the bin indices should be reversed. It should be a bool value." }, { "instruction": "How do you call the add_params() function in OpenMC's Python API?", "input": "OpenMC Python API add_params() function signature", "output": "To call the add_params() function, use: def add_params(cls: Any). It takes 1 parameters." }, { "instruction": "How do you call the print_groups_and_histogram() function in OpenMC's Python API?", "input": "OpenMC Python API print_groups_and_histogram() function signature", "output": "To call the print_groups_and_histogram() function, use: def print_groups_and_histogram(avg_xs: Any, err_xs: Any, num_groups: Any, num_histogram_bins: Any). It takes 4 parameters." }, { "instruction": "What is the XSdata class in OpenMC's Python API?", "input": "OpenMC Python API XSdata class", "output": "The XSdata class represents a multi-group cross section data set providing all the multi-group data necessary for a multi-group openmc calculation. It provides 78 methods and 0 properties for working with xsdata data in OpenMC." }, { "instruction": "What does the XSdata class do in OpenMC's Python API?", "input": "OpenMC Python API XSdata class description", "output": "The XSdata class a multi-group cross section data set providing all the multi-group data necessary for a multi-group openmc calculation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a XSdata?", "input": "OpenMC Python API XSdata constructor parameter name", "output": "When creating a XSdata, the name parameter specifies name of the mgxs data set.. It should be a str value." }, { "instruction": "What does the energy_groups parameter do when creating a XSdata?", "input": "OpenMC Python API XSdata constructor parameter energy_groups", "output": "When creating a XSdata, the energy_groups parameter specifies energy group structure. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the representation parameter do when creating a XSdata?", "input": "OpenMC Python API XSdata constructor parameter representation", "output": "When creating a XSdata, the representation parameter specifies method used in generating the mgxs (isotropic or angle-dependent flux weighting). defaults to 'isotropic'. It should be a {'isotropic', 'angle'}, optional value." }, { "instruction": "What does the temperatures parameter do when creating a XSdata?", "input": "OpenMC Python API XSdata constructor parameter temperatures", "output": "When creating a XSdata, the temperatures parameter specifies temperatures (in units of kelvin) of the provided datasets. defaults to a single temperature at 294k.. It should be a Iterable of float value." }, { "instruction": "What does the num_delayed_groups parameter do when creating a XSdata?", "input": "OpenMC Python API XSdata constructor parameter num_delayed_groups", "output": "When creating a XSdata, the num_delayed_groups parameter specifies number of delayed groups. It should be a int value." }, { "instruction": "What is the name attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute name", "output": "The name attribute of a XSdata contains unique identifier for the xsdata object. It's a str value that you can access after creating a XSdata instance." }, { "instruction": "What is the atomic_weight_ratio attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute atomic_weight_ratio", "output": "The atomic_weight_ratio attribute of a XSdata contains atomic weight ratio of an isotope. that is, the ratio of the mass of the isotope to the mass of a single neutron.. It's a float value that you can access after creating a XSdata instance." }, { "instruction": "What is the temperatures attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute temperatures", "output": "The temperatures attribute of a XSdata contains temperatures (in units of kelvin) of the provided datasets. defaults to a single temperature at 294k.. It's a numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the energy_groups attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute energy_groups", "output": "The energy_groups attribute of a XSdata contains energy group structure. It's a openmc.mgxs.EnergyGroups value that you can access after creating a XSdata instance." }, { "instruction": "What is the num_delayed_groups attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute num_delayed_groups", "output": "The num_delayed_groups attribute of a XSdata contains num delayed groups. It's a int value that you can access after creating a XSdata instance." }, { "instruction": "What is the fissionable attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute fissionable", "output": "The fissionable attribute of a XSdata contains whether or not this is a fissionable data set.. It's a bool value that you can access after creating a XSdata instance." }, { "instruction": "What is the scatter_format attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute scatter_format", "output": "The scatter_format attribute of a XSdata contains angular distribution representation (legendre, histogram, or tabular). It's a {'legendre', 'histogram', or 'tabular'} value that you can access after creating a XSdata instance." }, { "instruction": "What is the order attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute order", "output": "The order attribute of a XSdata contains either the legendre order, number of bins, or number of points used to describe the angular distribution associated with each group-to-group transfer probability.. It's a int value that you can access after creating a XSdata instance." }, { "instruction": "What is the representation attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute representation", "output": "The representation attribute of a XSdata contains method used in generating the mgxs (isotropic or angle-dependent flux weighting).. It's a {'isotropic', 'angle'} value that you can access after creating a XSdata instance." }, { "instruction": "What is the num_azimuthal attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute num_azimuthal", "output": "The num_azimuthal attribute of a XSdata contains number of equal width angular bins that the azimuthal angular domain is subdivided into. this only applies when :attr:`xsdata.representation` is \"angle\".. It's a int value that you can access after creating a XSdata instance." }, { "instruction": "What is the num_polar attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute num_polar", "output": "The num_polar attribute of a XSdata contains number of equal width angular bins that the polar angular domain is subdivided into. this only applies when :attr:`xsdata.representation` is \"angle\".. It's a int value that you can access after creating a XSdata instance." }, { "instruction": "What is the total attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute total", "output": "The total attribute of a XSdata contains group-wise total cross section.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the absorption attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute absorption", "output": "The absorption attribute of a XSdata contains group-wise absorption cross section.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the scatter_matrix attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute scatter_matrix", "output": "The scatter_matrix attribute of a XSdata contains scattering moment matrices presented with the columns representing incoming group and rows representing the outgoing group. that is, down-scatter will be above the diagonal of the resultant matrix.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the multiplicity_matrix attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute multiplicity_matrix", "output": "The multiplicity_matrix attribute of a XSdata contains ratio of neutrons produced in scattering collisions to the neutrons which undergo scattering collisions; that is, the multiplicity provides the code with a scaling factor to account for neutrons produced in (n,xn) reactions.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the fission attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute fission", "output": "The fission attribute of a XSdata contains group-wise fission cross section.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the kappa_fission attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute kappa_fission", "output": "The kappa_fission attribute of a XSdata contains group-wise kappa_fission cross section.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the chi attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute chi", "output": "The chi attribute of a XSdata contains group-wise fission spectra ordered by increasing group index (i.e., fast to thermal). this attribute should be used if making the common approximation that the fission spectra does not depend on incoming energy. if the user does not wish to make this approximation, then this should not be provided and this information included in the :attr:`xsdata.nu_fission` attribute instead.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the chi_prompt attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute chi_prompt", "output": "The chi_prompt attribute of a XSdata contains group-wise prompt fission spectra ordered by increasing group index (i.e., fast to thermal). this attribute should be used if chi from prompt and delayed neutrons is being set separately.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the chi_delayed attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute chi_delayed", "output": "The chi_delayed attribute of a XSdata contains group-wise delayed fission spectra ordered by increasing group index (i.e., fast to thermal). this attribute should be used if chi from prompt and delayed neutrons is being set separately.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the nu_fission attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute nu_fission", "output": "The nu_fission attribute of a XSdata contains group-wise fission production cross section vector (i.e., if ``chi`` is provided), or is the group-wise fission production matrix.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the prompt_nu_fission attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute prompt_nu_fission", "output": "The prompt_nu_fission attribute of a XSdata contains group-wise prompt fission production cross section vector.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the delayed_nu_fission attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute delayed_nu_fission", "output": "The delayed_nu_fission attribute of a XSdata contains group-wise delayed fission production cross section vector.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the beta attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute beta", "output": "The beta attribute of a XSdata contains delayed-group-wise delayed neutron fraction cross section vector.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the decay_rate attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute decay_rate", "output": "The decay_rate attribute of a XSdata contains delayed-group-wise decay rate vector.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the inverse_velocity attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute inverse_velocity", "output": "The inverse_velocity attribute of a XSdata contains inverse of velocity, in units of sec/cm.. It's a list of numpy.ndarray value that you can access after creating a XSdata instance." }, { "instruction": "What is the xs_shapes attribute of a XSdata?", "input": "OpenMC Python API XSdata attribute xs_shapes", "output": "The xs_shapes attribute of a XSdata contains dictionary with keys of _xs_shapes and iterable of int values with the corresponding shapes where \"order\" corresponds to the pn scattering order, \"g\" corresponds to incoming energy group, \"g'\" corresponds to outgoing energy group, and \"dg\" corresponds to delayed group.. It's a dict of iterable of int value that you can access after creating a XSdata instance." }, { "instruction": "How do you call the __init__() method in the XSdata class?", "input": "OpenMC Python API XSdata.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, name: Any, energy_groups: Any, temperatures: Any, representation: Any, num_delayed_groups: Any). It takes 6 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the XSdata class?", "input": "OpenMC Python API XSdata.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the XSdata class?", "input": "OpenMC Python API XSdata.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the XSdata class?", "input": "OpenMC Python API XSdata.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_groups() method in the XSdata class?", "input": "OpenMC Python API XSdata.energy_groups() method signature", "output": "To call the energy_groups() method, use: @property def energy_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_groups() method in the XSdata class?", "input": "OpenMC Python API XSdata.energy_groups() method signature", "output": "To call the energy_groups() method, use: @energy_groups.setter def energy_groups(self: Any, energy_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_delayed_groups() method in the XSdata class?", "input": "OpenMC Python API XSdata.num_delayed_groups() method signature", "output": "To call the num_delayed_groups() method, use: @property def num_delayed_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_delayed_groups() method in the XSdata class?", "input": "OpenMC Python API XSdata.num_delayed_groups() method signature", "output": "To call the num_delayed_groups() method, use: @num_delayed_groups.setter def num_delayed_groups(self: Any, num_delayed_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the representation() method in the XSdata class?", "input": "OpenMC Python API XSdata.representation() method signature", "output": "To call the representation() method, use: @property def representation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the representation() method in the XSdata class?", "input": "OpenMC Python API XSdata.representation() method signature", "output": "To call the representation() method, use: @representation.setter def representation(self: Any, representation: Any). It takes 2 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the XSdata class?", "input": "OpenMC Python API XSdata.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @property def atomic_weight_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atomic_weight_ratio() method in the XSdata class?", "input": "OpenMC Python API XSdata.atomic_weight_ratio() method signature", "output": "To call the atomic_weight_ratio() method, use: @atomic_weight_ratio.setter def atomic_weight_ratio(self: Any, atomic_weight_ratio: Any). It takes 2 parameters." }, { "instruction": "How do you call the fissionable() method in the XSdata class?", "input": "OpenMC Python API XSdata.fissionable() method signature", "output": "To call the fissionable() method, use: @property def fissionable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the temperatures() method in the XSdata class?", "input": "OpenMC Python API XSdata.temperatures() method signature", "output": "To call the temperatures() method, use: @property def temperatures(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the temperatures() method in the XSdata class?", "input": "OpenMC Python API XSdata.temperatures() method signature", "output": "To call the temperatures() method, use: @temperatures.setter def temperatures(self: Any, temperatures: Any). It takes 2 parameters." }, { "instruction": "How do you call the scatter_format() method in the XSdata class?", "input": "OpenMC Python API XSdata.scatter_format() method signature", "output": "To call the scatter_format() method, use: @property def scatter_format(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scatter_format() method in the XSdata class?", "input": "OpenMC Python API XSdata.scatter_format() method signature", "output": "To call the scatter_format() method, use: @scatter_format.setter def scatter_format(self: Any, scatter_format: Any). It takes 2 parameters." }, { "instruction": "How do you call the order() method in the XSdata class?", "input": "OpenMC Python API XSdata.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the order() method in the XSdata class?", "input": "OpenMC Python API XSdata.order() method signature", "output": "To call the order() method, use: @order.setter def order(self: Any, order: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_polar() method in the XSdata class?", "input": "OpenMC Python API XSdata.num_polar() method signature", "output": "To call the num_polar() method, use: @property def num_polar(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_polar() method in the XSdata class?", "input": "OpenMC Python API XSdata.num_polar() method signature", "output": "To call the num_polar() method, use: @num_polar.setter def num_polar(self: Any, num_polar: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_azimuthal() method in the XSdata class?", "input": "OpenMC Python API XSdata.num_azimuthal() method signature", "output": "To call the num_azimuthal() method, use: @property def num_azimuthal(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_azimuthal() method in the XSdata class?", "input": "OpenMC Python API XSdata.num_azimuthal() method signature", "output": "To call the num_azimuthal() method, use: @num_azimuthal.setter def num_azimuthal(self: Any, num_azimuthal: Any). It takes 2 parameters." }, { "instruction": "How do you call the total() method in the XSdata class?", "input": "OpenMC Python API XSdata.total() method signature", "output": "To call the total() method, use: @property def total(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the absorption() method in the XSdata class?", "input": "OpenMC Python API XSdata.absorption() method signature", "output": "To call the absorption() method, use: @property def absorption(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scatter_matrix() method in the XSdata class?", "input": "OpenMC Python API XSdata.scatter_matrix() method signature", "output": "To call the scatter_matrix() method, use: @property def scatter_matrix(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the multiplicity_matrix() method in the XSdata class?", "input": "OpenMC Python API XSdata.multiplicity_matrix() method signature", "output": "To call the multiplicity_matrix() method, use: @property def multiplicity_matrix(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.fission() method signature", "output": "To call the fission() method, use: @property def fission(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nu_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.nu_fission() method signature", "output": "To call the nu_fission() method, use: @property def nu_fission(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the prompt_nu_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.prompt_nu_fission() method signature", "output": "To call the prompt_nu_fission() method, use: @property def prompt_nu_fission(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the delayed_nu_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.delayed_nu_fission() method signature", "output": "To call the delayed_nu_fission() method, use: @property def delayed_nu_fission(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the kappa_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.kappa_fission() method signature", "output": "To call the kappa_fission() method, use: @property def kappa_fission(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the chi() method in the XSdata class?", "input": "OpenMC Python API XSdata.chi() method signature", "output": "To call the chi() method, use: @property def chi(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the chi_prompt() method in the XSdata class?", "input": "OpenMC Python API XSdata.chi_prompt() method signature", "output": "To call the chi_prompt() method, use: @property def chi_prompt(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the chi_delayed() method in the XSdata class?", "input": "OpenMC Python API XSdata.chi_delayed() method signature", "output": "To call the chi_delayed() method, use: @property def chi_delayed(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the beta() method in the XSdata class?", "input": "OpenMC Python API XSdata.beta() method signature", "output": "To call the beta() method, use: @property def beta(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the decay_rate() method in the XSdata class?", "input": "OpenMC Python API XSdata.decay_rate() method signature", "output": "To call the decay_rate() method, use: @property def decay_rate(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the inverse_velocity() method in the XSdata class?", "input": "OpenMC Python API XSdata.inverse_velocity() method signature", "output": "To call the inverse_velocity() method, use: @property def inverse_velocity(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_orders() method in the XSdata class?", "input": "OpenMC Python API XSdata.num_orders() method signature", "output": "To call the num_orders() method, use: @property def num_orders(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs_shapes() method in the XSdata class?", "input": "OpenMC Python API XSdata.xs_shapes() method signature", "output": "To call the xs_shapes() method, use: @property def xs_shapes(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_temperature() method do in the XSdata class?", "input": "OpenMC Python API XSdata.add_temperature() method", "output": "The add_temperature() method this method re-sizes the attributes of this xsdata object so that it can accommodate an additional temperature. note that the set_* methods will still need to be executed. It's used for xsdata operations." }, { "instruction": "How do you call the add_temperature() method in the XSdata class?", "input": "OpenMC Python API XSdata.add_temperature() method signature", "output": "To call the add_temperature() method, use: def add_temperature(self: Any, temperature: Any). It takes 2 parameters." }, { "instruction": "What does the temperature parameter do in the add_temperature() method?", "input": "OpenMC Python API XSdata.add_temperature() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset.. It should be a float value." }, { "instruction": "How do you call the _check_temperature() method in the XSdata class?", "input": "OpenMC Python API XSdata._check_temperature() method signature", "output": "To call the _check_temperature() method, use: def _check_temperature(self: Any, temperature: Any). It takes 2 parameters." }, { "instruction": "How do you call the _temperature_index() method in the XSdata class?", "input": "OpenMC Python API XSdata._temperature_index() method signature", "output": "To call the _temperature_index() method, use: def _temperature_index(self: Any, temperature: Any). It takes 2 parameters." }, { "instruction": "How do you call the _set_fissionable() method in the XSdata class?", "input": "OpenMC Python API XSdata._set_fissionable() method signature", "output": "To call the _set_fissionable() method, use: def _set_fissionable(self: Any, array: Any). It takes 2 parameters." }, { "instruction": "What does the set_total() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_total() method", "output": "The set_total() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_total() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_total() method signature", "output": "To call the set_total() method, use: def set_total(self: Any, total: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the total parameter do in the set_total() method?", "input": "OpenMC Python API XSdata.set_total() parameter total", "output": "The total parameter total cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_total() method?", "input": "OpenMC Python API XSdata.set_total() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_total_mgxs(). It should be a float value." }, { "instruction": "What does the set_absorption() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_absorption() method", "output": "The set_absorption() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_absorption() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_absorption() method signature", "output": "To call the set_absorption() method, use: def set_absorption(self: Any, absorption: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the absorption parameter do in the set_absorption() method?", "input": "OpenMC Python API XSdata.set_absorption() parameter absorption", "output": "The absorption parameter absorption cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_absorption() method?", "input": "OpenMC Python API XSdata.set_absorption() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_absorption_mgxs(). It should be a float value." }, { "instruction": "What does the set_fission() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_fission() method", "output": "The set_fission() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_fission() method signature", "output": "To call the set_fission() method, use: def set_fission(self: Any, fission: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the fission parameter do in the set_fission() method?", "input": "OpenMC Python API XSdata.set_fission() parameter fission", "output": "The fission parameter fission cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_fission() method?", "input": "OpenMC Python API XSdata.set_fission() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_fission_mgxs(). It should be a float value." }, { "instruction": "What does the set_kappa_fission() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_kappa_fission() method", "output": "The set_kappa_fission() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_kappa_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_kappa_fission() method signature", "output": "To call the set_kappa_fission() method, use: def set_kappa_fission(self: Any, kappa_fission: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the kappa_fission parameter do in the set_kappa_fission() method?", "input": "OpenMC Python API XSdata.set_kappa_fission() parameter kappa_fission", "output": "The kappa_fission parameter kappa-fission cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_kappa_fission() method?", "input": "OpenMC Python API XSdata.set_kappa_fission() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_kappa_fission_mgxs(). It should be a float value." }, { "instruction": "What does the set_chi() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi() method", "output": "The set_chi() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_chi() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi() method signature", "output": "To call the set_chi() method, use: def set_chi(self: Any, chi: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the chi parameter do in the set_chi() method?", "input": "OpenMC Python API XSdata.set_chi() parameter chi", "output": "The chi parameter fission spectrum. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_chi() method?", "input": "OpenMC Python API XSdata.set_chi() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_chi_mgxs(). It should be a float value." }, { "instruction": "What does the set_chi_prompt() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_prompt() method", "output": "The set_chi_prompt() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_chi_prompt() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_prompt() method signature", "output": "To call the set_chi_prompt() method, use: def set_chi_prompt(self: Any, chi_prompt: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the chi_prompt parameter do in the set_chi_prompt() method?", "input": "OpenMC Python API XSdata.set_chi_prompt() parameter chi_prompt", "output": "The chi_prompt parameter prompt fission spectrum. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_chi_prompt() method?", "input": "OpenMC Python API XSdata.set_chi_prompt() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k see also -------- openmc.mgxs_library.set_chi_prompt_mgxs(). It should be a float value." }, { "instruction": "What does the set_chi_delayed() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_delayed() method", "output": "The set_chi_delayed() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_chi_delayed() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_delayed() method signature", "output": "To call the set_chi_delayed() method, use: def set_chi_delayed(self: Any, chi_delayed: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the chi_delayed parameter do in the set_chi_delayed() method?", "input": "OpenMC Python API XSdata.set_chi_delayed() parameter chi_delayed", "output": "The chi_delayed parameter delayed fission spectrum. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_chi_delayed() method?", "input": "OpenMC Python API XSdata.set_chi_delayed() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k see also -------- openmc.mgxs_library.set_chi_delayed_mgxs(). It should be a float value." }, { "instruction": "What does the set_beta() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_beta() method", "output": "The set_beta() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_beta() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_beta() method signature", "output": "To call the set_beta() method, use: def set_beta(self: Any, beta: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the beta parameter do in the set_beta() method?", "input": "OpenMC Python API XSdata.set_beta() parameter beta", "output": "The beta parameter delayed fission spectrum. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_beta() method?", "input": "OpenMC Python API XSdata.set_beta() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k see also -------- openmc.mgxs_library.set_beta_mgxs(). It should be a float value." }, { "instruction": "What does the set_decay_rate() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_decay_rate() method", "output": "The set_decay_rate() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_decay_rate() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_decay_rate() method signature", "output": "To call the set_decay_rate() method, use: def set_decay_rate(self: Any, decay_rate: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the decay_rate parameter do in the set_decay_rate() method?", "input": "OpenMC Python API XSdata.set_decay_rate() parameter decay_rate", "output": "The decay_rate parameter delayed neutron precursor decay rate. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_decay_rate() method?", "input": "OpenMC Python API XSdata.set_decay_rate() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k see also -------- openmc.mgxs_library.set_decay_rate_mgxs(). It should be a float value." }, { "instruction": "What does the set_scatter_matrix() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_scatter_matrix() method", "output": "The set_scatter_matrix() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_scatter_matrix() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_scatter_matrix() method signature", "output": "To call the set_scatter_matrix() method, use: def set_scatter_matrix(self: Any, scatter: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the scatter parameter do in the set_scatter_matrix() method?", "input": "OpenMC Python API XSdata.set_scatter_matrix() parameter scatter", "output": "The scatter parameter scattering matrix cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_scatter_matrix() method?", "input": "OpenMC Python API XSdata.set_scatter_matrix() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_scatter_matrix_mgxs(). It should be a float value." }, { "instruction": "What does the set_multiplicity_matrix() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix() method", "output": "The set_multiplicity_matrix() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_multiplicity_matrix() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix() method signature", "output": "To call the set_multiplicity_matrix() method, use: def set_multiplicity_matrix(self: Any, multiplicity: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the multiplicity parameter do in the set_multiplicity_matrix() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix() parameter multiplicity", "output": "The multiplicity parameter multiplicity matrix cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_multiplicity_matrix() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_multiplicity_matrix_mgxs(). It should be a float value." }, { "instruction": "What does the set_nu_fission() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_nu_fission() method", "output": "The set_nu_fission() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_nu_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_nu_fission() method signature", "output": "To call the set_nu_fission() method, use: def set_nu_fission(self: Any, nu_fission: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the nu_fission parameter do in the set_nu_fission() method?", "input": "OpenMC Python API XSdata.set_nu_fission() parameter nu_fission", "output": "The nu_fission parameter nu-fission cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_nu_fission() method?", "input": "OpenMC Python API XSdata.set_nu_fission() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k). see also -------- openmc.mgxs_library.set_nu_fission_mgxs(). It should be a float value." }, { "instruction": "What does the set_prompt_nu_fission() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission() method", "output": "The set_prompt_nu_fission() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_prompt_nu_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission() method signature", "output": "To call the set_prompt_nu_fission() method, use: def set_prompt_nu_fission(self: Any, prompt_nu_fission: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the prompt_nu_fission parameter do in the set_prompt_nu_fission() method?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission() parameter prompt_nu_fission", "output": "The prompt_nu_fission parameter prompt-nu-fission cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_prompt_nu_fission() method?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k see also -------- openmc.mgxs_library.set_prompt_nu_fission_mgxs(). It should be a float value." }, { "instruction": "What does the set_delayed_nu_fission() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission() method", "output": "The set_delayed_nu_fission() method this method sets the cross section for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_delayed_nu_fission() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission() method signature", "output": "To call the set_delayed_nu_fission() method, use: def set_delayed_nu_fission(self: Any, delayed_nu_fission: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the delayed_nu_fission parameter do in the set_delayed_nu_fission() method?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission() parameter delayed_nu_fission", "output": "The delayed_nu_fission parameter delayed-nu-fission cross section. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_delayed_nu_fission() method?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k see also -------- openmc.mgxs_library.set_delayed_nu_fission_mgxs(). It should be a float value." }, { "instruction": "What does the set_inverse_velocity() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_inverse_velocity() method", "output": "The set_inverse_velocity() method this method sets the inverse velocity for this xsdata object at the provided temperature. It's used for xsdata operations." }, { "instruction": "How do you call the set_inverse_velocity() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_inverse_velocity() method signature", "output": "To call the set_inverse_velocity() method, use: def set_inverse_velocity(self: Any, inv_vel: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the inv_vel parameter do in the set_inverse_velocity() method?", "input": "OpenMC Python API XSdata.set_inverse_velocity() parameter inv_vel", "output": "The inv_vel parameter inverse velocity in units of sec/cm.. It should be a np.ndarray value." }, { "instruction": "What does the temperature parameter do in the set_inverse_velocity() method?", "input": "OpenMC Python API XSdata.set_inverse_velocity() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the set_total_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_total_mgxs() method", "output": "The set_total_mgxs() method this method allows for an openmc.mgxs.totalxs or openmc.mgxs.transportxs to be used to set the total cross section for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_total_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_total_mgxs() method signature", "output": "To call the set_total_mgxs() method, use: def set_total_mgxs(self: Any, total: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the total parameter do in the set_total_mgxs() method?", "input": "OpenMC Python API XSdata.set_total_mgxs() parameter total", "output": "The total parameter mgxs object containing the total, transport or nu-transport cross section for the domain of interest.. It should be a openmc.mgxs.TotalXS or openmc.mgxs.TransportXS value." }, { "instruction": "What does the temperature parameter do in the set_total_mgxs() method?", "input": "OpenMC Python API XSdata.set_total_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_total_mgxs() method?", "input": "OpenMC Python API XSdata.set_total_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_total_mgxs() method?", "input": "OpenMC Python API XSdata.set_total_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_total_mgxs() method?", "input": "OpenMC Python API XSdata.set_total_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_absorption_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_absorption_mgxs() method", "output": "The set_absorption_mgxs() method this method allows for an openmc.mgxs.absorptionxs to be used to set the absorption cross section for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_absorption_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_absorption_mgxs() method signature", "output": "To call the set_absorption_mgxs() method, use: def set_absorption_mgxs(self: Any, absorption: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the absorption parameter do in the set_absorption_mgxs() method?", "input": "OpenMC Python API XSdata.set_absorption_mgxs() parameter absorption", "output": "The absorption parameter mgxs object containing the absorption cross section for the domain of interest.. It should be a openmc.mgxs.AbsorptionXS value." }, { "instruction": "What does the temperature parameter do in the set_absorption_mgxs() method?", "input": "OpenMC Python API XSdata.set_absorption_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_absorption_mgxs() method?", "input": "OpenMC Python API XSdata.set_absorption_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_absorption_mgxs() method?", "input": "OpenMC Python API XSdata.set_absorption_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_absorption_mgxs() method?", "input": "OpenMC Python API XSdata.set_absorption_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_fission_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_fission_mgxs() method", "output": "The set_fission_mgxs() method this method allows for an openmc.mgxs.fissionxs to be used to set the fission cross section for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_fission_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_fission_mgxs() method signature", "output": "To call the set_fission_mgxs() method, use: def set_fission_mgxs(self: Any, fission: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the fission parameter do in the set_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_fission_mgxs() parameter fission", "output": "The fission parameter mgxs object containing the fission cross section for the domain of interest.. It should be a openmc.mgxs.FissionXS value." }, { "instruction": "What does the temperature parameter do in the set_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_fission_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_fission_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_fission_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_fission_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_nu_fission_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_nu_fission_mgxs() method", "output": "The set_nu_fission_mgxs() method this method allows for an openmc.mgxs.fissionxs to be used to set the nu-fission cross section for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_nu_fission_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_nu_fission_mgxs() method signature", "output": "To call the set_nu_fission_mgxs() method, use: def set_nu_fission_mgxs(self: Any, nu_fission: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the nu_fission parameter do in the set_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_nu_fission_mgxs() parameter nu_fission", "output": "The nu_fission parameter mgxs object containing the nu-fission cross section for the domain of interest.. It should be a openmc.mgxs.FissionXS value." }, { "instruction": "What does the temperature parameter do in the set_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_nu_fission_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_nu_fission_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_nu_fission_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_nu_fission_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_prompt_nu_fission_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission_mgxs() method", "output": "The set_prompt_nu_fission_mgxs() method sets the prompt-nu-fission cross section. this method allows for an openmc.mgxs.fissionxs or openmc.mgxs.nufissionmatrixxs to be used to set the prompt-nu-fission cross section for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_prompt_nu_fission_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission_mgxs() method signature", "output": "To call the set_prompt_nu_fission_mgxs() method, use: def set_prompt_nu_fission_mgxs(self: Any, prompt_nu_fission: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the prompt_nu_fission parameter do in the set_prompt_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission_mgxs() parameter prompt_nu_fission", "output": "The prompt_nu_fission parameter mgxs object containing the prompt-nu-fission cross section for the domain of interest.. It should be a openmc.mgxs.FissionXS or openmc.mgxs.NuFissionMatrixXS value." }, { "instruction": "What does the temperature parameter do in the set_prompt_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission_mgxs() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_prompt_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_prompt_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_prompt_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_prompt_nu_fission_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_delayed_nu_fission_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission_mgxs() method", "output": "The set_delayed_nu_fission_mgxs() method this method allows for an openmc.mgxs.delayednufissionxs or openmc.mgxs.delayednufissionmatrixxs to be used to set the delayed-nu-fission cross section for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_delayed_nu_fission_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission_mgxs() method signature", "output": "To call the set_delayed_nu_fission_mgxs() method, use: def set_delayed_nu_fission_mgxs(self: Any, delayed_nu_fission: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the delayed_nu_fission parameter do in the set_delayed_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission_mgxs() parameter delayed_nu_fission", "output": "The delayed_nu_fission parameter mgxs object containing the delayed-nu-fission cross section for the domain of interest.. It should be a openmc.mgxs.DelayedNuFissionXS or openmc.mgxs.DelayedNuFissionMatrixXS value." }, { "instruction": "What does the temperature parameter do in the set_delayed_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission_mgxs() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_delayed_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_delayed_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_delayed_nu_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_delayed_nu_fission_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_kappa_fission_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_kappa_fission_mgxs() method", "output": "The set_kappa_fission_mgxs() method this method allows for an openmc.mgxs.kappafissionxs to be used to set the kappa-fission cross section for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_kappa_fission_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_kappa_fission_mgxs() method signature", "output": "To call the set_kappa_fission_mgxs() method, use: def set_kappa_fission_mgxs(self: Any, k_fission: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the kappa_fission parameter do in the set_kappa_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_kappa_fission_mgxs() parameter kappa_fission", "output": "The kappa_fission parameter mgxs object containing the kappa-fission cross section for the domain of interest.. It should be a openmc.mgxs.KappaFissionXS value." }, { "instruction": "What does the temperature parameter do in the set_kappa_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_kappa_fission_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_kappa_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_kappa_fission_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_kappa_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_kappa_fission_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_kappa_fission_mgxs() method?", "input": "OpenMC Python API XSdata.set_kappa_fission_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_chi_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_mgxs() method", "output": "The set_chi_mgxs() method this method allows for an openmc.mgxs.chi to be used to set chi for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_chi_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_mgxs() method signature", "output": "To call the set_chi_mgxs() method, use: def set_chi_mgxs(self: Any, chi: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the chi parameter do in the set_chi_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_mgxs() parameter chi", "output": "The chi parameter mgxs object containing chi for the domain of interest.. It should be a openmc.mgxs.Chi value." }, { "instruction": "What does the temperature parameter do in the set_chi_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_chi_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_chi_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_chi_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_chi_prompt_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_prompt_mgxs() method", "output": "The set_chi_prompt_mgxs() method this method allows for an openmc.mgxs.chi to be used to set chi-prompt for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_chi_prompt_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_prompt_mgxs() method signature", "output": "To call the set_chi_prompt_mgxs() method, use: def set_chi_prompt_mgxs(self: Any, chi_prompt: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the chi_prompt parameter do in the set_chi_prompt_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_prompt_mgxs() parameter chi_prompt", "output": "The chi_prompt parameter mgxs object containing chi-prompt for the domain of interest.. It should be a openmc.mgxs.Chi value." }, { "instruction": "What does the temperature parameter do in the set_chi_prompt_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_prompt_mgxs() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_chi_prompt_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_prompt_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_chi_prompt_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_prompt_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_chi_prompt_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_prompt_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_chi_delayed_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_delayed_mgxs() method", "output": "The set_chi_delayed_mgxs() method this method allows for an openmc.mgxs.chidelayed to be used to set chi-delayed for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_chi_delayed_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_chi_delayed_mgxs() method signature", "output": "To call the set_chi_delayed_mgxs() method, use: def set_chi_delayed_mgxs(self: Any, chi_delayed: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the chi_delayed parameter do in the set_chi_delayed_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_delayed_mgxs() parameter chi_delayed", "output": "The chi_delayed parameter mgxs object containing chi-delayed for the domain of interest.. It should be a openmc.mgxs.ChiDelayed value." }, { "instruction": "What does the temperature parameter do in the set_chi_delayed_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_delayed_mgxs() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_chi_delayed_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_delayed_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_chi_delayed_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_delayed_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_chi_delayed_mgxs() method?", "input": "OpenMC Python API XSdata.set_chi_delayed_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_beta_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_beta_mgxs() method", "output": "The set_beta_mgxs() method this method allows for an openmc.mgxs.beta to be used to set beta for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_beta_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_beta_mgxs() method signature", "output": "To call the set_beta_mgxs() method, use: def set_beta_mgxs(self: Any, beta: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the beta parameter do in the set_beta_mgxs() method?", "input": "OpenMC Python API XSdata.set_beta_mgxs() parameter beta", "output": "The beta parameter mgxs object containing beta for the domain of interest.. It should be a openmc.mgxs.Beta value." }, { "instruction": "What does the temperature parameter do in the set_beta_mgxs() method?", "input": "OpenMC Python API XSdata.set_beta_mgxs() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_beta_mgxs() method?", "input": "OpenMC Python API XSdata.set_beta_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_beta_mgxs() method?", "input": "OpenMC Python API XSdata.set_beta_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_beta_mgxs() method?", "input": "OpenMC Python API XSdata.set_beta_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_decay_rate_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_decay_rate_mgxs() method", "output": "The set_decay_rate_mgxs() method this method allows for an openmc.mgxs.decayrate to be used to set decay rate for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_decay_rate_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_decay_rate_mgxs() method signature", "output": "To call the set_decay_rate_mgxs() method, use: def set_decay_rate_mgxs(self: Any, decay_rate: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the decay_rate parameter do in the set_decay_rate_mgxs() method?", "input": "OpenMC Python API XSdata.set_decay_rate_mgxs() parameter decay_rate", "output": "The decay_rate parameter mgxs object containing decay rate for the domain of interest.. It should be a openmc.mgxs.DecayRate value." }, { "instruction": "What does the temperature parameter do in the set_decay_rate_mgxs() method?", "input": "OpenMC Python API XSdata.set_decay_rate_mgxs() parameter temperature", "output": "The temperature parameter temperature (in units of kelvin) of the provided dataset. defaults to 294k. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_decay_rate_mgxs() method?", "input": "OpenMC Python API XSdata.set_decay_rate_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_decay_rate_mgxs() method?", "input": "OpenMC Python API XSdata.set_decay_rate_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_decay_rate_mgxs() method?", "input": "OpenMC Python API XSdata.set_decay_rate_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_scatter_matrix_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_scatter_matrix_mgxs() method", "output": "The set_scatter_matrix_mgxs() method this method allows for an openmc.mgxs.scattermatrixxs to be used to set the scatter matrix cross section for this xsdata object. if the xsdata.order attribute has not yet been set, then it will be set based on the properties of scatter. It's used for xsdata operations." }, { "instruction": "How do you call the set_scatter_matrix_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_scatter_matrix_mgxs() method signature", "output": "To call the set_scatter_matrix_mgxs() method, use: def set_scatter_matrix_mgxs(self: Any, scatter: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the scatter parameter do in the set_scatter_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_scatter_matrix_mgxs() parameter scatter", "output": "The scatter parameter mgxs object containing the scatter matrix cross section for the domain of interest.. It should be a openmc.mgxs.ScatterMatrixXS value." }, { "instruction": "What does the temperature parameter do in the set_scatter_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_scatter_matrix_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_scatter_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_scatter_matrix_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_scatter_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_scatter_matrix_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_scatter_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_scatter_matrix_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_multiplicity_matrix_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() method", "output": "The set_multiplicity_matrix_mgxs() method this method allows for either the direct use of only an openmc.mgxs.multiplicitymatrixxs or an openmc.mgxs.scattermatrixxs and openmc.mgxs.scattermatrixxs to be used to set the scattering multiplicity for this xsdata object. multiplicity, in openmc parlance, is a factor used to account for the production of neutrons introduced by scattering multiplication reactions, i.e., (n,xn) events. in this sense, the multiplication matrix is simply defined as the ratio of the nu-scatter and scatter matrices. It's used for xsdata operations." }, { "instruction": "How do you call the set_multiplicity_matrix_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() method signature", "output": "To call the set_multiplicity_matrix_mgxs() method, use: def set_multiplicity_matrix_mgxs(self: Any, nuscatter: Any, scatter: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 7 parameters." }, { "instruction": "What does the nuscatter parameter do in the set_multiplicity_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() parameter nuscatter", "output": "The nuscatter parameter mgxs object containing the matrix cross section for the domain of interest.. It should be a openmc.mgxs.ScatterMatrixXS or openmc.mgxs.MultiplicityMatrixXS value." }, { "instruction": "What does the scatter parameter do in the set_multiplicity_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() parameter scatter", "output": "The scatter parameter mgxs object containing the scattering matrix cross section for the domain of interest.. It should be a openmc.mgxs.ScatterMatrixXS value." }, { "instruction": "What does the temperature parameter do in the set_multiplicity_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_multiplicity_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_multiplicity_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_multiplicity_matrix_mgxs() method?", "input": "OpenMC Python API XSdata.set_multiplicity_matrix_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the set_inverse_velocity_mgxs() method do in the XSdata class?", "input": "OpenMC Python API XSdata.set_inverse_velocity_mgxs() method", "output": "The set_inverse_velocity_mgxs() method this method allows for an openmc.mgxs.inversevelocity to be used to set the inverse velocity for this xsdata object. It's used for xsdata operations." }, { "instruction": "How do you call the set_inverse_velocity_mgxs() method in the XSdata class?", "input": "OpenMC Python API XSdata.set_inverse_velocity_mgxs() method signature", "output": "To call the set_inverse_velocity_mgxs() method, use: def set_inverse_velocity_mgxs(self: Any, inverse_velocity: Any, temperature: Any, nuclide: Any, xs_type: Any, subdomain: Any). It takes 6 parameters." }, { "instruction": "What does the inverse_velocity parameter do in the set_inverse_velocity_mgxs() method?", "input": "OpenMC Python API XSdata.set_inverse_velocity_mgxs() parameter inverse_velocity", "output": "The inverse_velocity parameter mgxs object containing the inverse velocity for the domain of interest.. It should be a openmc.mgxs.InverseVelocity value." }, { "instruction": "What does the temperature parameter do in the set_inverse_velocity_mgxs() method?", "input": "OpenMC Python API XSdata.set_inverse_velocity_mgxs() parameter temperature", "output": "The temperature parameter temperature (in kelvin) of the data. defaults to room temperature (294k).. It should be a float value." }, { "instruction": "What does the nuclide parameter do in the set_inverse_velocity_mgxs() method?", "input": "OpenMC Python API XSdata.set_inverse_velocity_mgxs() parameter nuclide", "output": "The nuclide parameter individual nuclide (or 'total' if obtaining material-wise data) to gather data for. defaults to 'total'.. It should be a str value." }, { "instruction": "What does the xs_type parameter do in the set_inverse_velocity_mgxs() method?", "input": "OpenMC Python API XSdata.set_inverse_velocity_mgxs() parameter xs_type", "output": "The xs_type parameter provide the macro or micro cross section in units of cm^-1 or barns. defaults to 'macro'.. It should be a {'macro', 'micro'} value." }, { "instruction": "What does the subdomain parameter do in the set_inverse_velocity_mgxs() method?", "input": "OpenMC Python API XSdata.set_inverse_velocity_mgxs() parameter subdomain", "output": "The subdomain parameter if the mgxs contains a mesh domain type, the subdomain parameter specifies which mesh cell (i.e., [i, j, k] index) to use. see also -------- openmc.mgxs.library.create_mg_library() openmc.mgxs.library.get_xsdata(). It should be a iterable of int value." }, { "instruction": "What does the convert_representation() method do in the XSdata class?", "input": "OpenMC Python API XSdata.convert_representation() method", "output": "The convert_representation() method produce a new xsdata object with the same data, but converted to the new representation (isotropic or angle-dependent). this method cannot be used to change the number of polar or azimuthal bins of an xsdata object that already uses an angular representation. finally, this method simply uses an arithmetic mean to convert from an angular to isotropic representation; no flux-weighting is applied and therefore reaction rates will not be preserved. It's used for xsdata operations." }, { "instruction": "How do you call the convert_representation() method in the XSdata class?", "input": "OpenMC Python API XSdata.convert_representation() method signature", "output": "To call the convert_representation() method, use: def convert_representation(self: Any, target_representation: Any, num_polar: Any, num_azimuthal: Any). It takes 4 parameters." }, { "instruction": "What does the target_representation parameter do in the convert_representation() method?", "input": "OpenMC Python API XSdata.convert_representation() parameter target_representation", "output": "The target_representation parameter representation of the mgxs (isotropic or angle-dependent flux weighting).. It should be a {'isotropic', 'angle'} value." }, { "instruction": "What does the num_polar parameter do in the convert_representation() method?", "input": "OpenMC Python API XSdata.convert_representation() parameter num_polar", "output": "The num_polar parameter number of equal width angular bins that the polar angular domain is subdivided into. this is required when `target_representation` is \"angle\".. It should be a int, optional value." }, { "instruction": "What does the num_azimuthal parameter do in the convert_representation() method?", "input": "OpenMC Python API XSdata.convert_representation() parameter num_azimuthal", "output": "The num_azimuthal parameter number of equal width angular bins that the azimuthal angular domain is subdivided into. this is required when `target_representation` is \"angle\".. It should be a int, optional value." }, { "instruction": "What does the convert_scatter_format() method do in the XSdata class?", "input": "OpenMC Python API XSdata.convert_scatter_format() method", "output": "The convert_scatter_format() method produce a new mgxslibrary object with the same data, but converted to the new scatter format and order. It's used for xsdata operations." }, { "instruction": "How do you call the convert_scatter_format() method in the XSdata class?", "input": "OpenMC Python API XSdata.convert_scatter_format() method signature", "output": "To call the convert_scatter_format() method, use: def convert_scatter_format(self: Any, target_format: Any, target_order: Any). It takes 3 parameters." }, { "instruction": "What does the target_format parameter do in the convert_scatter_format() method?", "input": "OpenMC Python API XSdata.convert_scatter_format() parameter target_format", "output": "The target_format parameter representation of the scattering angle distribution. It should be a {'tabular', 'legendre', 'histogram'} value." }, { "instruction": "What does the target_order parameter do in the convert_scatter_format() method?", "input": "OpenMC Python API XSdata.convert_scatter_format() parameter target_order", "output": "The target_order parameter either the legendre target_order, number of bins, or number of points used to describe the angular distribution associated with each group-to-group transfer probability. It should be a int value." }, { "instruction": "What does the to_hdf5() method do in the XSdata class?", "input": "OpenMC Python API XSdata.to_hdf5() method", "output": "The to_hdf5() method write xsdata to an hdf5 file. It's used for xsdata operations." }, { "instruction": "How do you call the to_hdf5() method in the XSdata class?", "input": "OpenMC Python API XSdata.to_hdf5() method signature", "output": "To call the to_hdf5() method, use: def to_hdf5(self: Any, file: Any). It takes 2 parameters." }, { "instruction": "What does the file parameter do in the to_hdf5() method?", "input": "OpenMC Python API XSdata.to_hdf5() parameter file", "output": "The file parameter hdf5 file (a root group) to write to. It should be a h5py.File value." }, { "instruction": "What does the from_hdf5() method do in the XSdata class?", "input": "OpenMC Python API XSdata.from_hdf5() method", "output": "The from_hdf5() method generate xsdata object from an hdf5 group. It's used for xsdata operations." }, { "instruction": "How do you call the from_hdf5() method in the XSdata class?", "input": "OpenMC Python API XSdata.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any, name: Any, energy_groups: Any, num_delayed_groups: Any). It takes 5 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API XSdata.from_hdf5() parameter group", "output": "The group parameter hdf5 group to read from. It should be a h5py.Group value." }, { "instruction": "What does the name parameter do in the from_hdf5() method?", "input": "OpenMC Python API XSdata.from_hdf5() parameter name", "output": "The name parameter name of the mgxs data set.. It should be a str value." }, { "instruction": "What does the energy_groups parameter do in the from_hdf5() method?", "input": "OpenMC Python API XSdata.from_hdf5() parameter energy_groups", "output": "The energy_groups parameter energy group structure. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the num_delayed_groups parameter do in the from_hdf5() method?", "input": "OpenMC Python API XSdata.from_hdf5() parameter num_delayed_groups", "output": "The num_delayed_groups parameter number of delayed groups. It should be a int value." }, { "instruction": "What is the MGXSLibrary class in OpenMC's Python API?", "input": "OpenMC Python API MGXSLibrary class", "output": "The MGXSLibrary class represents multi-group cross sections file used for an openmc simulation. corresponds directly to the mg version of the cross_sections.xml input file. It provides 16 methods and 0 properties for working with mgxslibrary data in OpenMC." }, { "instruction": "What does the MGXSLibrary class do in OpenMC's Python API?", "input": "OpenMC Python API MGXSLibrary class description", "output": "The MGXSLibrary class multi-group cross sections file used for an openmc simulation. corresponds directly to the mg version of the cross_sections.xml input file. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the energy_groups parameter do when creating a MGXSLibrary?", "input": "OpenMC Python API MGXSLibrary constructor parameter energy_groups", "output": "When creating a MGXSLibrary, the energy_groups parameter specifies energy group structure. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the num_delayed_groups parameter do when creating a MGXSLibrary?", "input": "OpenMC Python API MGXSLibrary constructor parameter num_delayed_groups", "output": "When creating a MGXSLibrary, the num_delayed_groups parameter specifies num delayed groups. It should be a int value." }, { "instruction": "What is the energy_groups attribute of a MGXSLibrary?", "input": "OpenMC Python API MGXSLibrary attribute energy_groups", "output": "The energy_groups attribute of a MGXSLibrary contains energy group structure.. It's a openmc.mgxs.EnergyGroups value that you can access after creating a MGXSLibrary instance." }, { "instruction": "What is the num_delayed_groups attribute of a MGXSLibrary?", "input": "OpenMC Python API MGXSLibrary attribute num_delayed_groups", "output": "The num_delayed_groups attribute of a MGXSLibrary contains num delayed groups. It's a int value that you can access after creating a MGXSLibrary instance." }, { "instruction": "What is the xsdatas attribute of a MGXSLibrary?", "input": "OpenMC Python API MGXSLibrary attribute xsdatas", "output": "The xsdatas attribute of a MGXSLibrary contains iterable of multi-group cross section data objects. It's a Iterable of openmc.XSdata value that you can access after creating a MGXSLibrary instance." }, { "instruction": "How do you call the __init__() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, energy_groups: Any, num_delayed_groups: Any). It takes 3 parameters." }, { "instruction": "How do you call the __deepcopy__() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.__deepcopy__() method signature", "output": "To call the __deepcopy__() method, use: def __deepcopy__(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy_groups() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.energy_groups() method signature", "output": "To call the energy_groups() method, use: @property def energy_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_groups() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.energy_groups() method signature", "output": "To call the energy_groups() method, use: @energy_groups.setter def energy_groups(self: Any, energy_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_delayed_groups() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.num_delayed_groups() method signature", "output": "To call the num_delayed_groups() method, use: @property def num_delayed_groups(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_delayed_groups() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.num_delayed_groups() method signature", "output": "To call the num_delayed_groups() method, use: @num_delayed_groups.setter def num_delayed_groups(self: Any, num_delayed_groups: Any). It takes 2 parameters." }, { "instruction": "How do you call the xsdatas() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.xsdatas() method signature", "output": "To call the xsdatas() method, use: @property def xsdatas(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the names() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.names() method signature", "output": "To call the names() method, use: @property def names(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_xsdata() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.add_xsdata() method", "output": "The add_xsdata() method add an xsdata entry to the file. It's used for mgxslibrary operations." }, { "instruction": "How do you call the add_xsdata() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.add_xsdata() method signature", "output": "To call the add_xsdata() method, use: def add_xsdata(self: Any, xsdata: Any). It takes 2 parameters." }, { "instruction": "What does the xsdata parameter do in the add_xsdata() method?", "input": "OpenMC Python API MGXSLibrary.add_xsdata() parameter xsdata", "output": "The xsdata parameter mgxs information to add. It should be a openmc.XSdata value." }, { "instruction": "What does the add_xsdatas() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.add_xsdatas() method", "output": "The add_xsdatas() method add multiple xsdatas to the file. It's used for mgxslibrary operations." }, { "instruction": "How do you call the add_xsdatas() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.add_xsdatas() method signature", "output": "To call the add_xsdatas() method, use: def add_xsdatas(self: Any, xsdatas: Any). It takes 2 parameters." }, { "instruction": "What does the xsdatas parameter do in the add_xsdatas() method?", "input": "OpenMC Python API MGXSLibrary.add_xsdatas() parameter xsdatas", "output": "The xsdatas parameter xsdatas to add. It should be a tuple or list of openmc.XSdata value." }, { "instruction": "What does the remove_xsdata() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.remove_xsdata() method", "output": "The remove_xsdata() method remove a xsdata from the file. It's used for mgxslibrary operations." }, { "instruction": "How do you call the remove_xsdata() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.remove_xsdata() method signature", "output": "To call the remove_xsdata() method, use: def remove_xsdata(self: Any, xsdata: Any). It takes 2 parameters." }, { "instruction": "What does the xsdata parameter do in the remove_xsdata() method?", "input": "OpenMC Python API MGXSLibrary.remove_xsdata() parameter xsdata", "output": "The xsdata parameter xsdata to remove. It should be a openmc.XSdata value." }, { "instruction": "What does the get_by_name() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.get_by_name() method", "output": "The get_by_name() method access the xsdata objects by name. It's used for mgxslibrary operations." }, { "instruction": "How do you call the get_by_name() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.get_by_name() method signature", "output": "To call the get_by_name() method, use: def get_by_name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "What does the name parameter do in the get_by_name() method?", "input": "OpenMC Python API MGXSLibrary.get_by_name() parameter name", "output": "The name parameter name of openmc.xsdata object to obtain. It should be a str value." }, { "instruction": "What does the get_by_name() method return in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.get_by_name() return value", "output": "The get_by_name() method returns provides the matching xsdata object or none, if not found. The return type is openmc.XSdata or None." }, { "instruction": "What does the convert_representation() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.convert_representation() method", "output": "The convert_representation() method produce a new xsdata object with the same data, but converted to the new representation (isotropic or angle-dependent). this method cannot be used to change the number of polar or azimuthal bins of an xsdata object that already uses an angular representation. finally, this method simply uses an arithmetic mean to convert from an angular to isotropic representation; no flux-weighting is applied and therefore the reaction rates will not be preserved. It's used for mgxslibrary operations." }, { "instruction": "How do you call the convert_representation() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.convert_representation() method signature", "output": "To call the convert_representation() method, use: def convert_representation(self: Any, target_representation: Any, num_polar: Any, num_azimuthal: Any). It takes 4 parameters." }, { "instruction": "What does the target_representation parameter do in the convert_representation() method?", "input": "OpenMC Python API MGXSLibrary.convert_representation() parameter target_representation", "output": "The target_representation parameter representation of the mgxs (isotropic or angle-dependent flux weighting).. It should be a {'isotropic', 'angle'} value." }, { "instruction": "What does the num_polar parameter do in the convert_representation() method?", "input": "OpenMC Python API MGXSLibrary.convert_representation() parameter num_polar", "output": "The num_polar parameter number of equal width angular bins that the polar angular domain is subdivided into. this is required when `target_representation` is \"angle\".. It should be a int, optional value." }, { "instruction": "What does the num_azimuthal parameter do in the convert_representation() method?", "input": "OpenMC Python API MGXSLibrary.convert_representation() parameter num_azimuthal", "output": "The num_azimuthal parameter number of equal width angular bins that the azimuthal angular domain is subdivided into. this is required when `target_representation` is \"angle\".. It should be a int, optional value." }, { "instruction": "What does the convert_scatter_format() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.convert_scatter_format() method", "output": "The convert_scatter_format() method produce a new mgxslibrary object with the same data, but converted to the new scatter format and order. It's used for mgxslibrary operations." }, { "instruction": "How do you call the convert_scatter_format() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.convert_scatter_format() method signature", "output": "To call the convert_scatter_format() method, use: def convert_scatter_format(self: Any, target_format: Any, target_order: Any). It takes 3 parameters." }, { "instruction": "What does the target_format parameter do in the convert_scatter_format() method?", "input": "OpenMC Python API MGXSLibrary.convert_scatter_format() parameter target_format", "output": "The target_format parameter representation of the scattering angle distribution. It should be a {'tabular', 'legendre', 'histogram'} value." }, { "instruction": "What does the target_order parameter do in the convert_scatter_format() method?", "input": "OpenMC Python API MGXSLibrary.convert_scatter_format() parameter target_order", "output": "The target_order parameter either the legendre target_order, number of bins, or number of points used to describe the angular distribution associated with each group-to-group transfer probability. It should be a int value." }, { "instruction": "What does the export_to_hdf5() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.export_to_hdf5() method", "output": "The export_to_hdf5() method create an hdf5 file that can be used for a simulation. It's used for mgxslibrary operations." }, { "instruction": "How do you call the export_to_hdf5() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.export_to_hdf5() method signature", "output": "To call the export_to_hdf5() method, use: def export_to_hdf5(self: Any, filename: Any, libver: Any). It takes 3 parameters." }, { "instruction": "What does the filename parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API MGXSLibrary.export_to_hdf5() parameter filename", "output": "The filename parameter filename of file, default is mgxs.h5.. It should be a str value." }, { "instruction": "What does the libver parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API MGXSLibrary.export_to_hdf5() parameter libver", "output": "The libver parameter compatibility mode for the hdf5 file. 'latest' will produce files that are less backwards compatible but have performance benefits.. It should be a {'earliest', 'latest'} value." }, { "instruction": "What does the from_hdf5() method do in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.from_hdf5() method", "output": "The from_hdf5() method generate an mgxs library from an hdf5 group or file. It's used for mgxslibrary operations." }, { "instruction": "How do you call the from_hdf5() method in the MGXSLibrary class?", "input": "OpenMC Python API MGXSLibrary.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the from_hdf5() method?", "input": "OpenMC Python API MGXSLibrary.from_hdf5() parameter filename", "output": "The filename parameter name of hdf5 file containing mgxs data. default is none. if not provided, openmc.config['mg_cross_sections'] will be used.. It should be a str, optional value." }, { "instruction": "What is the EqualityMixin class in OpenMC's Python API?", "input": "OpenMC Python API EqualityMixin class", "output": "The EqualityMixin class represents a class which provides a generic __eq__ method that can be inherited\n by downstream classes.. It provides 1 methods and 0 properties for working with equalitymixin data in OpenMC." }, { "instruction": "What does the EqualityMixin class do in OpenMC's Python API?", "input": "OpenMC Python API EqualityMixin class description", "output": "The EqualityMixin class a class which provides a generic __eq__ method that can be inherited\n by downstream classes.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __eq__() method in the EqualityMixin class?", "input": "OpenMC Python API EqualityMixin.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What is the IDManagerMixin class in OpenMC's Python API?", "input": "OpenMC Python API IDManagerMixin class", "output": "The IDManagerMixin class represents a class which automatically manages unique ids.\n\n this mixin gives any subclass the ability to assign unique ids through an\n 'id' property and keeps track of which ones have already been\n assigned. crucially, each subclass must define class variables 'next_id' and\n 'used_ids' as they are used in the 'id' property that is supplied here.. It provides 3 methods and 0 properties for working with idmanagermixin data in OpenMC." }, { "instruction": "What does the IDManagerMixin class do in OpenMC's Python API?", "input": "OpenMC Python API IDManagerMixin class description", "output": "The IDManagerMixin class a class which automatically manages unique ids.\n\n this mixin gives any subclass the ability to assign unique ids through an\n 'id' property and keeps track of which ones have already been\n assigned. crucially, each subclass must define class variables 'next_id' and\n 'used_ids' as they are used in the 'id' property that is supplied here.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the id() method in the IDManagerMixin class?", "input": "OpenMC Python API IDManagerMixin.id() method signature", "output": "To call the id() method, use: @property def id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the id() method in the IDManagerMixin class?", "input": "OpenMC Python API IDManagerMixin.id() method signature", "output": "To call the id() method, use: @id.setter def id(self: Any, uid: Any). It takes 2 parameters." }, { "instruction": "What does the reset_ids() method do in the IDManagerMixin class?", "input": "OpenMC Python API IDManagerMixin.reset_ids() method", "output": "The reset_ids() method reset counters. It's used for idmanagermixin operations." }, { "instruction": "How do you call the reset_ids() method in the IDManagerMixin class?", "input": "OpenMC Python API IDManagerMixin.reset_ids() method signature", "output": "To call the reset_ids() method, use: @classmethod def reset_ids(cls: Any). It takes 1 parameters." }, { "instruction": "What does the reset_auto_ids() function do in OpenMC's Python API?", "input": "OpenMC Python API reset_auto_ids() function", "output": "The reset_auto_ids() function reset counters for all auto-generated ids. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the reset_auto_ids() function in OpenMC's Python API?", "input": "OpenMC Python API reset_auto_ids() function purpose", "output": "The reset_auto_ids() function reset counters for all auto-generated ids. It's part of OpenMC's Python API." }, { "instruction": "How do you call the reset_auto_ids() function in OpenMC's Python API?", "input": "OpenMC Python API reset_auto_ids() function signature", "output": "To call the reset_auto_ids() function, use: def reset_auto_ids(). It takes 0 parameters." }, { "instruction": "What does the reserve_ids() function do in OpenMC's Python API?", "input": "OpenMC Python API reserve_ids() function", "output": "The reserve_ids() function reserve a set of ids that won't be used for auto-generated ids. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the reserve_ids() function in OpenMC's Python API?", "input": "OpenMC Python API reserve_ids() function purpose", "output": "The reserve_ids() function reserve a set of ids that won't be used for auto-generated ids. It's part of OpenMC's Python API." }, { "instruction": "How do you call the reserve_ids() function in OpenMC's Python API?", "input": "OpenMC Python API reserve_ids() function signature", "output": "To call the reserve_ids() function, use: def reserve_ids(ids: Any, cls: Any). It takes 2 parameters." }, { "instruction": "What does the ids parameter do in the reserve_ids() function?", "input": "OpenMC Python API reserve_ids() parameter ids", "output": "The ids parameter ids to reserve. It should be a iterable of int value." }, { "instruction": "What does the cls parameter do in the reserve_ids() function?", "input": "OpenMC Python API reserve_ids() parameter cls", "output": "The cls parameter class for which ids should be reserved (e.g., :class:`openmc.cell`). if none, all classes that have auto-generated ids will be used.. It should be a type or None value." }, { "instruction": "What does the set_auto_id() function do in OpenMC's Python API?", "input": "OpenMC Python API set_auto_id() function", "output": "The set_auto_id() function set the next id for auto-generated ids. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the set_auto_id() function in OpenMC's Python API?", "input": "OpenMC Python API set_auto_id() function purpose", "output": "The set_auto_id() function set the next id for auto-generated ids. It's part of OpenMC's Python API." }, { "instruction": "How do you call the set_auto_id() function in OpenMC's Python API?", "input": "OpenMC Python API set_auto_id() function signature", "output": "To call the set_auto_id() function, use: def set_auto_id(next_id: Any). It takes 1 parameters." }, { "instruction": "What does the next_id parameter do in the set_auto_id() function?", "input": "OpenMC Python API set_auto_id() parameter next_id", "output": "The next_id parameter the next id to assign to objects with auto-generated ids.. It should be a int value." }, { "instruction": "What does the borated_water() function do in OpenMC's Python API?", "input": "OpenMC Python API borated_water() function", "output": "The borated_water() function return a material with the composition of boron dissolved in water. the water density can be determined from a temperature and pressure, or it can be set directly. the concentration of boron has no effect on the stoichiometric ratio of h and o---they are fixed at 2-1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the borated_water() function in OpenMC's Python API?", "input": "OpenMC Python API borated_water() function purpose", "output": "The borated_water() function return a material with the composition of boron dissolved in water. the water density can be determined from a temperature and pressure, or it can be set directly. the concentration of boron has no effect on the stoichiometric ratio of h and o---they are fixed at 2-1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the borated_water() function in OpenMC's Python API?", "input": "OpenMC Python API borated_water() function signature", "output": "To call the borated_water() function, use: def borated_water(boron_ppm: Any, temperature: Any, pressure: Any, temp_unit: Any, press_unit: Any, density: Any). It takes 6 parameters." }, { "instruction": "What does the boron_ppm parameter do in the borated_water() function?", "input": "OpenMC Python API borated_water() parameter boron_ppm", "output": "The boron_ppm parameter the weight fraction in parts-per-million of elemental boron in the water.. It should be a float value." }, { "instruction": "What does the temperature parameter do in the borated_water() function?", "input": "OpenMC Python API borated_water() parameter temperature", "output": "The temperature parameter temperature in [k] used to compute water density.. It should be a float value." }, { "instruction": "What does the pressure parameter do in the borated_water() function?", "input": "OpenMC Python API borated_water() parameter pressure", "output": "The pressure parameter pressure in [mpa] used to compute water density.. It should be a float value." }, { "instruction": "What does the temp_unit parameter do in the borated_water() function?", "input": "OpenMC Python API borated_water() parameter temp_unit", "output": "The temp_unit parameter the units used for the `temperature` argument.. It should be a {'K', 'C', 'F'} value." }, { "instruction": "What does the press_unit parameter do in the borated_water() function?", "input": "OpenMC Python API borated_water() parameter press_unit", "output": "The press_unit parameter the units used for the `pressure` argument.. It should be a {'MPa', 'psi'} value." }, { "instruction": "What does the density parameter do in the borated_water() function?", "input": "OpenMC Python API borated_water() parameter density", "output": "The density parameter water density in [g / cm^3]. if specified, this value overrides the temperature and pressure arguments. **kwargs all keyword arguments are passed to the created material object.. It should be a float value." }, { "instruction": "How do you call the rectangular_prism() function in OpenMC's Python API?", "input": "OpenMC Python API rectangular_prism() function signature", "output": "To call the rectangular_prism() function, use: def rectangular_prism(width: Any, height: Any, axis: Any, origin: Any, boundary_type: Any, corner_radius: Any). It takes 6 parameters." }, { "instruction": "How do you call the hexagonal_prism() function in OpenMC's Python API?", "input": "OpenMC Python API hexagonal_prism() function signature", "output": "To call the hexagonal_prism() function, use: def hexagonal_prism(edge_length: Any, orientation: Any, origin: Any, boundary_type: Any, corner_radius: Any). It takes 5 parameters." }, { "instruction": "How do you call the get_hexagonal_prism() function in OpenMC's Python API?", "input": "OpenMC Python API get_hexagonal_prism() function signature", "output": "To call the get_hexagonal_prism() function, use: def get_hexagonal_prism(). It takes 0 parameters." }, { "instruction": "What does the subdivide() function do in OpenMC's Python API?", "input": "OpenMC Python API subdivide() function", "output": "The subdivide() function create regions separated by a series of surfaces. this function allows regions to be constructed from a set of a surfaces that are \"in order\". for example, if you had four instances of :class:`openmc.zplane` at z=-10, z=-5, z=5, and z=10, this function would return a list of regions corresponding to z < -10, -10 < z < -5, -5 < z < 5, 5 < z < 10, and 10 < z. that is, for n surfaces, n+1 regions are returned. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the subdivide() function in OpenMC's Python API?", "input": "OpenMC Python API subdivide() function purpose", "output": "The subdivide() function create regions separated by a series of surfaces. this function allows regions to be constructed from a set of a surfaces that are \"in order\". for example, if you had four instances of :class:`openmc.zplane` at z=-10, z=-5, z=5, and z=10, this function would return a list of regions corresponding to z < -10, -10 < z < -5, -5 < z < 5, 5 < z < 10, and 10 < z. that is, for n surfaces, n+1 regions are returned. It's part of OpenMC's Python API." }, { "instruction": "How do you call the subdivide() function in OpenMC's Python API?", "input": "OpenMC Python API subdivide() function signature", "output": "To call the subdivide() function, use: def subdivide(surfaces: Any). It takes 1 parameters." }, { "instruction": "What does the surfaces parameter do in the subdivide() function?", "input": "OpenMC Python API subdivide() parameter surfaces", "output": "The surfaces parameter surfaces separating regions. It should be a sequence of openmc.Surface value." }, { "instruction": "What does the pin() function do in OpenMC's Python API?", "input": "OpenMC Python API pin() function", "output": "The pin() function convenience function for building a fuel pin. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the pin() function in OpenMC's Python API?", "input": "OpenMC Python API pin() function purpose", "output": "The pin() function convenience function for building a fuel pin. It's part of OpenMC's Python API." }, { "instruction": "How do you call the pin() function in OpenMC's Python API?", "input": "OpenMC Python API pin() function signature", "output": "To call the pin() function, use: def pin(surfaces: Any, items: Any, subdivisions: Any, divide_vols: Any). It takes 4 parameters." }, { "instruction": "What does the surfaces parameter do in the pin() function?", "input": "OpenMC Python API pin() parameter surfaces", "output": "The surfaces parameter cylinders used to define boundaries between items. all cylinders must be concentric and of the same orientation, e.g.. It should be a iterable of :class:`openmc.Cylinder` value." }, { "instruction": "What does the all parameter do in the pin() function?", "input": "OpenMC Python API pin() parameter all", "output": "The all parameter . It should be a class:`openmc.ZCylinder` value." }, { "instruction": "What does the items parameter do in the pin() function?", "input": "OpenMC Python API pin() parameter items", "output": "The items parameter objects to go between ``surfaces``. these can be anything that can fill a :class:`openmc.cell`, including :class:`openmc.material`, or other :class:`openmc.universe` objects. there must be one more item than surfaces, which will span all space outside the final ring.. It should be a iterable value." }, { "instruction": "What does the subdivisions parameter do in the pin() function?", "input": "OpenMC Python API pin() parameter subdivisions", "output": "The subdivisions parameter dictionary describing which rings to subdivide and how many times. keys are indexes of the annular rings to be divided. will construct equal area rings. It should be a None or dict of int to int value." }, { "instruction": "What does the divide_vols parameter do in the pin() function?", "input": "OpenMC Python API pin() parameter divide_vols", "output": "The divide_vols parameter if this evaluates to ``true``, then volumes of subdivided :class:`openmc.material` instances will also be divided by the number of divisions. otherwise the volume of the original material will not be modified before subdivision kwargs: additional key-word arguments to be passed to :class:`openmc.universe`, like ``name=\"fuel pin\"``. It should be a bool value." }, { "instruction": "What is the Model class in OpenMC's Python API?", "input": "OpenMC Python API Model class", "output": "The Model class represents model container. this class can be used to store instances of :class:`openmc.geometry`, :class:`openmc.materials`, :class:`openmc.settings`, :class:`openmc.tallies`, and :class:`openmc.plots`, thus making a complete model. the :meth:`model.export_to_xml` method will export xml files for all attributes that have been set. if the :attr:`model.materials` attribute is not set, it will attempt to create a ``materials.xml`` file based on all materials appearing in the geometry. .. versionchanged:: 0.13.0 the model information can now be loaded in to openmc directly via openmc.lib. It provides 46 methods and 0 properties for working with model data in OpenMC." }, { "instruction": "What does the Model class do in OpenMC's Python API?", "input": "OpenMC Python API Model class description", "output": "The Model class model container. this class can be used to store instances of :class:`openmc.geometry`, :class:`openmc.materials`, :class:`openmc.settings`, :class:`openmc.tallies`, and :class:`openmc.plots`, thus making a complete model. the :meth:`model.export_to_xml` method will export xml files for all attributes that have been set. if the :attr:`model.materials` attribute is not set, it will attempt to create a ``materials.xml`` file based on all materials appearing in the geometry. .. versionchanged:: 0.13.0 the model information can now be loaded in to openmc directly via openmc.lib. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the geometry parameter do when creating a Model?", "input": "OpenMC Python API Model constructor parameter geometry", "output": "When creating a Model, the geometry parameter specifies geometry information. It should be a openmc.Geometry, optional value." }, { "instruction": "What does the materials parameter do when creating a Model?", "input": "OpenMC Python API Model constructor parameter materials", "output": "When creating a Model, the materials parameter specifies materials information. It should be a openmc.Materials, optional value." }, { "instruction": "What does the settings parameter do when creating a Model?", "input": "OpenMC Python API Model constructor parameter settings", "output": "When creating a Model, the settings parameter specifies settings information. It should be a openmc.Settings, optional value." }, { "instruction": "What does the tallies parameter do when creating a Model?", "input": "OpenMC Python API Model constructor parameter tallies", "output": "When creating a Model, the tallies parameter specifies tallies information. It should be a openmc.Tallies, optional value." }, { "instruction": "What does the plots parameter do when creating a Model?", "input": "OpenMC Python API Model constructor parameter plots", "output": "When creating a Model, the plots parameter specifies plot information. It should be a openmc.Plots, optional value." }, { "instruction": "What is the geometry attribute of a Model?", "input": "OpenMC Python API Model attribute geometry", "output": "The geometry attribute of a Model contains geometry information. It's a openmc.Geometry value that you can access after creating a Model instance." }, { "instruction": "What is the materials attribute of a Model?", "input": "OpenMC Python API Model attribute materials", "output": "The materials attribute of a Model contains materials information. It's a openmc.Materials value that you can access after creating a Model instance." }, { "instruction": "What is the settings attribute of a Model?", "input": "OpenMC Python API Model attribute settings", "output": "The settings attribute of a Model contains settings information. It's a openmc.Settings value that you can access after creating a Model instance." }, { "instruction": "What is the tallies attribute of a Model?", "input": "OpenMC Python API Model attribute tallies", "output": "The tallies attribute of a Model contains tallies information. It's a openmc.Tallies value that you can access after creating a Model instance." }, { "instruction": "What is the plots attribute of a Model?", "input": "OpenMC Python API Model attribute plots", "output": "The plots attribute of a Model contains plot information. It's a openmc.Plots value that you can access after creating a Model instance." }, { "instruction": "How do you call the __init__() method in the Model class?", "input": "OpenMC Python API Model.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, geometry: Any, materials: Any, settings: Any, tallies: Any, plots: Any). It takes 6 parameters." }, { "instruction": "How do you call the geometry() method in the Model class?", "input": "OpenMC Python API Model.geometry() method signature", "output": "To call the geometry() method, use: @property def geometry(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the geometry() method in the Model class?", "input": "OpenMC Python API Model.geometry() method signature", "output": "To call the geometry() method, use: @geometry.setter def geometry(self: Any, geometry: Any). It takes 2 parameters." }, { "instruction": "How do you call the materials() method in the Model class?", "input": "OpenMC Python API Model.materials() method signature", "output": "To call the materials() method, use: @property def materials(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the materials() method in the Model class?", "input": "OpenMC Python API Model.materials() method signature", "output": "To call the materials() method, use: @materials.setter def materials(self: Any, materials: Any). It takes 2 parameters." }, { "instruction": "How do you call the settings() method in the Model class?", "input": "OpenMC Python API Model.settings() method signature", "output": "To call the settings() method, use: @property def settings(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the settings() method in the Model class?", "input": "OpenMC Python API Model.settings() method signature", "output": "To call the settings() method, use: @settings.setter def settings(self: Any, settings: Any). It takes 2 parameters." }, { "instruction": "How do you call the tallies() method in the Model class?", "input": "OpenMC Python API Model.tallies() method signature", "output": "To call the tallies() method, use: @property def tallies(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tallies() method in the Model class?", "input": "OpenMC Python API Model.tallies() method signature", "output": "To call the tallies() method, use: @tallies.setter def tallies(self: Any, tallies: Any). It takes 2 parameters." }, { "instruction": "How do you call the plots() method in the Model class?", "input": "OpenMC Python API Model.plots() method signature", "output": "To call the plots() method, use: @property def plots(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the plots() method in the Model class?", "input": "OpenMC Python API Model.plots() method signature", "output": "To call the plots() method, use: @plots.setter def plots(self: Any, plots: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the Model class?", "input": "OpenMC Python API Model.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the is_initialized() method in the Model class?", "input": "OpenMC Python API Model.is_initialized() method signature", "output": "To call the is_initialized() method, use: @property def is_initialized(self: Any). It takes 1 parameters." }, { "instruction": "What does the _materials_by_id() method do in the Model class?", "input": "OpenMC Python API Model._materials_by_id() method", "output": "The _materials_by_id() method dictionary mapping material id --> material. It's used for model operations." }, { "instruction": "How do you call the _materials_by_id() method in the Model class?", "input": "OpenMC Python API Model._materials_by_id() method signature", "output": "To call the _materials_by_id() method, use: @property def _materials_by_id(self: Any). It takes 1 parameters." }, { "instruction": "What does the _cells_by_id() method do in the Model class?", "input": "OpenMC Python API Model._cells_by_id() method", "output": "The _cells_by_id() method dictionary mapping cell id --> cell. It's used for model operations." }, { "instruction": "How do you call the _cells_by_id() method in the Model class?", "input": "OpenMC Python API Model._cells_by_id() method signature", "output": "To call the _cells_by_id() method, use: @property def _cells_by_id(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _cells_by_name() method in the Model class?", "input": "OpenMC Python API Model._cells_by_name() method signature", "output": "To call the _cells_by_name() method, use: @property def _cells_by_name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _materials_by_name() method in the Model class?", "input": "OpenMC Python API Model._materials_by_name() method signature", "output": "To call the _materials_by_name() method, use: @property def _materials_by_name(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_xml() method do in the Model class?", "input": "OpenMC Python API Model.from_xml() method", "output": "The from_xml() method create model from existing xml files. It's used for model operations." }, { "instruction": "How do you call the from_xml() method in the Model class?", "input": "OpenMC Python API Model.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, geometry: Any, materials: Any, settings: Any, tallies: Any, plots: Any). It takes 6 parameters." }, { "instruction": "What does the geometry parameter do in the from_xml() method?", "input": "OpenMC Python API Model.from_xml() parameter geometry", "output": "The geometry parameter path to geometry.xml file. It should be a str value." }, { "instruction": "What does the materials parameter do in the from_xml() method?", "input": "OpenMC Python API Model.from_xml() parameter materials", "output": "The materials parameter path to materials.xml file. It should be a str value." }, { "instruction": "What does the settings parameter do in the from_xml() method?", "input": "OpenMC Python API Model.from_xml() parameter settings", "output": "The settings parameter path to settings.xml file. It should be a str value." }, { "instruction": "What does the tallies parameter do in the from_xml() method?", "input": "OpenMC Python API Model.from_xml() parameter tallies", "output": "The tallies parameter path to tallies.xml file .. versionadded:: 0.13.0. It should be a str value." }, { "instruction": "What does the plots parameter do in the from_xml() method?", "input": "OpenMC Python API Model.from_xml() parameter plots", "output": "The plots parameter path to plots.xml file .. versionadded:: 0.13.0. It should be a str value." }, { "instruction": "What does the from_model_xml() method do in the Model class?", "input": "OpenMC Python API Model.from_model_xml() method", "output": "The from_model_xml() method create model from single xml file .. versionadded:: 0.13.3. It's used for model operations." }, { "instruction": "How do you call the from_model_xml() method in the Model class?", "input": "OpenMC Python API Model.from_model_xml() method signature", "output": "To call the from_model_xml() method, use: @classmethod def from_model_xml(cls: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the from_model_xml() method?", "input": "OpenMC Python API Model.from_model_xml() parameter path", "output": "The path parameter path to model.xml file. It should be a str or PathLike value." }, { "instruction": "What does the init_lib() method do in the Model class?", "input": "OpenMC Python API Model.init_lib() method", "output": "The init_lib() method initializes the model in memory via the c api .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the init_lib() method in the Model class?", "input": "OpenMC Python API Model.init_lib() method signature", "output": "To call the init_lib() method, use: def init_lib(self: Any, threads: Any, geometry_debug: Any, restart_file: Any, tracks: Any, output: Any, event_based: Any, intracomm: Any, directory: Any). It takes 9 parameters." }, { "instruction": "What does the threads parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter threads", "output": "The threads parameter number of openmp threads. if openmc is compiled with openmp threading enabled, the default is implementation-dependent but is usually equal to the number of hardware threads available (or a value set by the :envvar:`omp_num_threads` environment variable).. It should be a int, optional value." }, { "instruction": "What does the geometry_debug parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter geometry_debug", "output": "The geometry_debug parameter turn on geometry debugging during simulation. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the restart_file parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter restart_file", "output": "The restart_file parameter path to restart file to use. It should be a str, optional value." }, { "instruction": "What does the tracks parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter tracks", "output": "The tracks parameter enables the writing of particles tracks. the number of particle tracks written to tracks.h5 is limited to 1000 unless settings.max_tracks is set. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the output parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool value." }, { "instruction": "What does the event_based parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter event_based", "output": "The event_based parameter turns on event-based parallelism if true. if none, the value in the settings will be used.. It should be a None or bool, optional value." }, { "instruction": "What does the intracomm parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter intracomm", "output": "The intracomm parameter mpi intracommunicator. It should be a mpi4py.MPI.Intracomm or None, optional value." }, { "instruction": "What does the directory parameter do in the init_lib() method?", "input": "OpenMC Python API Model.init_lib() parameter directory", "output": "The directory parameter directory to write xml files to. defaults to none.. It should be a str or None, optional value." }, { "instruction": "What does the sync_dagmc_universes() method do in the Model class?", "input": "OpenMC Python API Model.sync_dagmc_universes() method", "output": "The sync_dagmc_universes() method synchronize all dagmc universes in the current geometry.\n\n this method iterates over all dagmc universes in the geometry and\n synchronizes their cells with the current material assignments. requires\n that the model has been initialized via :meth:`model.init_lib`.\n\n .. versionadded:: 0.15.1. It's used for model operations." }, { "instruction": "How do you call the sync_dagmc_universes() method in the Model class?", "input": "OpenMC Python API Model.sync_dagmc_universes() method signature", "output": "To call the sync_dagmc_universes() method, use: def sync_dagmc_universes(self: Any). It takes 1 parameters." }, { "instruction": "What does the finalize_lib() method do in the Model class?", "input": "OpenMC Python API Model.finalize_lib() method", "output": "The finalize_lib() method finalize simulation and free memory allocated for the c api\n\n .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the finalize_lib() method in the Model class?", "input": "OpenMC Python API Model.finalize_lib() method signature", "output": "To call the finalize_lib() method, use: def finalize_lib(self: Any). It takes 1 parameters." }, { "instruction": "What does the deplete() method do in the Model class?", "input": "OpenMC Python API Model.deplete() method", "output": "The deplete() method deplete model using specified timesteps/power .. versionchanged:: 0.13.0 the *final_step*, *operator_kwargs*, *directory*, and *output* arguments were added. It's used for model operations." }, { "instruction": "How do you call the deplete() method in the Model class?", "input": "OpenMC Python API Model.deplete() method signature", "output": "To call the deplete() method, use: def deplete(self: Any, timesteps: Any, method: Any, final_step: Any, operator_kwargs: Any, directory: Any, output: Any). It takes 7 parameters." }, { "instruction": "What does the timesteps parameter do in the deplete() method?", "input": "OpenMC Python API Model.deplete() parameter timesteps", "output": "The timesteps parameter array of timesteps in units of [s]. note that values are not cumulative.. It should be a iterable of float value." }, { "instruction": "What does the method parameter do in the deplete() method?", "input": "OpenMC Python API Model.deplete() parameter method", "output": "The method parameter integration method used for depletion (e.g., 'cecm', 'predictor'). defaults to 'cecm'.. It should be a str, optional value." }, { "instruction": "What does the final_step parameter do in the deplete() method?", "input": "OpenMC Python API Model.deplete() parameter final_step", "output": "The final_step parameter indicate whether or not a transport solve should be run at the end of the last timestep. defaults to running this transport solve.. It should be a bool, optional value." }, { "instruction": "What does the operator_kwargs parameter do in the deplete() method?", "input": "OpenMC Python API Model.deplete() parameter operator_kwargs", "output": "The operator_kwargs parameter keyword arguments passed to the depletion operator initializer (e.g., :func:`openmc.deplete.operator`). It should be a dict value." }, { "instruction": "What does the directory parameter do in the deplete() method?", "input": "OpenMC Python API Model.deplete() parameter directory", "output": "The directory parameter directory to write xml files to. if it doesn't exist already, it will be created. defaults to the current working directory. It should be a str, optional value." }, { "instruction": "What does the output parameter do in the deplete() method?", "input": "OpenMC Python API Model.deplete() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool value." }, { "instruction": "What does the integrator_kwargs parameter do in the deplete() method?", "input": "OpenMC Python API Model.deplete() parameter integrator_kwargs", "output": "The integrator_kwargs parameter remaining keyword arguments passed to the depletion integrator initializer (e.g., :func:`openmc.deplete.integrator.cecm`).. It should be a dict value." }, { "instruction": "What does the export_to_xml() method do in the Model class?", "input": "OpenMC Python API Model.export_to_xml() method", "output": "The export_to_xml() method export model to separate xml files. It's used for model operations." }, { "instruction": "How do you call the export_to_xml() method in the Model class?", "input": "OpenMC Python API Model.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, directory: PathLike, remove_surfs: bool, nuclides_to_ignore: Any). It takes 4 parameters." }, { "instruction": "What does the directory parameter do in the export_to_xml() method?", "input": "OpenMC Python API Model.export_to_xml() parameter directory", "output": "The directory parameter directory to write xml files to. if it doesn't exist already, it will be created.. It should be a str value." }, { "instruction": "What does the remove_surfs parameter do in the export_to_xml() method?", "input": "OpenMC Python API Model.export_to_xml() parameter remove_surfs", "output": "The remove_surfs parameter whether or not to remove redundant surfaces from the geometry when exporting. .. versionadded:: 0.13.1. It should be a bool value." }, { "instruction": "What does the nuclides_to_ignore parameter do in the export_to_xml() method?", "input": "OpenMC Python API Model.export_to_xml() parameter nuclides_to_ignore", "output": "The nuclides_to_ignore parameter nuclides to ignore when exporting to xml.. It should be a list of str value." }, { "instruction": "What does the export_to_model_xml() method do in the Model class?", "input": "OpenMC Python API Model.export_to_model_xml() method", "output": "The export_to_model_xml() method export model to a single xml file. .. versionadded:: 0.13.3. It's used for model operations." }, { "instruction": "How do you call the export_to_model_xml() method in the Model class?", "input": "OpenMC Python API Model.export_to_model_xml() method signature", "output": "To call the export_to_model_xml() method, use: def export_to_model_xml(self: Any, path: PathLike, remove_surfs: bool, nuclides_to_ignore: Any). It takes 4 parameters." }, { "instruction": "What does the path parameter do in the export_to_model_xml() method?", "input": "OpenMC Python API Model.export_to_model_xml() parameter path", "output": "The path parameter location of the xml file to write (default is 'model.xml'). can be a directory or file path.. It should be a str or PathLike value." }, { "instruction": "What does the remove_surfs parameter do in the export_to_model_xml() method?", "input": "OpenMC Python API Model.export_to_model_xml() parameter remove_surfs", "output": "The remove_surfs parameter whether or not to remove redundant surfaces from the geometry when exporting.. It should be a bool value." }, { "instruction": "What does the nuclides_to_ignore parameter do in the export_to_model_xml() method?", "input": "OpenMC Python API Model.export_to_model_xml() parameter nuclides_to_ignore", "output": "The nuclides_to_ignore parameter nuclides to ignore when exporting to xml.. It should be a list of str value." }, { "instruction": "What does the import_properties() method do in the Model class?", "input": "OpenMC Python API Model.import_properties() method", "output": "The import_properties() method import physical properties .. versionchanged:: 0.13.0 this method now updates values as loaded in memory with the c api. It's used for model operations." }, { "instruction": "How do you call the import_properties() method in the Model class?", "input": "OpenMC Python API Model.import_properties() method signature", "output": "To call the import_properties() method, use: def import_properties(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the import_properties() method?", "input": "OpenMC Python API Model.import_properties() parameter filename", "output": "The filename parameter path to properties hdf5 file see also -------- openmc.lib.export_properties. It should be a str value." }, { "instruction": "What does the run() method do in the Model class?", "input": "OpenMC Python API Model.run() method", "output": "The run() method run openmc if the c api has been initialized, then the c api is used, otherwise, this method creates the xml files and runs openmc via a system call. in both cases this method returns the path to the last statepoint file generated. .. versionchanged:: 0.12 instead of returning the final k-effective value, this function now returns the path to the final statepoint written. .. versionchanged:: 0.13.0 this method can utilize the c api for execution. It's used for model operations." }, { "instruction": "How do you call the run() method in the Model class?", "input": "OpenMC Python API Model.run() method signature", "output": "To call the run() method, use: def run(self: Any, particles: Any, threads: Any, geometry_debug: Any, restart_file: Any, tracks: Any, output: Any, cwd: Any, openmc_exec: Any, mpi_args: Any, event_based: Any, export_model_xml: Any, apply_tally_results: Any). It takes 13 parameters." }, { "instruction": "What does the particles parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter particles", "output": "The particles parameter number of particles to simulate per generation.. It should be a int, optional value." }, { "instruction": "What does the threads parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter threads", "output": "The threads parameter number of openmp threads. if openmc is compiled with openmp threading enabled, the default is implementation-dependent but is usually equal to the number of hardware threads available (or a value set by the :envvar:`omp_num_threads` environment variable).. It should be a int, optional value." }, { "instruction": "What does the geometry_debug parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter geometry_debug", "output": "The geometry_debug parameter turn on geometry debugging during simulation. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the restart_file parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter restart_file", "output": "The restart_file parameter path to restart file to use. It should be a str or PathLike value." }, { "instruction": "What does the tracks parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter tracks", "output": "The tracks parameter enables the writing of particles tracks. the number of particle tracks written to tracks.h5 is limited to 1000 unless settings.max_tracks is set. defaults to false.. It should be a bool, optional value." }, { "instruction": "What does the output parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool, optional value." }, { "instruction": "What does the cwd parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter cwd", "output": "The cwd parameter path to working directory to run in. defaults to the current working directory.. It should be a PathLike, optional value." }, { "instruction": "What does the openmc_exec parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. defaults to 'openmc'.. It should be a str, optional value." }, { "instruction": "What does the mpi_args parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter mpi_args", "output": "The mpi_args parameter mpi execute command and any additional mpi arguments to pass, e.g. ['mpiexec', '-n', '8'].. It should be a list of str, optional value." }, { "instruction": "What does the event_based parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter event_based", "output": "The event_based parameter turns on event-based parallelism if true. if none, the value in the settings will be used.. It should be a None or bool, optional value." }, { "instruction": "What does the export_model_xml parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter export_model_xml", "output": "The export_model_xml parameter exports a single model.xml file rather than separate files. defaults to true. .. versionadded:: 0.13.3. It should be a bool, optional value." }, { "instruction": "What does the apply_tally_results parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter apply_tally_results", "output": "The apply_tally_results parameter whether to apply results of the final statepoint file to the model's tally objects. .. versionadded:: 0.15.1 **export_kwargs keyword arguments passed to either :meth:`model.export_to_model_xml`. It should be a bool value." }, { "instruction": "What does the or parameter do in the run() method?", "input": "OpenMC Python API Model.run() parameter or", "output": "The or parameter . It should be a meth:`Model.export_to_xml`. value." }, { "instruction": "What does the calculate_volumes() method do in the Model class?", "input": "OpenMC Python API Model.calculate_volumes() method", "output": "The calculate_volumes() method runs an openmc stochastic volume calculation and, if requested, applies volumes to the model .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the calculate_volumes() method in the Model class?", "input": "OpenMC Python API Model.calculate_volumes() method signature", "output": "To call the calculate_volumes() method, use: def calculate_volumes(self: Any, threads: Any, output: Any, cwd: Any, openmc_exec: Any, mpi_args: Any, apply_volumes: Any, export_model_xml: Any). It takes 8 parameters." }, { "instruction": "What does the threads parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter threads", "output": "The threads parameter number of openmp threads. if openmc is compiled with openmp threading enabled, the default is implementation-dependent but is usually equal to the number of hardware threads available (or a value set by the :envvar:`omp_num_threads` environment variable). this currenty only applies to the case when not using the c api.. It should be a int, optional value." }, { "instruction": "What does the output parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool, optional value." }, { "instruction": "What does the openmc_exec parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. defaults to 'openmc'. this only applies to the case when not using the c api.. It should be a str, optional value." }, { "instruction": "What does the mpi_args parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter mpi_args", "output": "The mpi_args parameter mpi execute command and any additional mpi arguments to pass, e.g. ['mpiexec', '-n', '8']. this only applies to the case when not using the c api.. It should be a list of str, optional value." }, { "instruction": "What does the cwd parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter cwd", "output": "The cwd parameter path to working directory to run in. defaults to the current working directory.. It should be a str, optional value." }, { "instruction": "What does the apply_volumes parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter apply_volumes", "output": "The apply_volumes parameter whether apply the volume calculation results from this calculation to the model. defaults to applying the volumes.. It should be a bool, optional value." }, { "instruction": "What does the export_model_xml parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter export_model_xml", "output": "The export_model_xml parameter exports a single model.xml file rather than separate files. defaults to true. **export_kwargs keyword arguments passed to either :meth:`model.export_to_model_xml`. It should be a bool, optional value." }, { "instruction": "What does the or parameter do in the calculate_volumes() method?", "input": "OpenMC Python API Model.calculate_volumes() parameter or", "output": "The or parameter . It should be a meth:`Model.export_to_xml`. value." }, { "instruction": "What does the plot() method do in the Model class?", "input": "OpenMC Python API Model.plot() method", "output": "The plot() method display a slice plot of the model.\n\n .. versionadded:: 0.15.1. It's used for model operations." }, { "instruction": "How do you call the plot() method in the Model class?", "input": "OpenMC Python API Model.plot() method signature", "output": "To call the plot() method, use: @add_plot_params def plot(self: Any, origin: Any, width: Any, pixels: Any, basis: str, color_by: str, colors: Any, seed: Any, openmc_exec: PathLike, axes: Any, legend: bool, axis_units: str, outline: Any, show_overlaps: bool, overlap_color: Any, n_samples: Any, plane_tolerance: float, legend_kwargs: Any, source_kwargs: Any, contour_kwargs: Any). It takes 20 parameters." }, { "instruction": "What does the sample_external_source() method do in the Model class?", "input": "OpenMC Python API Model.sample_external_source() method", "output": "The sample_external_source() method sample external source and return source particles. .. versionadded:: 0.15.1. It's used for model operations." }, { "instruction": "How do you call the sample_external_source() method in the Model class?", "input": "OpenMC Python API Model.sample_external_source() method signature", "output": "To call the sample_external_source() method, use: def sample_external_source(self: Any, n_samples: int, prn_seed: Any). It takes 3 parameters." }, { "instruction": "What does the n_samples parameter do in the sample_external_source() method?", "input": "OpenMC Python API Model.sample_external_source() parameter n_samples", "output": "The n_samples parameter number of samples. It should be a int value." }, { "instruction": "What does the prn_seed parameter do in the sample_external_source() method?", "input": "OpenMC Python API Model.sample_external_source() parameter prn_seed", "output": "The prn_seed parameter pseudorandom number generator (prng) seed; if none, one will be generated randomly. **init_kwargs keyword arguments passed to :func:`openmc.lib.init`. It should be a int value." }, { "instruction": "What does the apply_tally_results() method do in the Model class?", "input": "OpenMC Python API Model.apply_tally_results() method", "output": "The apply_tally_results() method apply results from a statepoint to tally objects on the model. It's used for model operations." }, { "instruction": "How do you call the apply_tally_results() method in the Model class?", "input": "OpenMC Python API Model.apply_tally_results() method signature", "output": "To call the apply_tally_results() method, use: def apply_tally_results(self: Any, statepoint: Any). It takes 2 parameters." }, { "instruction": "What does the statepoint parameter do in the apply_tally_results() method?", "input": "OpenMC Python API Model.apply_tally_results() parameter statepoint", "output": "The statepoint parameter statepoint file used to update tally results. It should be a PathLike or openmc.StatePoint value." }, { "instruction": "What does the plot_geometry() method do in the Model class?", "input": "OpenMC Python API Model.plot_geometry() method", "output": "The plot_geometry() method creates plot images as specified by the model.plots attribute .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the plot_geometry() method in the Model class?", "input": "OpenMC Python API Model.plot_geometry() method signature", "output": "To call the plot_geometry() method, use: def plot_geometry(self: Any, output: Any, cwd: Any, openmc_exec: Any, export_model_xml: Any). It takes 5 parameters." }, { "instruction": "What does the output parameter do in the plot_geometry() method?", "input": "OpenMC Python API Model.plot_geometry() parameter output", "output": "The output parameter capture openmc output from standard out. It should be a bool, optional value." }, { "instruction": "What does the cwd parameter do in the plot_geometry() method?", "input": "OpenMC Python API Model.plot_geometry() parameter cwd", "output": "The cwd parameter path to working directory to run in. defaults to the current working directory.. It should be a str, optional value." }, { "instruction": "What does the openmc_exec parameter do in the plot_geometry() method?", "input": "OpenMC Python API Model.plot_geometry() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. defaults to 'openmc'. this only applies to the case when not using the c api.. It should be a str, optional value." }, { "instruction": "What does the export_model_xml parameter do in the plot_geometry() method?", "input": "OpenMC Python API Model.plot_geometry() parameter export_model_xml", "output": "The export_model_xml parameter exports a single model.xml file rather than separate files. defaults to true. **export_kwargs keyword arguments passed to either :meth:`model.export_to_model_xml`. It should be a bool, optional value." }, { "instruction": "What does the or parameter do in the plot_geometry() method?", "input": "OpenMC Python API Model.plot_geometry() parameter or", "output": "The or parameter . It should be a meth:`Model.export_to_xml`. value." }, { "instruction": "How do you call the _change_py_lib_attribs() method in the Model class?", "input": "OpenMC Python API Model._change_py_lib_attribs() method signature", "output": "To call the _change_py_lib_attribs() method, use: def _change_py_lib_attribs(self: Any, names_or_ids: Any, value: Any, obj_type: Any, attrib_name: Any, density_units: Any). It takes 6 parameters." }, { "instruction": "What does the rotate_cells() method do in the Model class?", "input": "OpenMC Python API Model.rotate_cells() method", "output": "The rotate_cells() method rotate the identified cell(s) by the specified rotation vector. the rotation is only applied to cells filled with a universe. .. note:: if applying this change to a name that is not unique, then the change will be applied to all objects of that name. .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the rotate_cells() method in the Model class?", "input": "OpenMC Python API Model.rotate_cells() method signature", "output": "To call the rotate_cells() method, use: def rotate_cells(self: Any, names_or_ids: Any, vector: Any). It takes 3 parameters." }, { "instruction": "What does the names_or_ids parameter do in the rotate_cells() method?", "input": "OpenMC Python API Model.rotate_cells() parameter names_or_ids", "output": "The names_or_ids parameter the cell names (if str) or id (if int) that are to be translated or rotated. this parameter can include a mix of names and ids.. It should be a Iterable of str or int value." }, { "instruction": "What does the vector parameter do in the rotate_cells() method?", "input": "OpenMC Python API Model.rotate_cells() parameter vector", "output": "The vector parameter the rotation vector of length 3 to apply. this array specifies the angles in degrees about the x, y, and z axes, respectively.. It should be a Iterable of float value." }, { "instruction": "What does the translate_cells() method do in the Model class?", "input": "OpenMC Python API Model.translate_cells() method", "output": "The translate_cells() method translate the identified cell(s) by the specified translation vector. the translation is only applied to cells filled with a universe. .. note:: if applying this change to a name that is not unique, then the change will be applied to all objects of that name. .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the translate_cells() method in the Model class?", "input": "OpenMC Python API Model.translate_cells() method signature", "output": "To call the translate_cells() method, use: def translate_cells(self: Any, names_or_ids: Any, vector: Any). It takes 3 parameters." }, { "instruction": "What does the names_or_ids parameter do in the translate_cells() method?", "input": "OpenMC Python API Model.translate_cells() parameter names_or_ids", "output": "The names_or_ids parameter the cell names (if str) or id (if int) that are to be translated or rotated. this parameter can include a mix of names and ids.. It should be a Iterable of str or int value." }, { "instruction": "What does the vector parameter do in the translate_cells() method?", "input": "OpenMC Python API Model.translate_cells() parameter vector", "output": "The vector parameter the translation vector of length 3 to apply. this array specifies the x, y, and z dimensions of the translation.. It should be a Iterable of float value." }, { "instruction": "What does the update_densities() method do in the Model class?", "input": "OpenMC Python API Model.update_densities() method", "output": "The update_densities() method update the density of a given set of materials to a new value .. note:: if applying this change to a name that is not unique, then the change will be applied to all objects of that name. .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the update_densities() method in the Model class?", "input": "OpenMC Python API Model.update_densities() method signature", "output": "To call the update_densities() method, use: def update_densities(self: Any, names_or_ids: Any, density: Any, density_units: Any). It takes 4 parameters." }, { "instruction": "What does the names_or_ids parameter do in the update_densities() method?", "input": "OpenMC Python API Model.update_densities() parameter names_or_ids", "output": "The names_or_ids parameter the material names (if str) or id (if int) that are to be updated. this parameter can include a mix of names and ids.. It should be a Iterable of str or int value." }, { "instruction": "What does the density parameter do in the update_densities() method?", "input": "OpenMC Python API Model.update_densities() parameter density", "output": "The density parameter the density to apply in the units specified by `density_units`. It should be a float value." }, { "instruction": "What does the density_units parameter do in the update_densities() method?", "input": "OpenMC Python API Model.update_densities() parameter density_units", "output": "The density_units parameter units for `density`. defaults to 'atom/b-cm'. It should be a {'atom/b-cm', 'g/cm3'}, optional value." }, { "instruction": "What does the update_cell_temperatures() method do in the Model class?", "input": "OpenMC Python API Model.update_cell_temperatures() method", "output": "The update_cell_temperatures() method update the temperature of a set of cells to the given value .. note:: if applying this change to a name that is not unique, then the change will be applied to all objects of that name. .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the update_cell_temperatures() method in the Model class?", "input": "OpenMC Python API Model.update_cell_temperatures() method signature", "output": "To call the update_cell_temperatures() method, use: def update_cell_temperatures(self: Any, names_or_ids: Any, temperature: Any). It takes 3 parameters." }, { "instruction": "What does the names_or_ids parameter do in the update_cell_temperatures() method?", "input": "OpenMC Python API Model.update_cell_temperatures() parameter names_or_ids", "output": "The names_or_ids parameter the cell names (if str) or id (if int) that are to be updated. this parameter can include a mix of names and ids.. It should be a Iterable of str or int value." }, { "instruction": "What does the temperature parameter do in the update_cell_temperatures() method?", "input": "OpenMC Python API Model.update_cell_temperatures() parameter temperature", "output": "The temperature parameter the temperature to apply in units of kelvin. It should be a float value." }, { "instruction": "What does the update_material_volumes() method do in the Model class?", "input": "OpenMC Python API Model.update_material_volumes() method", "output": "The update_material_volumes() method update the volume of a set of materials to the given value .. note:: if applying this change to a name that is not unique, then the change will be applied to all objects of that name. .. versionadded:: 0.13.0. It's used for model operations." }, { "instruction": "How do you call the update_material_volumes() method in the Model class?", "input": "OpenMC Python API Model.update_material_volumes() method signature", "output": "To call the update_material_volumes() method, use: def update_material_volumes(self: Any, names_or_ids: Any, volume: Any). It takes 3 parameters." }, { "instruction": "What does the names_or_ids parameter do in the update_material_volumes() method?", "input": "OpenMC Python API Model.update_material_volumes() parameter names_or_ids", "output": "The names_or_ids parameter the material names (if str) or id (if int) that are to be updated. this parameter can include a mix of names and ids.. It should be a Iterable of str or int value." }, { "instruction": "What does the volume parameter do in the update_material_volumes() method?", "input": "OpenMC Python API Model.update_material_volumes() parameter volume", "output": "The volume parameter the volume to apply in units of cm^3. It should be a float value." }, { "instruction": "What does the differentiate_depletable_mats() method do in the Model class?", "input": "OpenMC Python API Model.differentiate_depletable_mats() method", "output": "The differentiate_depletable_mats() method assign distribmats for each depletable material .. versionadded:: 0.14.0 .. versionchanged:: 0.15.1 diff_volume_method default is none, do not set volumes on the new material ovjects. is now a convenience method for differentiate_mats(diff_volume_method, depletable_only=true). It's used for model operations." }, { "instruction": "How do you call the differentiate_depletable_mats() method in the Model class?", "input": "OpenMC Python API Model.differentiate_depletable_mats() method signature", "output": "To call the differentiate_depletable_mats() method, use: def differentiate_depletable_mats(self: Any, diff_volume_method: str). It takes 2 parameters." }, { "instruction": "What does the diff_volume_method parameter do in the differentiate_depletable_mats() method?", "input": "OpenMC Python API Model.differentiate_depletable_mats() parameter diff_volume_method", "output": "The diff_volume_method parameter specifies how the volumes of the new materials should be found. - none: do not assign volumes to the new materials (default) - 'divide equally': divide the original material volume equally between the new materials - 'match cell': set the volume of the material to the volume of the cell they fill. It should be a str value." }, { "instruction": "What does the differentiate_mats() method do in the Model class?", "input": "OpenMC Python API Model.differentiate_mats() method", "output": "The differentiate_mats() method assign distribmats for each material .. versionadded:: 0.15.1. It's used for model operations." }, { "instruction": "How do you call the differentiate_mats() method in the Model class?", "input": "OpenMC Python API Model.differentiate_mats() method signature", "output": "To call the differentiate_mats() method, use: def differentiate_mats(self: Any, diff_volume_method: str, depletable_only: bool). It takes 3 parameters." }, { "instruction": "What does the diff_volume_method parameter do in the differentiate_mats() method?", "input": "OpenMC Python API Model.differentiate_mats() parameter diff_volume_method", "output": "The diff_volume_method parameter specifies how the volumes of the new materials should be found. - none: do not assign volumes to the new materials (default) - 'divide equally': divide the original material volume equally between the new materials - 'match cell': set the volume of the material to the volume of the cell they fill. It should be a str value." }, { "instruction": "What does the depletable_only parameter do in the differentiate_mats() method?", "input": "OpenMC Python API Model.differentiate_mats() parameter depletable_only", "output": "The depletable_only parameter default is true, only depletable materials will be differentiated. if false, all materials will be differentiated.. It should be a bool value." }, { "instruction": "What does the _generate_infinite_medium_mgxs() method do in the Model class?", "input": "OpenMC Python API Model._generate_infinite_medium_mgxs() method", "output": "The _generate_infinite_medium_mgxs() method generate a mgxs library by running multiple openmc simulations, each representing an infinite medium simulation of a single isolated material. a discrete source is used to sample particles, with an equal strength spread across each of the energy groups. this is a highly naive method that ignores all spatial self shielding effects and all resonance shielding effects between materials. It's used for model operations." }, { "instruction": "How do you call the _generate_infinite_medium_mgxs() method in the Model class?", "input": "OpenMC Python API Model._generate_infinite_medium_mgxs() method signature", "output": "To call the _generate_infinite_medium_mgxs() method, use: def _generate_infinite_medium_mgxs(self: Any, groups: Any, nparticles: Any, mgxs_path: Any, correction: Any, directory: Any). It takes 6 parameters." }, { "instruction": "What does the groups parameter do in the _generate_infinite_medium_mgxs() method?", "input": "OpenMC Python API Model._generate_infinite_medium_mgxs() parameter groups", "output": "The groups parameter energy group structure for the mgxs.. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the nparticles parameter do in the _generate_infinite_medium_mgxs() method?", "input": "OpenMC Python API Model._generate_infinite_medium_mgxs() parameter nparticles", "output": "The nparticles parameter number of particles to simulate per batch when generating mgxs.. It should be a int value." }, { "instruction": "What does the mgxs_path parameter do in the _generate_infinite_medium_mgxs() method?", "input": "OpenMC Python API Model._generate_infinite_medium_mgxs() parameter mgxs_path", "output": "The mgxs_path parameter filename for the mgxs hdf5 file.. It should be a str value." }, { "instruction": "What does the correction parameter do in the _generate_infinite_medium_mgxs() method?", "input": "OpenMC Python API Model._generate_infinite_medium_mgxs() parameter correction", "output": "The correction parameter transport correction to apply to the mgxs. options are none and \"p0\".. It should be a str value." }, { "instruction": "What does the directory parameter do in the _generate_infinite_medium_mgxs() method?", "input": "OpenMC Python API Model._generate_infinite_medium_mgxs() parameter directory", "output": "The directory parameter directory to run the simulation in, so as to contain xml files.. It should be a str value." }, { "instruction": "What does the _create_stochastic_slab_geometry() method do in the Model class?", "input": "OpenMC Python API Model._create_stochastic_slab_geometry() method", "output": "The _create_stochastic_slab_geometry() method create a geometry representing a stochastic \"sandwich\" of materials in a layered slab geometry. to reduce the impact of the order of materials in the slab, the materials are applied to 'num_repeats' different randomly positioned layers of 'cell_thickness' each. It's used for model operations." }, { "instruction": "How do you call the _create_stochastic_slab_geometry() method in the Model class?", "input": "OpenMC Python API Model._create_stochastic_slab_geometry() method signature", "output": "To call the _create_stochastic_slab_geometry() method, use: @staticmethod def _create_stochastic_slab_geometry(materials: Any, cell_thickness: Any, num_repeats: Any). It takes 3 parameters." }, { "instruction": "What does the materials parameter do in the _create_stochastic_slab_geometry() method?", "input": "OpenMC Python API Model._create_stochastic_slab_geometry() parameter materials", "output": "The materials parameter list of materials to assign. each material will appear exactly num_repeats times, then the ordering is randomly shuffled.. It should be a list of openmc.Material value." }, { "instruction": "What does the cell_thickness parameter do in the _create_stochastic_slab_geometry() method?", "input": "OpenMC Python API Model._create_stochastic_slab_geometry() parameter cell_thickness", "output": "The cell_thickness parameter thickness of each lattice cell in x (default 1.0 cm).. It should be a float, optional value." }, { "instruction": "What does the num_repeats parameter do in the _create_stochastic_slab_geometry() method?", "input": "OpenMC Python API Model._create_stochastic_slab_geometry() parameter num_repeats", "output": "The num_repeats parameter number of repeats for each material (default 100).. It should be a int, optional value." }, { "instruction": "What does the _create_stochastic_slab_geometry() method return in the Model class?", "input": "OpenMC Python API Model._create_stochastic_slab_geometry() return value", "output": "The _create_stochastic_slab_geometry() method returns the constructed geometry.. The return type is openmc.Geometry." }, { "instruction": "What does the _create_stochastic_slab_geometry() method return in the Model class?", "input": "OpenMC Python API Model._create_stochastic_slab_geometry() return value", "output": "The _create_stochastic_slab_geometry() method returns a spatial sampling distribution covering the full slab domain.. The return type is openmc.stats.Box." }, { "instruction": "What does the _generate_stochastic_slab_mgxs() method do in the Model class?", "input": "OpenMC Python API Model._generate_stochastic_slab_mgxs() method", "output": "The _generate_stochastic_slab_mgxs() method generate mgxs assuming a stochastic \"sandwich\" of materials in a layered slab geometry. while geometry-specific spatial shielding effects are not captured, this method can be useful when the geometry has materials only found far from the source region that the \"material_wise\" method would not be capable of generating cross sections for. conversely, this method will generate cross sections for all materials in the problem regardless of type. if this is a fixed source problem, a discrete source is used to sample particles, with an equal strength spread across each of the energy groups. It's used for model operations." }, { "instruction": "How do you call the _generate_stochastic_slab_mgxs() method in the Model class?", "input": "OpenMC Python API Model._generate_stochastic_slab_mgxs() method signature", "output": "To call the _generate_stochastic_slab_mgxs() method, use: def _generate_stochastic_slab_mgxs(self: Any, groups: Any, nparticles: Any, mgxs_path: Any, correction: Any, directory: Any). It takes 6 parameters." }, { "instruction": "What does the groups parameter do in the _generate_stochastic_slab_mgxs() method?", "input": "OpenMC Python API Model._generate_stochastic_slab_mgxs() parameter groups", "output": "The groups parameter energy group structure for the mgxs.. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the nparticles parameter do in the _generate_stochastic_slab_mgxs() method?", "input": "OpenMC Python API Model._generate_stochastic_slab_mgxs() parameter nparticles", "output": "The nparticles parameter number of particles to simulate per batch when generating mgxs.. It should be a int value." }, { "instruction": "What does the mgxs_path parameter do in the _generate_stochastic_slab_mgxs() method?", "input": "OpenMC Python API Model._generate_stochastic_slab_mgxs() parameter mgxs_path", "output": "The mgxs_path parameter filename for the mgxs hdf5 file.. It should be a str value." }, { "instruction": "What does the correction parameter do in the _generate_stochastic_slab_mgxs() method?", "input": "OpenMC Python API Model._generate_stochastic_slab_mgxs() parameter correction", "output": "The correction parameter transport correction to apply to the mgxs. options are none and \"p0\".. It should be a str value." }, { "instruction": "What does the directory parameter do in the _generate_stochastic_slab_mgxs() method?", "input": "OpenMC Python API Model._generate_stochastic_slab_mgxs() parameter directory", "output": "The directory parameter directory to run the simulation in, so as to contain xml files.. It should be a str value." }, { "instruction": "What does the _generate_material_wise_mgxs() method do in the Model class?", "input": "OpenMC Python API Model._generate_material_wise_mgxs() method", "output": "The _generate_material_wise_mgxs() method generate a material-wise mgxs library for the model by running the original continuous energy openmc simulation of the full material geometry and source, and tally mgxs data for each material. this method accurately conserves reaction rates totaled over the entire simulation domain. however, when the geometry has materials only found far from the source region, it is possible the monte carlo solver may not be able to score any tallies to these material types, thus resulting in zero cross section values for these materials. for such cases, the \"stochastic slab\" method may be more appropriate. It's used for model operations." }, { "instruction": "How do you call the _generate_material_wise_mgxs() method in the Model class?", "input": "OpenMC Python API Model._generate_material_wise_mgxs() method signature", "output": "To call the _generate_material_wise_mgxs() method, use: def _generate_material_wise_mgxs(self: Any, groups: Any, nparticles: Any, mgxs_path: Any, correction: Any, directory: Any). It takes 6 parameters." }, { "instruction": "What does the groups parameter do in the _generate_material_wise_mgxs() method?", "input": "OpenMC Python API Model._generate_material_wise_mgxs() parameter groups", "output": "The groups parameter energy group structure for the mgxs.. It should be a openmc.mgxs.EnergyGroups value." }, { "instruction": "What does the nparticles parameter do in the _generate_material_wise_mgxs() method?", "input": "OpenMC Python API Model._generate_material_wise_mgxs() parameter nparticles", "output": "The nparticles parameter number of particles to simulate per batch when generating mgxs.. It should be a int value." }, { "instruction": "What does the mgxs_path parameter do in the _generate_material_wise_mgxs() method?", "input": "OpenMC Python API Model._generate_material_wise_mgxs() parameter mgxs_path", "output": "The mgxs_path parameter filename for the mgxs hdf5 file.. It should be a str value." }, { "instruction": "What does the correction parameter do in the _generate_material_wise_mgxs() method?", "input": "OpenMC Python API Model._generate_material_wise_mgxs() parameter correction", "output": "The correction parameter transport correction to apply to the mgxs. options are none and \"p0\".. It should be a str value." }, { "instruction": "What does the directory parameter do in the _generate_material_wise_mgxs() method?", "input": "OpenMC Python API Model._generate_material_wise_mgxs() parameter directory", "output": "The directory parameter directory to run the simulation in, so as to contain xml files.. It should be a str value." }, { "instruction": "What does the convert_to_multigroup() method do in the Model class?", "input": "OpenMC Python API Model.convert_to_multigroup() method", "output": "The convert_to_multigroup() method convert all materials from continuous energy to multigroup. if no mgxs data library file is found, generate one using one or more continuous energy monte carlo simulations. It's used for model operations." }, { "instruction": "How do you call the convert_to_multigroup() method in the Model class?", "input": "OpenMC Python API Model.convert_to_multigroup() method signature", "output": "To call the convert_to_multigroup() method, use: def convert_to_multigroup(self: Any, method: Any, groups: Any, nparticles: Any, overwrite_mgxs_library: Any, mgxs_path: PathLike, correction: Any). It takes 7 parameters." }, { "instruction": "What does the method parameter do in the convert_to_multigroup() method?", "input": "OpenMC Python API Model.convert_to_multigroup() parameter method", "output": "The method parameter method to generate the mgxs.. It should be a {\"material_wise\", \"stochastic_slab\", \"infinite_medium\"}, optional value." }, { "instruction": "What does the groups parameter do in the convert_to_multigroup() method?", "input": "OpenMC Python API Model.convert_to_multigroup() parameter groups", "output": "The groups parameter energy group structure for the mgxs or the name of the group structure (based on keys from openmc.mgxs.group_structures).. It should be a openmc.mgxs.EnergyGroups or str, optional value." }, { "instruction": "What does the mgxs_path parameter do in the convert_to_multigroup() method?", "input": "OpenMC Python API Model.convert_to_multigroup() parameter mgxs_path", "output": "The mgxs_path parameter filename of the mgxs.h5 library file.. It should be a str, optional value." }, { "instruction": "What does the correction parameter do in the convert_to_multigroup() method?", "input": "OpenMC Python API Model.convert_to_multigroup() parameter correction", "output": "The correction parameter transport correction to apply to the mgxs. options are none and \"p0\".. It should be a str, optional value." }, { "instruction": "What does the convert_to_random_ray() method do in the Model class?", "input": "OpenMC Python API Model.convert_to_random_ray() method", "output": "The convert_to_random_ray() method convert a multigroup model to use random ray.\n\n this method determines values for the needed settings and adds them to\n the settings.random_ray dictionary so as to enable random ray mode. the\n settings that are populated are:\n\n - 'ray_source' (openmc.independentsource): where random ray starting\n points are sampled from.\n - 'distance_inactive' (float): the \"dead zone\" distance at the beginning\n of the ray.\n - 'distance_active' (float): the \"active\" distance of the ray\n - 'particles' (int): number of rays to simulate\n\n the method will determine reasonable defaults for each of the above\n variables based on analysis of the model's geometry. the function will\n have no effect if the random ray dictionary is already defined in the\n model settings.. It's used for model operations." }, { "instruction": "How do you call the convert_to_random_ray() method in the Model class?", "input": "OpenMC Python API Model.convert_to_random_ray() method signature", "output": "To call the convert_to_random_ray() method, use: def convert_to_random_ray(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _replace_infinity() function in OpenMC's Python API?", "input": "OpenMC Python API _replace_infinity() function signature", "output": "To call the _replace_infinity() function, use: def _replace_infinity(value: Any). It takes 1 parameters." }, { "instruction": "What is the CompositeSurface class in OpenMC's Python API?", "input": "OpenMC Python API CompositeSurface class", "output": "The CompositeSurface class represents multiple primitive surfaces combined into a composite surface. It provides 9 methods and 0 properties for working with compositesurface data in OpenMC." }, { "instruction": "What does the CompositeSurface class do in OpenMC's Python API?", "input": "OpenMC Python API CompositeSurface class description", "output": "The CompositeSurface class multiple primitive surfaces combined into a composite surface. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the translate() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.translate() method signature", "output": "To call the translate() method, use: def translate(self: Any, vector: Any, inplace: Any). It takes 3 parameters." }, { "instruction": "How do you call the rotate() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.rotate() method signature", "output": "To call the rotate() method, use: def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any). It takes 5 parameters." }, { "instruction": "How do you call the component_surfaces() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.component_surfaces() method signature", "output": "To call the component_surfaces() method, use: @property def component_surfaces(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the boundary_type() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.boundary_type() method signature", "output": "To call the boundary_type() method, use: @property def boundary_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the boundary_type() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.boundary_type() method signature", "output": "To call the boundary_type() method, use: @boundary_type.setter def boundary_type(self: Any, boundary_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the _surface_names() method do in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface._surface_names() method", "output": "The _surface_names() method iterable of attribute names corresponding to underlying surfaces.. It's used for compositesurface operations." }, { "instruction": "How do you call the _surface_names() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface._surface_names() method signature", "output": "To call the _surface_names() method, use: @property, @abstractmethod def _surface_names(self: Any). It takes 1 parameters." }, { "instruction": "What does the __neg__() method do in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.__neg__() method", "output": "The __neg__() method return the negative half-space of the composite surface.. It's used for compositesurface operations." }, { "instruction": "How do you call the __neg__() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.__neg__() method signature", "output": "To call the __neg__() method, use: @abstractmethod def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What does the __pos__() method do in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.__pos__() method", "output": "The __pos__() method return the positive half-space of the composite surface.. It's used for compositesurface operations." }, { "instruction": "How do you call the __pos__() method in the CompositeSurface class?", "input": "OpenMC Python API CompositeSurface.__pos__() method signature", "output": "To call the __pos__() method, use: def __pos__(self: Any). It takes 1 parameters." }, { "instruction": "What is the CylinderSector class in OpenMC's Python API?", "input": "OpenMC Python API CylinderSector class", "output": "The CylinderSector class represents infinite cylindrical sector composite surface. a cylinder sector is composed of two cylindrical and two planar surfaces. the cylindrical surfaces are concentric, and the planar surfaces intersect the central axis of the cylindrical surfaces. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cylinder sector. .. versionadded:: 0.13.1. It provides 3 methods and 0 properties for working with cylindersector data in OpenMC." }, { "instruction": "What does the CylinderSector class do in OpenMC's Python API?", "input": "OpenMC Python API CylinderSector class description", "output": "The CylinderSector class infinite cylindrical sector composite surface. a cylinder sector is composed of two cylindrical and two planar surfaces. the cylindrical surfaces are concentric, and the planar surfaces intersect the central axis of the cylindrical surfaces. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cylinder sector. .. versionadded:: 0.13.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the r1 parameter do when creating a CylinderSector?", "input": "OpenMC Python API CylinderSector constructor parameter r1", "output": "When creating a CylinderSector, the r1 parameter specifies inner radius of sector. must be less than r2.. It should be a float value." }, { "instruction": "What does the r2 parameter do when creating a CylinderSector?", "input": "OpenMC Python API CylinderSector constructor parameter r2", "output": "When creating a CylinderSector, the r2 parameter specifies outer radius of sector. must be greater than r1.. It should be a float value." }, { "instruction": "What does the theta1 parameter do when creating a CylinderSector?", "input": "OpenMC Python API CylinderSector constructor parameter theta1", "output": "When creating a CylinderSector, the theta1 parameter specifies clockwise-most bound of sector in degrees. assumed to be in the counterclockwise direction with respect to the first basis axis (+y, +z, or +x). must be less than :attr:`theta2`.. It should be a float value." }, { "instruction": "What does the theta2 parameter do when creating a CylinderSector?", "input": "OpenMC Python API CylinderSector constructor parameter theta2", "output": "When creating a CylinderSector, the theta2 parameter specifies counterclockwise-most bound of sector in degrees. assumed to be in the counterclockwise direction with respect to the first basis axis (+y, +z, or +x). must be greater than :attr:`theta1`.. It should be a float value." }, { "instruction": "What does the center parameter do when creating a CylinderSector?", "input": "OpenMC Python API CylinderSector constructor parameter center", "output": "When creating a CylinderSector, the center parameter specifies coordinate for central axes of cylinders in the (y, z), (x, z), or (x, y) basis. defaults to (0,0).. It should be a iterable of float value." }, { "instruction": "What does the axis parameter do when creating a CylinderSector?", "input": "OpenMC Python API CylinderSector constructor parameter axis", "output": "When creating a CylinderSector, the axis parameter specifies central axis of the cylinders defining the inner and outer surfaces of the sector. defaults to 'z'. **kwargs : dict keyword arguments passed to the :class:`cylinder` and :class:`plane` constructors.. It should be a {'x', 'y', 'z'} value." }, { "instruction": "What is the outer_cyl attribute of a CylinderSector?", "input": "OpenMC Python API CylinderSector attribute outer_cyl", "output": "The outer_cyl attribute of a CylinderSector contains outer cylinder surface.. It's a openmc.ZCylinder, openmc.YCylinder, or openmc.XCylinder value that you can access after creating a CylinderSector instance." }, { "instruction": "What is the inner_cyl attribute of a CylinderSector?", "input": "OpenMC Python API CylinderSector attribute inner_cyl", "output": "The inner_cyl attribute of a CylinderSector contains inner cylinder surface.. It's a openmc.ZCylinder, openmc.YCylinder, or openmc.XCylinder value that you can access after creating a CylinderSector instance." }, { "instruction": "What is the plane1 attribute of a CylinderSector?", "input": "OpenMC Python API CylinderSector attribute plane1", "output": "The plane1 attribute of a CylinderSector contains plane at angle :math:`\\theta_1` relative to the first basis axis.. It's a openmc.Plane value that you can access after creating a CylinderSector instance." }, { "instruction": "What is the plane2 attribute of a CylinderSector?", "input": "OpenMC Python API CylinderSector attribute plane2", "output": "The plane2 attribute of a CylinderSector contains plane at angle :math:`\\theta_2` relative to the first basis axis.. It's a openmc.Plane value that you can access after creating a CylinderSector instance." }, { "instruction": "How do you call the __init__() method in the CylinderSector class?", "input": "OpenMC Python API CylinderSector.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, r1: Any, r2: Any, theta1: Any, theta2: Any, center: Any, axis: Any). It takes 7 parameters." }, { "instruction": "What does the from_theta_alpha() method do in the CylinderSector class?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() method", "output": "The from_theta_alpha() method alternate constructor for :class:`cylindersector`. returns a :class:`cylindersector` object based on a central angle :math:`\\theta` and an angular offset :math:`\\alpha`. note that :math:`\\theta_1 = \\alpha` and :math:`\\theta_2 = \\alpha + \\theta`. It's used for cylindersector operations." }, { "instruction": "How do you call the from_theta_alpha() method in the CylinderSector class?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() method signature", "output": "To call the from_theta_alpha() method, use: @classmethod def from_theta_alpha(cls: Any, r1: Any, r2: Any, theta: Any, alpha: Any, center: Any, axis: Any). It takes 7 parameters." }, { "instruction": "What does the r1 parameter do in the from_theta_alpha() method?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() parameter r1", "output": "The r1 parameter inner radius of sector. must be less than r2.. It should be a float value." }, { "instruction": "What does the r2 parameter do in the from_theta_alpha() method?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() parameter r2", "output": "The r2 parameter outer radius of sector. must be greater than r1.. It should be a float value." }, { "instruction": "What does the theta parameter do in the from_theta_alpha() method?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() parameter theta", "output": "The theta parameter central angle, :math:`\\theta`, of the sector in degrees. must be greater that 0 and less than 360.. It should be a float value." }, { "instruction": "What does the alpha parameter do in the from_theta_alpha() method?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() parameter alpha", "output": "The alpha parameter angular offset, :math:`\\alpha`, of sector in degrees. the offset is in the counter-clockwise direction with respect to the first basis axis (+y, +z, or +x). note that negative values translate to an offset in the clockwise direction.. It should be a float value." }, { "instruction": "What does the center parameter do in the from_theta_alpha() method?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() parameter center", "output": "The center parameter coordinate for central axes of cylinders in the (y, z), (x, z), or (x, y) basis. defaults to (0,0).. It should be a iterable of float value." }, { "instruction": "What does the axis parameter do in the from_theta_alpha() method?", "input": "OpenMC Python API CylinderSector.from_theta_alpha() parameter axis", "output": "The axis parameter central axis of the cylinders defining the inner and outer surfaces of the sector. defaults to 'z'. **kwargs : dict keyword arguments passed to the :class:`cylinder` and :class:`plane` constructors.. It should be a {'x', 'y', 'z'} value." }, { "instruction": "How do you call the __neg__() method in the CylinderSector class?", "input": "OpenMC Python API CylinderSector.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What is the IsogonalOctagon class in OpenMC's Python API?", "input": "OpenMC Python API IsogonalOctagon class", "output": "The IsogonalOctagon class represents infinite isogonal octagon composite surface an isogonal octagon is composed of eight planar surfaces. the prism is parallel to the x, y, or z axis. the remaining two axes (y and z, x and z, or x and y) serve as a basis for constructing the surfaces. two surfaces are parallel to the first basis axis, two surfaces are parallel to the second basis axis, and the remaining four surfaces intersect both basis axes at 45 degree angles. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the octagonal prism. .. versionadded:: 0.13.1. It provides 3 methods and 0 properties for working with isogonaloctagon data in OpenMC." }, { "instruction": "What does the IsogonalOctagon class do in OpenMC's Python API?", "input": "OpenMC Python API IsogonalOctagon class description", "output": "The IsogonalOctagon class infinite isogonal octagon composite surface an isogonal octagon is composed of eight planar surfaces. the prism is parallel to the x, y, or z axis. the remaining two axes (y and z, x and z, or x and y) serve as a basis for constructing the surfaces. two surfaces are parallel to the first basis axis, two surfaces are parallel to the second basis axis, and the remaining four surfaces intersect both basis axes at 45 degree angles. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the octagonal prism. .. versionadded:: 0.13.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the center parameter do when creating a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon constructor parameter center", "output": "When creating a IsogonalOctagon, the center parameter specifies coordinate for the central axis of the octagon in the (y, z), (x, z), or (x, y) basis depending on the axis parameter.. It should be a iterable of float value." }, { "instruction": "What does the r1 parameter do when creating a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon constructor parameter r1", "output": "When creating a IsogonalOctagon, the r1 parameter specifies half-width of octagon across its basis axis-parallel sides in units of cm. must be less than :math:`r_2\\sqrt{2}`.. It should be a float value." }, { "instruction": "What does the r2 parameter do when creating a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon constructor parameter r2", "output": "When creating a IsogonalOctagon, the r2 parameter specifies half-width of octagon across its basis axis intersecting sides in units of cm. must be less than than :math:`r_1\\sqrt{2}`.. It should be a float value." }, { "instruction": "What does the axis parameter do when creating a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon constructor parameter axis", "output": "When creating a IsogonalOctagon, the axis parameter specifies central axis of octagon. defaults to 'z' **kwargs keyword arguments passed to underlying plane classes. It should be a {'x', 'y', 'z'} value." }, { "instruction": "What is the top attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute top", "output": "The top attribute of a IsogonalOctagon contains top planar surface of octagon. It's a openmc.ZPlane, openmc.XPlane, or openmc.YPlane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "What is the bottom attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute bottom", "output": "The bottom attribute of a IsogonalOctagon contains bottom planar surface of octagon. It's a openmc.ZPlane, openmc.XPlane, or openmc.YPlane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "What is the right attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute right", "output": "The right attribute of a IsogonalOctagon contains right planar surface of octagon. It's a openmc.YPlane, openmc.ZPlane, or openmc.XPlane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "What is the left attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute left", "output": "The left attribute of a IsogonalOctagon contains left planar surface of octagon. It's a openmc.YPlane, openmc.ZPlane, or openmc.XPlane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "What is the upper_right attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute upper_right", "output": "The upper_right attribute of a IsogonalOctagon contains upper right planar surface of octagon. It's a openmc.Plane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "What is the lower_right attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute lower_right", "output": "The lower_right attribute of a IsogonalOctagon contains lower right planar surface of octagon. It's a openmc.Plane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "What is the lower_left attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute lower_left", "output": "The lower_left attribute of a IsogonalOctagon contains lower left planar surface of octagon. It's a openmc.Plane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "What is the upper_left attribute of a IsogonalOctagon?", "input": "OpenMC Python API IsogonalOctagon attribute upper_left", "output": "The upper_left attribute of a IsogonalOctagon contains upper left planar surface of octagon. It's a openmc.Plane value that you can access after creating a IsogonalOctagon instance." }, { "instruction": "How do you call the __init__() method in the IsogonalOctagon class?", "input": "OpenMC Python API IsogonalOctagon.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, center: Any, r1: Any, r2: Any, axis: Any). It takes 5 parameters." }, { "instruction": "How do you call the __neg__() method in the IsogonalOctagon class?", "input": "OpenMC Python API IsogonalOctagon.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __pos__() method in the IsogonalOctagon class?", "input": "OpenMC Python API IsogonalOctagon.__pos__() method signature", "output": "To call the __pos__() method, use: def __pos__(self: Any). It takes 1 parameters." }, { "instruction": "What is the RightCircularCylinder class in OpenMC's Python API?", "input": "OpenMC Python API RightCircularCylinder class", "output": "The RightCircularCylinder class represents right circular cylinder composite surface a right circular cylinder is composed of a cylinder and two planar surface perpendicular to the axis of the cylinder. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the right circular cylinder. .. versionadded:: 0.12. It provides 6 methods and 0 properties for working with rightcircularcylinder data in OpenMC." }, { "instruction": "What does the RightCircularCylinder class do in OpenMC's Python API?", "input": "OpenMC Python API RightCircularCylinder class description", "output": "The RightCircularCylinder class right circular cylinder composite surface a right circular cylinder is composed of a cylinder and two planar surface perpendicular to the axis of the cylinder. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the right circular cylinder. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the center_base parameter do when creating a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder constructor parameter center_base", "output": "When creating a RightCircularCylinder, the center_base parameter specifies cartesian coordinate of the center of the base of the cylinder. It should be a iterable of float value." }, { "instruction": "What does the height parameter do when creating a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder constructor parameter height", "output": "When creating a RightCircularCylinder, the height parameter specifies height of the cylinder. It should be a float value." }, { "instruction": "What does the radius parameter do when creating a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder constructor parameter radius", "output": "When creating a RightCircularCylinder, the radius parameter specifies radius of the cylinder. It should be a float value." }, { "instruction": "What does the axis parameter do when creating a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder constructor parameter axis", "output": "When creating a RightCircularCylinder, the axis parameter specifies axis of the cylinder. It should be a {'x', 'y', 'z'} value." }, { "instruction": "What does the upper_fillet_radius parameter do when creating a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder constructor parameter upper_fillet_radius", "output": "When creating a RightCircularCylinder, the upper_fillet_radius parameter specifies upper edge fillet radius in [cm].. It should be a float value." }, { "instruction": "What does the lower_fillet_radius parameter do when creating a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder constructor parameter lower_fillet_radius", "output": "When creating a RightCircularCylinder, the lower_fillet_radius parameter specifies lower edge fillet radius in [cm]. **kwargs keyword arguments passed to underlying cylinder and plane classes. It should be a float value." }, { "instruction": "What is the cyl attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute cyl", "output": "The cyl attribute of a RightCircularCylinder contains underlying cylinder surface. It's a openmc.Cylinder value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the bottom attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute bottom", "output": "The bottom attribute of a RightCircularCylinder contains bottom planar surface of the cylinder. It's a openmc.Plane value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the top attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute top", "output": "The top attribute of a RightCircularCylinder contains top planar surface of the cylinder. It's a openmc.Plane value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the upper_fillet_torus attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute upper_fillet_torus", "output": "The upper_fillet_torus attribute of a RightCircularCylinder contains surface that creates the filleted edge for the upper end of the cylinder. only present if :attr:`upper_fillet_radius` is set.. It's a openmc.Torus value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the upper_fillet_cylinder attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute upper_fillet_cylinder", "output": "The upper_fillet_cylinder attribute of a RightCircularCylinder contains surface that bounds :attr:`upper_fillet_torus` radially. only present. It's a openmc.Cylinder value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the if attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute if", "output": "The if attribute of a RightCircularCylinder contains . It's a attr:`upper_fillet_radius` is set. value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the upper_fillet_plane attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute upper_fillet_plane", "output": "The upper_fillet_plane attribute of a RightCircularCylinder contains surface that bounds :attr:`upper_fillet_torus` axially. only present if :attr:`upper_fillet_radius` is set.. It's a openmc.Plane value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the lower_fillet_torus attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute lower_fillet_torus", "output": "The lower_fillet_torus attribute of a RightCircularCylinder contains surface that creates the filleted edge for the lower end of the cylinder. only present if :attr:`lower_fillet_radius` is set.. It's a openmc.Torus value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the lower_fillet_cylinder attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute lower_fillet_cylinder", "output": "The lower_fillet_cylinder attribute of a RightCircularCylinder contains surface that bounds :attr:`lower_fillet_torus` radially. only present. It's a openmc.Cylinder value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the if attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute if", "output": "The if attribute of a RightCircularCylinder contains . It's a attr:`lower_fillet_radius` is set. value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "What is the lower_fillet_plane attribute of a RightCircularCylinder?", "input": "OpenMC Python API RightCircularCylinder attribute lower_fillet_plane", "output": "The lower_fillet_plane attribute of a RightCircularCylinder contains surface that bounds :attr:`lower_fillet_torus` axially. only present if :attr:`lower_fillet_radius` is set.. It's a openmc.Plane value that you can access after creating a RightCircularCylinder instance." }, { "instruction": "How do you call the __init__() method in the RightCircularCylinder class?", "input": "OpenMC Python API RightCircularCylinder.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, center_base: Any, height: Any, radius: Any, axis: Any, upper_fillet_radius: Any, lower_fillet_radius: Any). It takes 7 parameters." }, { "instruction": "How do you call the _get_fillet() method in the RightCircularCylinder class?", "input": "OpenMC Python API RightCircularCylinder._get_fillet() method signature", "output": "To call the _get_fillet() method, use: def _get_fillet(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_upper_fillet() method in the RightCircularCylinder class?", "input": "OpenMC Python API RightCircularCylinder._get_upper_fillet() method signature", "output": "To call the _get_upper_fillet() method, use: def _get_upper_fillet(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_lower_fillet() method in the RightCircularCylinder class?", "input": "OpenMC Python API RightCircularCylinder._get_lower_fillet() method signature", "output": "To call the _get_lower_fillet() method, use: def _get_lower_fillet(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __neg__() method in the RightCircularCylinder class?", "input": "OpenMC Python API RightCircularCylinder.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __pos__() method in the RightCircularCylinder class?", "input": "OpenMC Python API RightCircularCylinder.__pos__() method signature", "output": "To call the __pos__() method, use: def __pos__(self: Any). It takes 1 parameters." }, { "instruction": "What is the RectangularParallelepiped class in OpenMC's Python API?", "input": "OpenMC Python API RectangularParallelepiped class", "output": "The RectangularParallelepiped class represents rectangular parallelpiped composite surface a rectangular parallelpiped is composed of six planar surfaces. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the rectangular parallelpiped. .. versionadded:: 0.12. It provides 3 methods and 0 properties for working with rectangularparallelepiped data in OpenMC." }, { "instruction": "What does the RectangularParallelepiped class do in OpenMC's Python API?", "input": "OpenMC Python API RectangularParallelepiped class description", "output": "The RectangularParallelepiped class rectangular parallelpiped composite surface a rectangular parallelpiped is composed of six planar surfaces. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the rectangular parallelpiped. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the RectangularParallelepiped class?", "input": "OpenMC Python API RectangularParallelepiped.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, xmin: Any, xmax: Any, ymin: Any, ymax: Any, zmin: Any, zmax: Any). It takes 7 parameters." }, { "instruction": "How do you call the __neg__() method in the RectangularParallelepiped class?", "input": "OpenMC Python API RectangularParallelepiped.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __pos__() method in the RectangularParallelepiped class?", "input": "OpenMC Python API RectangularParallelepiped.__pos__() method signature", "output": "To call the __pos__() method, use: def __pos__(self: Any). It takes 1 parameters." }, { "instruction": "What is the OrthogonalBox class in OpenMC's Python API?", "input": "OpenMC Python API OrthogonalBox class", "output": "The OrthogonalBox class represents arbitrarily oriented orthogonal box this composite surface is composed of four or six planar surfaces that form an arbitrarily oriented orthogonal box when combined. It provides 2 methods and 0 properties for working with orthogonalbox data in OpenMC." }, { "instruction": "What does the OrthogonalBox class do in OpenMC's Python API?", "input": "OpenMC Python API OrthogonalBox class description", "output": "The OrthogonalBox class arbitrarily oriented orthogonal box this composite surface is composed of four or six planar surfaces that form an arbitrarily oriented orthogonal box when combined. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the v parameter do when creating a OrthogonalBox?", "input": "OpenMC Python API OrthogonalBox constructor parameter v", "output": "When creating a OrthogonalBox, the v parameter specifies (x,y,z) coordinates of a corner of the box. It should be a iterable of float value." }, { "instruction": "What does the a1 parameter do when creating a OrthogonalBox?", "input": "OpenMC Python API OrthogonalBox constructor parameter a1", "output": "When creating a OrthogonalBox, the a1 parameter specifies vector of first side starting from ``v``. It should be a iterable of float value." }, { "instruction": "What does the a2 parameter do when creating a OrthogonalBox?", "input": "OpenMC Python API OrthogonalBox constructor parameter a2", "output": "When creating a OrthogonalBox, the a2 parameter specifies vector of second side starting from ``v``. It should be a iterable of float value." }, { "instruction": "What does the a3 parameter do when creating a OrthogonalBox?", "input": "OpenMC Python API OrthogonalBox constructor parameter a3", "output": "When creating a OrthogonalBox, the a3 parameter specifies vector of third side starting from ``v``. when not specified, it is assumed that the box will be infinite along the vector normal to the plane specified by ``a1`` and ``a2``. **kwargs keyword arguments passed to underlying plane classes. It should be a iterable of float, optional value." }, { "instruction": "How do you call the __init__() method in the OrthogonalBox class?", "input": "OpenMC Python API OrthogonalBox.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, v: Any, a1: Any, a2: Any, a3: Any). It takes 5 parameters." }, { "instruction": "How do you call the __neg__() method in the OrthogonalBox class?", "input": "OpenMC Python API OrthogonalBox.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What is the XConeOneSided class in OpenMC's Python API?", "input": "OpenMC Python API XConeOneSided class", "output": "The XConeOneSided class represents one-sided cone parallel the x-axis a one-sided cone is composed of a normal cone surface and a \"disambiguation\" surface that eliminates the ambiguity as to which region of space is included. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cone. .. versionadded:: 0.12. It provides 2 methods and 0 properties for working with xconeonesided data in OpenMC." }, { "instruction": "What does the XConeOneSided class do in OpenMC's Python API?", "input": "OpenMC Python API XConeOneSided class description", "output": "The XConeOneSided class one-sided cone parallel the x-axis a one-sided cone is composed of a normal cone surface and a \"disambiguation\" surface that eliminates the ambiguity as to which region of space is included. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cone. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a XConeOneSided?", "input": "OpenMC Python API XConeOneSided constructor parameter x0", "output": "When creating a XConeOneSided, the x0 parameter specifies x-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a XConeOneSided?", "input": "OpenMC Python API XConeOneSided constructor parameter y0", "output": "When creating a XConeOneSided, the y0 parameter specifies y-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a XConeOneSided?", "input": "OpenMC Python API XConeOneSided constructor parameter z0", "output": "When creating a XConeOneSided, the z0 parameter specifies z-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the r2 parameter do when creating a XConeOneSided?", "input": "OpenMC Python API XConeOneSided constructor parameter r2", "output": "When creating a XConeOneSided, the r2 parameter specifies the square of the slope of the cone. it is defined as :math:`\\left(\\frac{r}{h}\\right)^2` for a radius, :math:`r` and an axial. It should be a float, optional value." }, { "instruction": "What does the distance parameter do when creating a XConeOneSided?", "input": "OpenMC Python API XConeOneSided constructor parameter distance", "output": "When creating a XConeOneSided, the distance parameter specifies to take the square of the radius of the cone (in cm) 1 cm from the apex.. It should be a math:`h` from the apex. An easy way to define this quantity is value." }, { "instruction": "What does the up parameter do when creating a XConeOneSided?", "input": "OpenMC Python API XConeOneSided constructor parameter up", "output": "When creating a XConeOneSided, the up parameter specifies whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of the ambiguity plane) **kwargs keyword arguments passed to underlying plane classes. It should be a bool value." }, { "instruction": "What is the cone attribute of a XConeOneSided?", "input": "OpenMC Python API XConeOneSided attribute cone", "output": "The cone attribute of a XConeOneSided contains regular two-sided cone. It's a openmc.XCone value that you can access after creating a XConeOneSided instance." }, { "instruction": "What is the plane attribute of a XConeOneSided?", "input": "OpenMC Python API XConeOneSided attribute plane", "output": "The plane attribute of a XConeOneSided contains disambiguation surface. It's a openmc.XPlane value that you can access after creating a XConeOneSided instance." }, { "instruction": "What is the up attribute of a XConeOneSided?", "input": "OpenMC Python API XConeOneSided attribute up", "output": "The up attribute of a XConeOneSided contains whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of the ambiguity plane). It's a bool value that you can access after creating a XConeOneSided instance." }, { "instruction": "How do you call the __init__() method in the XConeOneSided class?", "input": "OpenMC Python API XConeOneSided.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r2: Any, up: Any). It takes 6 parameters." }, { "instruction": "How do you call the __neg__() method in the XConeOneSided class?", "input": "OpenMC Python API XConeOneSided.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What is the YConeOneSided class in OpenMC's Python API?", "input": "OpenMC Python API YConeOneSided class", "output": "The YConeOneSided class represents one-sided cone parallel the y-axis a one-sided cone is composed of a normal cone surface and a \"disambiguation\" surface that eliminates the ambiguity as to which region of space is included. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cone. .. versionadded:: 0.12. It provides 1 methods and 0 properties for working with yconeonesided data in OpenMC." }, { "instruction": "What does the YConeOneSided class do in OpenMC's Python API?", "input": "OpenMC Python API YConeOneSided class description", "output": "The YConeOneSided class one-sided cone parallel the y-axis a one-sided cone is composed of a normal cone surface and a \"disambiguation\" surface that eliminates the ambiguity as to which region of space is included. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cone. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a YConeOneSided?", "input": "OpenMC Python API YConeOneSided constructor parameter x0", "output": "When creating a YConeOneSided, the x0 parameter specifies x-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a YConeOneSided?", "input": "OpenMC Python API YConeOneSided constructor parameter y0", "output": "When creating a YConeOneSided, the y0 parameter specifies y-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a YConeOneSided?", "input": "OpenMC Python API YConeOneSided constructor parameter z0", "output": "When creating a YConeOneSided, the z0 parameter specifies z-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the r2 parameter do when creating a YConeOneSided?", "input": "OpenMC Python API YConeOneSided constructor parameter r2", "output": "When creating a YConeOneSided, the r2 parameter specifies the square of the slope of the cone. it is defined as :math:`\\left(\\frac{r}{h}\\right)^2` for a radius, :math:`r` and an axial. It should be a float, optional value." }, { "instruction": "What does the distance parameter do when creating a YConeOneSided?", "input": "OpenMC Python API YConeOneSided constructor parameter distance", "output": "When creating a YConeOneSided, the distance parameter specifies to take the square of the radius of the cone (in cm) 1 cm from the apex.. It should be a math:`h` from the apex. An easy way to define this quantity is value." }, { "instruction": "What does the up parameter do when creating a YConeOneSided?", "input": "OpenMC Python API YConeOneSided constructor parameter up", "output": "When creating a YConeOneSided, the up parameter specifies whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of the ambiguity plane) **kwargs keyword arguments passed to underlying plane classes. It should be a bool value." }, { "instruction": "What is the cone attribute of a YConeOneSided?", "input": "OpenMC Python API YConeOneSided attribute cone", "output": "The cone attribute of a YConeOneSided contains regular two-sided cone. It's a openmc.YCone value that you can access after creating a YConeOneSided instance." }, { "instruction": "What is the plane attribute of a YConeOneSided?", "input": "OpenMC Python API YConeOneSided attribute plane", "output": "The plane attribute of a YConeOneSided contains disambiguation surface. It's a openmc.YPlane value that you can access after creating a YConeOneSided instance." }, { "instruction": "What is the up attribute of a YConeOneSided?", "input": "OpenMC Python API YConeOneSided attribute up", "output": "The up attribute of a YConeOneSided contains whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of the ambiguity plane). It's a bool value that you can access after creating a YConeOneSided instance." }, { "instruction": "How do you call the __init__() method in the YConeOneSided class?", "input": "OpenMC Python API YConeOneSided.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r2: Any, up: Any). It takes 6 parameters." }, { "instruction": "What is the ZConeOneSided class in OpenMC's Python API?", "input": "OpenMC Python API ZConeOneSided class", "output": "The ZConeOneSided class represents one-sided cone parallel the z-axis a one-sided cone is composed of a normal cone surface and a \"disambiguation\" surface that eliminates the ambiguity as to which region of space is included. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cone. .. versionadded:: 0.12. It provides 1 methods and 0 properties for working with zconeonesided data in OpenMC." }, { "instruction": "What does the ZConeOneSided class do in OpenMC's Python API?", "input": "OpenMC Python API ZConeOneSided class description", "output": "The ZConeOneSided class one-sided cone parallel the z-axis a one-sided cone is composed of a normal cone surface and a \"disambiguation\" surface that eliminates the ambiguity as to which region of space is included. this class acts as a proper surface, meaning that unary `+` and `-` operators applied to it will produce a half-space. the negative side is defined to be the region inside of the cone. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided constructor parameter x0", "output": "When creating a ZConeOneSided, the x0 parameter specifies x-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided constructor parameter y0", "output": "When creating a ZConeOneSided, the y0 parameter specifies y-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided constructor parameter z0", "output": "When creating a ZConeOneSided, the z0 parameter specifies z-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the r2 parameter do when creating a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided constructor parameter r2", "output": "When creating a ZConeOneSided, the r2 parameter specifies the square of the slope of the cone. it is defined as :math:`\\left(\\frac{r}{h}\\right)^2` for a radius, :math:`r` and an axial. It should be a float, optional value." }, { "instruction": "What does the distance parameter do when creating a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided constructor parameter distance", "output": "When creating a ZConeOneSided, the distance parameter specifies to take the square of the radius of the cone (in cm) 1 cm from the apex.. It should be a math:`h` from the apex. An easy way to define this quantity is value." }, { "instruction": "What does the up parameter do when creating a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided constructor parameter up", "output": "When creating a ZConeOneSided, the up parameter specifies whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of the ambiguity plane) **kwargs keyword arguments passed to underlying plane classes. It should be a bool value." }, { "instruction": "What is the cone attribute of a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided attribute cone", "output": "The cone attribute of a ZConeOneSided contains regular two-sided cone. It's a openmc.ZCone value that you can access after creating a ZConeOneSided instance." }, { "instruction": "What is the plane attribute of a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided attribute plane", "output": "The plane attribute of a ZConeOneSided contains disambiguation surface. It's a openmc.ZPlane value that you can access after creating a ZConeOneSided instance." }, { "instruction": "What is the up attribute of a ZConeOneSided?", "input": "OpenMC Python API ZConeOneSided attribute up", "output": "The up attribute of a ZConeOneSided contains whether to select the side of the cone that extends to infinity in the positive direction of the coordinate axis (the positive half-space of the ambiguity plane). It's a bool value that you can access after creating a ZConeOneSided instance." }, { "instruction": "How do you call the __init__() method in the ZConeOneSided class?", "input": "OpenMC Python API ZConeOneSided.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r2: Any, up: Any). It takes 6 parameters." }, { "instruction": "What is the Polygon class in OpenMC's Python API?", "input": "OpenMC Python API Polygon class", "output": "The Polygon class represents polygon formed from a path of closed points. .. versionadded:: 0.13.3. It provides 16 methods and 0 properties for working with polygon data in OpenMC." }, { "instruction": "What does the Polygon class do in OpenMC's Python API?", "input": "OpenMC Python API Polygon class description", "output": "The Polygon class polygon formed from a path of closed points. .. versionadded:: 0.13.3. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the points parameter do when creating a Polygon?", "input": "OpenMC Python API Polygon constructor parameter points", "output": "When creating a Polygon, the points parameter specifies an nx2 array of points defining the vertices of the polygon.. It should be a np.ndarray value." }, { "instruction": "What does the basis parameter do when creating a Polygon?", "input": "OpenMC Python API Polygon constructor parameter basis", "output": "When creating a Polygon, the basis parameter specifies 2d basis set for the polygon. the polygon is two dimensional and has infinite extent in the third (unspecified) dimension. for example, the 'xy' basis produces a polygon with infinite extent in the +/- z direction. for the 'rz' basis the phi extent is infinite, thus forming an axisymmetric surface.. It should be a {'rz', 'xy', 'yz', 'xz'}, optional value." }, { "instruction": "What is the points attribute of a Polygon?", "input": "OpenMC Python API Polygon attribute points", "output": "The points attribute of a Polygon contains an nx2 array of points defining the vertices of the polygon.. It's a np.ndarray value that you can access after creating a Polygon instance." }, { "instruction": "What is the basis attribute of a Polygon?", "input": "OpenMC Python API Polygon attribute basis", "output": "The basis attribute of a Polygon contains 2d basis set for the polygon.. It's a {'rz', 'xy', 'yz', 'xz'} value that you can access after creating a Polygon instance." }, { "instruction": "What is the regions attribute of a Polygon?", "input": "OpenMC Python API Polygon attribute regions", "output": "The regions attribute of a Polygon contains a list of :class:`openmc.region` objects, one for each of the convex polygons formed during the decomposition of the input polygon.. It's a list of openmc.Region value that you can access after creating a Polygon instance." }, { "instruction": "What is the region attribute of a Polygon?", "input": "OpenMC Python API Polygon attribute region", "output": "The region attribute of a Polygon contains the union of all the regions comprising the polygon.. It's a openmc.Union value that you can access after creating a Polygon instance." }, { "instruction": "How do you call the __init__() method in the Polygon class?", "input": "OpenMC Python API Polygon.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, points: Any, basis: Any). It takes 3 parameters." }, { "instruction": "How do you call the __neg__() method in the Polygon class?", "input": "OpenMC Python API Polygon.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _surface_names() method in the Polygon class?", "input": "OpenMC Python API Polygon._surface_names() method signature", "output": "To call the _surface_names() method, use: @property def _surface_names(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the boundary_type() method in the Polygon class?", "input": "OpenMC Python API Polygon.boundary_type() method signature", "output": "To call the boundary_type() method, use: @.setter def boundary_type(self: Any, boundary_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the points() method in the Polygon class?", "input": "OpenMC Python API Polygon.points() method signature", "output": "To call the points() method, use: @property def points(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the basis() method in the Polygon class?", "input": "OpenMC Python API Polygon.basis() method signature", "output": "To call the basis() method, use: @property def basis(self: Any). It takes 1 parameters." }, { "instruction": "What does the _normals() method do in the Polygon class?", "input": "OpenMC Python API Polygon._normals() method", "output": "The _normals() method generate the outward normal unit vectors for the polygon.. It's used for polygon operations." }, { "instruction": "How do you call the _normals() method in the Polygon class?", "input": "OpenMC Python API Polygon._normals() method signature", "output": "To call the _normals() method, use: @property def _normals(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _equations() method in the Polygon class?", "input": "OpenMC Python API Polygon._equations() method signature", "output": "To call the _equations() method, use: @property def _equations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the regions() method in the Polygon class?", "input": "OpenMC Python API Polygon.regions() method signature", "output": "To call the regions() method, use: @property def regions(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the region() method in the Polygon class?", "input": "OpenMC Python API Polygon.region() method signature", "output": "To call the region() method, use: @property def region(self: Any). It takes 1 parameters." }, { "instruction": "What does the _validate_points() method do in the Polygon class?", "input": "OpenMC Python API Polygon._validate_points() method", "output": "The _validate_points() method ensure the closed path defined by points does not intersect and is oriented counter-clockwise. It's used for polygon operations." }, { "instruction": "How do you call the _validate_points() method in the Polygon class?", "input": "OpenMC Python API Polygon._validate_points() method signature", "output": "To call the _validate_points() method, use: def _validate_points(self: Any, points: Any). It takes 2 parameters." }, { "instruction": "What does the points parameter do in the _validate_points() method?", "input": "OpenMC Python API Polygon._validate_points() parameter points", "output": "The points parameter an nx2 array of coordinate pairs describing the vertices.. It should be a np.ndarray (Nx2) value." }, { "instruction": "What does the _validate_points() method return in the Polygon class?", "input": "OpenMC Python API Polygon._validate_points() return value", "output": "The _validate_points() method returns . The return type is the input points ordered counter-clockwise." }, { "instruction": "What does the _constrain_triangulation() method do in the Polygon class?", "input": "OpenMC Python API Polygon._constrain_triangulation() method", "output": "The _constrain_triangulation() method generate a constrained triangulation by ensuring all edges of the polygon are contained within the simplices. It's used for polygon operations." }, { "instruction": "How do you call the _constrain_triangulation() method in the Polygon class?", "input": "OpenMC Python API Polygon._constrain_triangulation() method signature", "output": "To call the _constrain_triangulation() method, use: def _constrain_triangulation(self: Any, points: Any, depth: Any). It takes 3 parameters." }, { "instruction": "What does the points parameter do in the _constrain_triangulation() method?", "input": "OpenMC Python API Polygon._constrain_triangulation() parameter points", "output": "The points parameter an nx2 array of coordinate pairs describing the vertices. these points represent a planar straight line graph.. It should be a np.ndarray (Nx2) value." }, { "instruction": "What does the _group_simplices() method do in the Polygon class?", "input": "OpenMC Python API Polygon._group_simplices() method", "output": "The _group_simplices() method generate a convex grouping of simplices. It's used for polygon operations." }, { "instruction": "How do you call the _group_simplices() method in the Polygon class?", "input": "OpenMC Python API Polygon._group_simplices() method signature", "output": "To call the _group_simplices() method, use: def _group_simplices(self: Any, neighbor_map: Any, group: Any). It takes 3 parameters." }, { "instruction": "What does the neighbor_map parameter do in the _group_simplices() method?", "input": "OpenMC Python API Polygon._group_simplices() parameter neighbor_map", "output": "The neighbor_map parameter a map whose keys are simplex indices for simplices inside the polygon and whose values are a list of simplex indices that neighbor this simplex and are also inside the polygon.. It should be a dict value." }, { "instruction": "What does the group parameter do in the _group_simplices() method?", "input": "OpenMC Python API Polygon._group_simplices() parameter group", "output": "The group parameter a list of simplex indices that comprise the current convex group.. It should be a list value." }, { "instruction": "What does the _group_simplices() method return in the Polygon class?", "input": "OpenMC Python API Polygon._group_simplices() return value", "output": "The _group_simplices() method returns the list of simplex indices that comprise the complete convex group.. The return type is list." }, { "instruction": "What does the _get_convex_hull_surfs() method do in the Polygon class?", "input": "OpenMC Python API Polygon._get_convex_hull_surfs() method", "output": "The _get_convex_hull_surfs() method generate a list of surfaces given by a set of linear equations. It's used for polygon operations." }, { "instruction": "How do you call the _get_convex_hull_surfs() method in the Polygon class?", "input": "OpenMC Python API Polygon._get_convex_hull_surfs() method signature", "output": "To call the _get_convex_hull_surfs() method, use: def _get_convex_hull_surfs(self: Any, qhull: Any). It takes 2 parameters." }, { "instruction": "What does the qhull parameter do in the _get_convex_hull_surfs() method?", "input": "OpenMC Python API Polygon._get_convex_hull_surfs() parameter qhull", "output": "The qhull parameter a convexhull object representing the sub-region of the polygon.. It should be a scipy.spatial.ConvexHull value." }, { "instruction": "What does the _get_convex_hull_surfs() method return in the Polygon class?", "input": "OpenMC Python API Polygon._get_convex_hull_surfs() return value", "output": "The _get_convex_hull_surfs() method returns . The return type is list of (surface, operator) tuples." }, { "instruction": "What does the _decompose_polygon_into_convex_sets() method do in the Polygon class?", "input": "OpenMC Python API Polygon._decompose_polygon_into_convex_sets() method", "output": "The _decompose_polygon_into_convex_sets() method decompose the polygon into a set of convex polygons. It's used for polygon operations." }, { "instruction": "How do you call the _decompose_polygon_into_convex_sets() method in the Polygon class?", "input": "OpenMC Python API Polygon._decompose_polygon_into_convex_sets() method signature", "output": "To call the _decompose_polygon_into_convex_sets() method, use: def _decompose_polygon_into_convex_sets(self: Any). It takes 1 parameters." }, { "instruction": "What does the _decompose_polygon_into_convex_sets() method return in the Polygon class?", "input": "OpenMC Python API Polygon._decompose_polygon_into_convex_sets() return value", "output": "The _decompose_polygon_into_convex_sets() method returns . The return type is a list of lists of surface, operator pairs." }, { "instruction": "What does the offset() method do in the Polygon class?", "input": "OpenMC Python API Polygon.offset() method", "output": "The offset() method offset this polygon by a set distance. It's used for polygon operations." }, { "instruction": "How do you call the offset() method in the Polygon class?", "input": "OpenMC Python API Polygon.offset() method signature", "output": "To call the offset() method, use: def offset(self: Any, distance: Any). It takes 2 parameters." }, { "instruction": "What does the distance parameter do in the offset() method?", "input": "OpenMC Python API Polygon.offset() parameter distance", "output": "The distance parameter the distance to offset the polygon by. positive is outward (expanding) and negative is inward (shrinking). if a float is provided, the same offset is applied to all vertices. if a list or tuple is provided, each vertex gets a different offset. if an iterable or numpy array is provided, each vertex gets a different offset.. It should be a float or sequence of float or np.ndarray value." }, { "instruction": "What does the offset() method return in the Polygon class?", "input": "OpenMC Python API Polygon.offset() return value", "output": "The offset() method returns . The return type is openmc.model.Polygon." }, { "instruction": "What is the CruciformPrism class in OpenMC's Python API?", "input": "OpenMC Python API CruciformPrism class", "output": "The CruciformPrism class represents generalized cruciform prism this surface represents a prism parallel to an axis formed by planes at multiple distances from the center. equivalent to the 'gcross' derived surface in serpent. .. versionadded:: 0.14.0. It provides 5 methods and 0 properties for working with cruciformprism data in OpenMC." }, { "instruction": "What does the CruciformPrism class do in OpenMC's Python API?", "input": "OpenMC Python API CruciformPrism class description", "output": "The CruciformPrism class generalized cruciform prism this surface represents a prism parallel to an axis formed by planes at multiple distances from the center. equivalent to the 'gcross' derived surface in serpent. .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the distances parameter do when creating a CruciformPrism?", "input": "OpenMC Python API CruciformPrism constructor parameter distances", "output": "When creating a CruciformPrism, the distances parameter specifies a monotonically increasing (or decreasing) iterable of distances in [cm] that form the planes of the generalized cruciform.. It should be a iterable of float value." }, { "instruction": "What does the center parameter do when creating a CruciformPrism?", "input": "OpenMC Python API CruciformPrism constructor parameter center", "output": "When creating a CruciformPrism, the center parameter specifies the center of the prism in the two non-parallel axes (e.g., (x, y) when axis is 'z') in [cm]. It should be a iterable of float value." }, { "instruction": "What does the axis parameter do when creating a CruciformPrism?", "input": "OpenMC Python API CruciformPrism constructor parameter axis", "output": "When creating a CruciformPrism, the axis parameter specifies axis to which the prism is parallel **kwargs keyword arguments passed to underlying plane classes. It should be a {'x', 'y', 'z'} value." }, { "instruction": "How do you call the __init__() method in the CruciformPrism class?", "input": "OpenMC Python API CruciformPrism.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, distances: Any, center: Any, axis: Any). It takes 4 parameters." }, { "instruction": "How do you call the _surface_names() method in the CruciformPrism class?", "input": "OpenMC Python API CruciformPrism._surface_names() method signature", "output": "To call the _surface_names() method, use: @property def _surface_names(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the distances() method in the CruciformPrism class?", "input": "OpenMC Python API CruciformPrism.distances() method signature", "output": "To call the distances() method, use: @property def distances(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the distances() method in the CruciformPrism class?", "input": "OpenMC Python API CruciformPrism.distances() method signature", "output": "To call the distances() method, use: @distances.setter def distances(self: Any, values: Any). It takes 2 parameters." }, { "instruction": "How do you call the __neg__() method in the CruciformPrism class?", "input": "OpenMC Python API CruciformPrism.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What is the RectangularPrism class in OpenMC's Python API?", "input": "OpenMC Python API RectangularPrism class", "output": "The RectangularPrism class represents infinite rectangular prism bounded by four planar surfaces. .. versionadded:: 0.14.0. It provides 2 methods and 0 properties for working with rectangularprism data in OpenMC." }, { "instruction": "What does the RectangularPrism class do in OpenMC's Python API?", "input": "OpenMC Python API RectangularPrism class description", "output": "The RectangularPrism class infinite rectangular prism bounded by four planar surfaces. .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the width parameter do when creating a RectangularPrism?", "input": "OpenMC Python API RectangularPrism constructor parameter width", "output": "When creating a RectangularPrism, the width parameter specifies prism width in units of [cm]. the width is aligned with the x, x, or z axes for prisms parallel to the x, y, or z axis, respectively.. It should be a float value." }, { "instruction": "What does the height parameter do when creating a RectangularPrism?", "input": "OpenMC Python API RectangularPrism constructor parameter height", "output": "When creating a RectangularPrism, the height parameter specifies prism height in units of [cm]. the height is aligned with the x, y, or z axes for prisms parallel to the x, y, or z axis, respectively.. It should be a float value." }, { "instruction": "What does the axis parameter do when creating a RectangularPrism?", "input": "OpenMC Python API RectangularPrism constructor parameter axis", "output": "When creating a RectangularPrism, the axis parameter specifies axis with which the infinite length of the prism should be aligned.. It should be a {'x', 'y', 'z'} value." }, { "instruction": "What does the origin parameter do when creating a RectangularPrism?", "input": "OpenMC Python API RectangularPrism constructor parameter origin", "output": "When creating a RectangularPrism, the origin parameter specifies origin of the prism. the two floats correspond to (y,z), (x,z) or (x,y) for prisms parallel to the x, y or z axis, respectively.. It should be a Iterable of two floats value." }, { "instruction": "What does the boundary_type parameter do when creating a RectangularPrism?", "input": "OpenMC Python API RectangularPrism constructor parameter boundary_type", "output": "When creating a RectangularPrism, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surfaces comprising the rectangular prism.. It should be a {'transmission, 'vacuum', 'reflective', 'periodic', 'white'} value." }, { "instruction": "What does the albedo parameter do when creating a RectangularPrism?", "input": "OpenMC Python API RectangularPrism constructor parameter albedo", "output": "When creating a RectangularPrism, the albedo parameter specifies albedo of the prism's surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the corner_radius parameter do when creating a RectangularPrism?", "input": "OpenMC Python API RectangularPrism constructor parameter corner_radius", "output": "When creating a RectangularPrism, the corner_radius parameter specifies prism corner radius in units of [cm].. It should be a float value." }, { "instruction": "How do you call the __init__() method in the RectangularPrism class?", "input": "OpenMC Python API RectangularPrism.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, width: float, height: float, axis: str, origin: Any, boundary_type: str, albedo: float, corner_radius: float). It takes 8 parameters." }, { "instruction": "How do you call the __neg__() method in the RectangularPrism class?", "input": "OpenMC Python API RectangularPrism.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What is the HexagonalPrism class in OpenMC's Python API?", "input": "OpenMC Python API HexagonalPrism class", "output": "The HexagonalPrism class represents hexagonal prism comoposed of six planar surfaces .. versionadded:: 0.14.0. It provides 2 methods and 0 properties for working with hexagonalprism data in OpenMC." }, { "instruction": "What does the HexagonalPrism class do in OpenMC's Python API?", "input": "OpenMC Python API HexagonalPrism class description", "output": "The HexagonalPrism class hexagonal prism comoposed of six planar surfaces .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the edge_length parameter do when creating a HexagonalPrism?", "input": "OpenMC Python API HexagonalPrism constructor parameter edge_length", "output": "When creating a HexagonalPrism, the edge_length parameter specifies length of a side of the hexagon in [cm]. It should be a float value." }, { "instruction": "What does the orientation parameter do when creating a HexagonalPrism?", "input": "OpenMC Python API HexagonalPrism constructor parameter orientation", "output": "When creating a HexagonalPrism, the orientation parameter specifies an 'x' orientation means that two sides of the hexagon are parallel to the x-axis and a 'y' orientation means that two sides of the hexagon are parallel to the y-axis.. It should be a {'x', 'y'} value." }, { "instruction": "What does the origin parameter do when creating a HexagonalPrism?", "input": "OpenMC Python API HexagonalPrism constructor parameter origin", "output": "When creating a HexagonalPrism, the origin parameter specifies origin of the prism.. It should be a Iterable of two floats value." }, { "instruction": "What does the boundary_type parameter do when creating a HexagonalPrism?", "input": "OpenMC Python API HexagonalPrism constructor parameter boundary_type", "output": "When creating a HexagonalPrism, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surfaces comprising the hexagonal prism.. It should be a {'transmission, 'vacuum', 'reflective', 'periodic', 'white'} value." }, { "instruction": "What does the albedo parameter do when creating a HexagonalPrism?", "input": "OpenMC Python API HexagonalPrism constructor parameter albedo", "output": "When creating a HexagonalPrism, the albedo parameter specifies albedo of the prism's surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the corner_radius parameter do when creating a HexagonalPrism?", "input": "OpenMC Python API HexagonalPrism constructor parameter corner_radius", "output": "When creating a HexagonalPrism, the corner_radius parameter specifies prism corner radius in units of [cm].. It should be a float value." }, { "instruction": "How do you call the __init__() method in the HexagonalPrism class?", "input": "OpenMC Python API HexagonalPrism.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, edge_length: float, orientation: str, origin: Any, boundary_type: str, albedo: float, corner_radius: float). It takes 7 parameters." }, { "instruction": "How do you call the __neg__() method in the HexagonalPrism class?", "input": "OpenMC Python API HexagonalPrism.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What is the ConicalFrustum class in OpenMC's Python API?", "input": "OpenMC Python API ConicalFrustum class", "output": "The ConicalFrustum class represents conical frustum. a conical frustum, also known as a right truncated cone, is a cone that is truncated by two parallel planes that are perpendicular to the axis of the cone. the lower and upper base of the conical frustum are circular faces. this surface is equivalent to the trc macrobody in mcnp. .. versionadded:: 0.15.1. It provides 2 methods and 0 properties for working with conicalfrustum data in OpenMC." }, { "instruction": "What does the ConicalFrustum class do in OpenMC's Python API?", "input": "OpenMC Python API ConicalFrustum class description", "output": "The ConicalFrustum class conical frustum. a conical frustum, also known as a right truncated cone, is a cone that is truncated by two parallel planes that are perpendicular to the axis of the cone. the lower and upper base of the conical frustum are circular faces. this surface is equivalent to the trc macrobody in mcnp. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the center_base parameter do when creating a ConicalFrustum?", "input": "OpenMC Python API ConicalFrustum constructor parameter center_base", "output": "When creating a ConicalFrustum, the center_base parameter specifies cartesian coordinates of the center of the bottom planar face.. It should be a iterable of float value." }, { "instruction": "What does the axis parameter do when creating a ConicalFrustum?", "input": "OpenMC Python API ConicalFrustum constructor parameter axis", "output": "When creating a ConicalFrustum, the axis parameter specifies vector from the center of the bottom planar face to the center of the top planar face that defines the axis of the cone. the length of this vector is the height of the conical frustum.. It should be a iterable of float value." }, { "instruction": "What does the r1 parameter do when creating a ConicalFrustum?", "input": "OpenMC Python API ConicalFrustum constructor parameter r1", "output": "When creating a ConicalFrustum, the r1 parameter specifies radius of the lower cone base. It should be a float value." }, { "instruction": "What does the r2 parameter do when creating a ConicalFrustum?", "input": "OpenMC Python API ConicalFrustum constructor parameter r2", "output": "When creating a ConicalFrustum, the r2 parameter specifies radius of the upper cone base **kwargs keyword arguments passed to underlying plane classes. It should be a float value." }, { "instruction": "What is the cone attribute of a ConicalFrustum?", "input": "OpenMC Python API ConicalFrustum attribute cone", "output": "The cone attribute of a ConicalFrustum contains cone surface. It's a openmc.Cone value that you can access after creating a ConicalFrustum instance." }, { "instruction": "What is the plane_bottom attribute of a ConicalFrustum?", "input": "OpenMC Python API ConicalFrustum attribute plane_bottom", "output": "The plane_bottom attribute of a ConicalFrustum contains plane surface defining the bottom of the frustum. It's a openmc.Plane value that you can access after creating a ConicalFrustum instance." }, { "instruction": "What is the plane_top attribute of a ConicalFrustum?", "input": "OpenMC Python API ConicalFrustum attribute plane_top", "output": "The plane_top attribute of a ConicalFrustum contains plane surface defining the top of the frustum. It's a openmc.Plane value that you can access after creating a ConicalFrustum instance." }, { "instruction": "How do you call the __init__() method in the ConicalFrustum class?", "input": "OpenMC Python API ConicalFrustum.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, center_base: Any, axis: Any, r1: float, r2: float). It takes 5 parameters." }, { "instruction": "How do you call the __neg__() method in the ConicalFrustum class?", "input": "OpenMC Python API ConicalFrustum.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What is the Vessel class in OpenMC's Python API?", "input": "OpenMC Python API Vessel class", "output": "The Vessel class represents vessel composed of cylinder with semi-ellipsoid top and bottom. this composite surface is represented by a finite cylinder with ellipsoidal top and bottom surfaces. this surface is equivalent to the 'vesesl' surface in serpent. .. versionadded:: 0.15.1. It provides 2 methods and 0 properties for working with vessel data in OpenMC." }, { "instruction": "What does the Vessel class do in OpenMC's Python API?", "input": "OpenMC Python API Vessel class description", "output": "The Vessel class vessel composed of cylinder with semi-ellipsoid top and bottom. this composite surface is represented by a finite cylinder with ellipsoidal top and bottom surfaces. this surface is equivalent to the 'vesesl' surface in serpent. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the r parameter do when creating a Vessel?", "input": "OpenMC Python API Vessel constructor parameter r", "output": "When creating a Vessel, the r parameter specifies radius of vessel.. It should be a float value." }, { "instruction": "What does the p1 parameter do when creating a Vessel?", "input": "OpenMC Python API Vessel constructor parameter p1", "output": "When creating a Vessel, the p1 parameter specifies minimum coordinate for cylindrical part of vessel.. It should be a float value." }, { "instruction": "What does the p2 parameter do when creating a Vessel?", "input": "OpenMC Python API Vessel constructor parameter p2", "output": "When creating a Vessel, the p2 parameter specifies maximum coordinate for cylindrical part of vessel.. It should be a float value." }, { "instruction": "What does the h1 parameter do when creating a Vessel?", "input": "OpenMC Python API Vessel constructor parameter h1", "output": "When creating a Vessel, the h1 parameter specifies height of bottom ellipsoidal part of vessel.. It should be a float value." }, { "instruction": "What does the h2 parameter do when creating a Vessel?", "input": "OpenMC Python API Vessel constructor parameter h2", "output": "When creating a Vessel, the h2 parameter specifies height of top ellipsoidal part of vessel.. It should be a float value." }, { "instruction": "What does the center parameter do when creating a Vessel?", "input": "OpenMC Python API Vessel constructor parameter center", "output": "When creating a Vessel, the center parameter specifies coordinate for central axis of the cylinder in the (y, z), (x, z), or (x, y) basis. defaults to (0,0).. It should be a 2-tuple of float value." }, { "instruction": "What does the axis parameter do when creating a Vessel?", "input": "OpenMC Python API Vessel constructor parameter axis", "output": "When creating a Vessel, the axis parameter specifies central axis of the cylinder.. It should be a {'x', 'y', 'z'} value." }, { "instruction": "How do you call the __init__() method in the Vessel class?", "input": "OpenMC Python API Vessel.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, r: float, p1: float, p2: float, h1: float, h2: float, center: Any, axis: str). It takes 8 parameters." }, { "instruction": "How do you call the __neg__() method in the Vessel class?", "input": "OpenMC Python API Vessel.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _plane() function in OpenMC's Python API?", "input": "OpenMC Python API _plane() function signature", "output": "To call the _plane() function, use: def _plane(axis: Any, name: Any, value: Any, boundary_type: Any, albedo: Any). It takes 5 parameters." }, { "instruction": "What does the _rotation_matrix() function do in OpenMC's Python API?", "input": "OpenMC Python API _rotation_matrix() function", "output": "The _rotation_matrix() function compute rotation matrix that would rotate v1 into v2. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _rotation_matrix() function in OpenMC's Python API?", "input": "OpenMC Python API _rotation_matrix() function purpose", "output": "The _rotation_matrix() function compute rotation matrix that would rotate v1 into v2. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _rotation_matrix() function in OpenMC's Python API?", "input": "OpenMC Python API _rotation_matrix() function signature", "output": "To call the _rotation_matrix() function, use: def _rotation_matrix(v1: Any, v2: Any). It takes 2 parameters." }, { "instruction": "What does the v1 parameter do in the _rotation_matrix() function?", "input": "OpenMC Python API _rotation_matrix() parameter v1", "output": "The v1 parameter unrotated vector. It should be a numpy.ndarray value." }, { "instruction": "What does the v2 parameter do in the _rotation_matrix() function?", "input": "OpenMC Python API _rotation_matrix() parameter v2", "output": "The v2 parameter rotated vector. It should be a numpy.ndarray value." }, { "instruction": "How do you call the _create_fillet_objects() function in OpenMC's Python API?", "input": "OpenMC Python API _create_fillet_objects() function signature", "output": "To call the _create_fillet_objects() function, use: def _create_fillet_objects(axis_args: Any, height: Any, center_base: Any, radius: Any, fillet_radius: Any, pos: Any). It takes 6 parameters." }, { "instruction": "What is the TRISO class in OpenMC's Python API?", "input": "OpenMC Python API TRISO class", "output": "The TRISO class represents tristructural-isotopic (triso) micro fuel particle. It provides 4 methods and 0 properties for working with triso data in OpenMC." }, { "instruction": "What does the TRISO class do in OpenMC's Python API?", "input": "OpenMC Python API TRISO class description", "output": "The TRISO class tristructural-isotopic (triso) micro fuel particle. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the outer_radius parameter do when creating a TRISO?", "input": "OpenMC Python API TRISO constructor parameter outer_radius", "output": "When creating a TRISO, the outer_radius parameter specifies outer radius of triso particle. It should be a float value." }, { "instruction": "What does the fill parameter do when creating a TRISO?", "input": "OpenMC Python API TRISO constructor parameter fill", "output": "When creating a TRISO, the fill parameter specifies universe which contains all layers of the triso particle. It should be a openmc.Universe value." }, { "instruction": "What does the center parameter do when creating a TRISO?", "input": "OpenMC Python API TRISO constructor parameter center", "output": "When creating a TRISO, the center parameter specifies cartesian coordinates of the center of the triso particle in cm. It should be a Iterable of float value." }, { "instruction": "What is the id attribute of a TRISO?", "input": "OpenMC Python API TRISO attribute id", "output": "The id attribute of a TRISO contains unique identifier for the triso cell. It's a int value that you can access after creating a TRISO instance." }, { "instruction": "What is the name attribute of a TRISO?", "input": "OpenMC Python API TRISO attribute name", "output": "The name attribute of a TRISO contains name of the triso cell. It's a str value that you can access after creating a TRISO instance." }, { "instruction": "What is the center attribute of a TRISO?", "input": "OpenMC Python API TRISO attribute center", "output": "The center attribute of a TRISO contains cartesian coordinates of the center of the triso particle in cm. It's a numpy.ndarray value that you can access after creating a TRISO instance." }, { "instruction": "What is the fill attribute of a TRISO?", "input": "OpenMC Python API TRISO attribute fill", "output": "The fill attribute of a TRISO contains universe that contains the triso layers. It's a openmc.Universe value that you can access after creating a TRISO instance." }, { "instruction": "What is the region attribute of a TRISO?", "input": "OpenMC Python API TRISO attribute region", "output": "The region attribute of a TRISO contains region of space within the triso particle. It's a openmc.Region value that you can access after creating a TRISO instance." }, { "instruction": "How do you call the __init__() method in the TRISO class?", "input": "OpenMC Python API TRISO.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, outer_radius: Any, fill: Any, center: Any). It takes 4 parameters." }, { "instruction": "How do you call the center() method in the TRISO class?", "input": "OpenMC Python API TRISO.center() method signature", "output": "To call the center() method, use: @property def center(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the center() method in the TRISO class?", "input": "OpenMC Python API TRISO.center() method signature", "output": "To call the center() method, use: @center.setter def center(self: Any, center: Any). It takes 2 parameters." }, { "instruction": "What does the classify() method do in the TRISO class?", "input": "OpenMC Python API TRISO.classify() method", "output": "The classify() method determine lattice element indices which might contain the triso particle. It's used for triso operations." }, { "instruction": "How do you call the classify() method in the TRISO class?", "input": "OpenMC Python API TRISO.classify() method signature", "output": "To call the classify() method, use: def classify(self: Any, lattice: Any). It takes 2 parameters." }, { "instruction": "What does the lattice parameter do in the classify() method?", "input": "OpenMC Python API TRISO.classify() parameter lattice", "output": "The lattice parameter lattice to check. It should be a openmc.RectLattice value." }, { "instruction": "What is the _Container class in OpenMC's Python API?", "input": "OpenMC Python API _Container class", "output": "The _Container class represents container in which to pack spheres. It provides 13 methods and 0 properties for working with _container data in OpenMC." }, { "instruction": "What does the _Container class do in OpenMC's Python API?", "input": "OpenMC Python API _Container class description", "output": "The _Container class container in which to pack spheres. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the sphere_radius parameter do when creating a _Container?", "input": "OpenMC Python API _Container constructor parameter sphere_radius", "output": "When creating a _Container, the sphere_radius parameter specifies radius of spheres to be packed in container.. It should be a float value." }, { "instruction": "What does the center parameter do when creating a _Container?", "input": "OpenMC Python API _Container constructor parameter center", "output": "When creating a _Container, the center parameter specifies cartesian coordinates of the center of the container. default is (0., 0., 0.). It should be a Iterable of float value." }, { "instruction": "What is the sphere_radius attribute of a _Container?", "input": "OpenMC Python API _Container attribute sphere_radius", "output": "The sphere_radius attribute of a _Container contains radius of spheres to be packed in container.. It's a float value that you can access after creating a _Container instance." }, { "instruction": "What is the center attribute of a _Container?", "input": "OpenMC Python API _Container attribute center", "output": "The center attribute of a _Container contains cartesian coordinates of the center of the container. default is (0., 0., 0.). It's a list of float value that you can access after creating a _Container instance." }, { "instruction": "What is the cell_length attribute of a _Container?", "input": "OpenMC Python API _Container attribute cell_length", "output": "The cell_length attribute of a _Container contains length in x-, y-, and z- directions of each cell in mesh overlaid on domain.. It's a list of float value that you can access after creating a _Container instance." }, { "instruction": "What is the limits attribute of a _Container?", "input": "OpenMC Python API _Container attribute limits", "output": "The limits attribute of a _Container contains constraint on where sphere center can be placed.. It's a list of float value that you can access after creating a _Container instance." }, { "instruction": "What is the volume attribute of a _Container?", "input": "OpenMC Python API _Container attribute volume", "output": "The volume attribute of a _Container contains volume of the container.. It's a float value that you can access after creating a _Container instance." }, { "instruction": "How do you call the __init__() method in the _Container class?", "input": "OpenMC Python API _Container.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, sphere_radius: Any, center: Any). It takes 3 parameters." }, { "instruction": "How do you call the sphere_radius() method in the _Container class?", "input": "OpenMC Python API _Container.sphere_radius() method signature", "output": "To call the sphere_radius() method, use: @property def sphere_radius(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sphere_radius() method in the _Container class?", "input": "OpenMC Python API _Container.sphere_radius() method signature", "output": "To call the sphere_radius() method, use: @sphere_radius.setter def sphere_radius(self: Any, sphere_radius: Any). It takes 2 parameters." }, { "instruction": "How do you call the center() method in the _Container class?", "input": "OpenMC Python API _Container.center() method signature", "output": "To call the center() method, use: @property def center(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the center() method in the _Container class?", "input": "OpenMC Python API _Container.center() method signature", "output": "To call the center() method, use: @center.setter def center(self: Any, center: Any). It takes 2 parameters." }, { "instruction": "How do you call the limits() method in the _Container class?", "input": "OpenMC Python API _Container.limits() method signature", "output": "To call the limits() method, use: @abstractproperty def limits(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cell_length() method in the _Container class?", "input": "OpenMC Python API _Container.cell_length() method signature", "output": "To call the cell_length() method, use: @abstractproperty def cell_length(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the _Container class?", "input": "OpenMC Python API _Container.volume() method signature", "output": "To call the volume() method, use: @abstractproperty def volume(self: Any). It takes 1 parameters." }, { "instruction": "What does the mesh_cell() method do in the _Container class?", "input": "OpenMC Python API _Container.mesh_cell() method", "output": "The mesh_cell() method calculate the index of the cell in a mesh overlaid on the domain in which the given sphere center falls. It's used for _container operations." }, { "instruction": "How do you call the mesh_cell() method in the _Container class?", "input": "OpenMC Python API _Container.mesh_cell() method signature", "output": "To call the mesh_cell() method, use: def mesh_cell(self: Any, p: Any). It takes 2 parameters." }, { "instruction": "What does the p parameter do in the mesh_cell() method?", "input": "OpenMC Python API _Container.mesh_cell() parameter p", "output": "The p parameter cartesian coordinates of sphere center.. It should be a Iterable of float value." }, { "instruction": "What does the nearby_mesh_cells() method do in the _Container class?", "input": "OpenMC Python API _Container.nearby_mesh_cells() method", "output": "The nearby_mesh_cells() method calculates the indices of all cells in a mesh overlaid on the domain within one diameter of the given sphere. It's used for _container operations." }, { "instruction": "How do you call the nearby_mesh_cells() method in the _Container class?", "input": "OpenMC Python API _Container.nearby_mesh_cells() method signature", "output": "To call the nearby_mesh_cells() method, use: def nearby_mesh_cells(self: Any, p: Any). It takes 2 parameters." }, { "instruction": "What does the p parameter do in the nearby_mesh_cells() method?", "input": "OpenMC Python API _Container.nearby_mesh_cells() parameter p", "output": "The p parameter cartesian coordinates of sphere center.. It should be a Iterable of float value." }, { "instruction": "What does the from_region() method do in the _Container class?", "input": "OpenMC Python API _Container.from_region() method", "output": "The from_region() method create a container to pack spheres in based on a region. It's used for _container operations." }, { "instruction": "How do you call the from_region() method in the _Container class?", "input": "OpenMC Python API _Container.from_region() method signature", "output": "To call the from_region() method, use: @abstractmethod def from_region(self: Any, region: Any, sphere_radius: Any). It takes 3 parameters." }, { "instruction": "What does the region parameter do in the from_region() method?", "input": "OpenMC Python API _Container.from_region() parameter region", "output": "The region parameter region to create container from.. It should be a openmc.Region value." }, { "instruction": "What does the sphere_radius parameter do in the from_region() method?", "input": "OpenMC Python API _Container.from_region() parameter sphere_radius", "output": "The sphere_radius parameter outer radius of spheres.. It should be a float value." }, { "instruction": "What does the random_point() method do in the _Container class?", "input": "OpenMC Python API _Container.random_point() method", "output": "The random_point() method generate cartesian coordinates of center of a sphere that is contained entirely within the domain with uniform probability. It's used for _container operations." }, { "instruction": "How do you call the random_point() method in the _Container class?", "input": "OpenMC Python API _Container.random_point() method signature", "output": "To call the random_point() method, use: @abstractmethod def random_point(self: Any). It takes 1 parameters." }, { "instruction": "What does the repel_spheres() method do in the _Container class?", "input": "OpenMC Python API _Container.repel_spheres() method", "output": "The repel_spheres() method move spheres p and q apart according to the following transformation (accounting for boundary conditions on domain): r_i^(n+1) = r_i^(n) + 1/2(d_out^(n+1) - d^(n)) r_j^(n+1) = r_j^(n) - 1/2(d_out^(n+1) - d^(n)). It's used for _container operations." }, { "instruction": "How do you call the repel_spheres() method in the _Container class?", "input": "OpenMC Python API _Container.repel_spheres() method signature", "output": "To call the repel_spheres() method, use: @abstractmethod def repel_spheres(self: Any, p: Any, q: Any, d: Any, d_new: Any). It takes 5 parameters." }, { "instruction": "What does the d parameter do in the repel_spheres() method?", "input": "OpenMC Python API _Container.repel_spheres() parameter d", "output": "The d parameter distance between centers of spheres i and j.. It should be a float value." }, { "instruction": "What does the d_new parameter do in the repel_spheres() method?", "input": "OpenMC Python API _Container.repel_spheres() parameter d_new", "output": "The d_new parameter final distance between centers of spheres i and j.. It should be a float value." }, { "instruction": "What is the _RectangularPrism class in OpenMC's Python API?", "input": "OpenMC Python API _RectangularPrism class", "output": "The _RectangularPrism class represents rectangular prism container in which to pack spheres. It provides 14 methods and 0 properties for working with _rectangularprism data in OpenMC." }, { "instruction": "What does the _RectangularPrism class do in OpenMC's Python API?", "input": "OpenMC Python API _RectangularPrism class description", "output": "The _RectangularPrism class rectangular prism container in which to pack spheres. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the width parameter do when creating a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism constructor parameter width", "output": "When creating a _RectangularPrism, the width parameter specifies prism length along the x-axis. It should be a float value." }, { "instruction": "What does the depth parameter do when creating a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism constructor parameter depth", "output": "When creating a _RectangularPrism, the depth parameter specifies prism length along the y-axis. It should be a float value." }, { "instruction": "What does the height parameter do when creating a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism constructor parameter height", "output": "When creating a _RectangularPrism, the height parameter specifies prism length along the z-axis. It should be a float value." }, { "instruction": "What does the sphere_radius parameter do when creating a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism constructor parameter sphere_radius", "output": "When creating a _RectangularPrism, the sphere_radius parameter specifies radius of spheres to be packed in container.. It should be a float value." }, { "instruction": "What does the center parameter do when creating a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism constructor parameter center", "output": "When creating a _RectangularPrism, the center parameter specifies cartesian coordinates of the center of the container. default is (0., 0., 0.). It should be a Iterable of float value." }, { "instruction": "What is the width attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute width", "output": "The width attribute of a _RectangularPrism contains prism length along the x-axis. It's a float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "What is the depth attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute depth", "output": "The depth attribute of a _RectangularPrism contains prism length along the y-axis. It's a float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "What is the height attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute height", "output": "The height attribute of a _RectangularPrism contains prism length along the z-axis. It's a float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "What is the sphere_radius attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute sphere_radius", "output": "The sphere_radius attribute of a _RectangularPrism contains radius of spheres to be packed in container.. It's a float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "What is the center attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute center", "output": "The center attribute of a _RectangularPrism contains cartesian coordinates of the center of the container. default is (0., 0., 0.). It's a list of float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "What is the cell_length attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute cell_length", "output": "The cell_length attribute of a _RectangularPrism contains length in x-, y-, and z- directions of each cell in mesh overlaid on domain.. It's a list of float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "What is the limits attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute limits", "output": "The limits attribute of a _RectangularPrism contains minimum and maximum distance in x-, y-, and z-direction where sphere center can be placed.. It's a list of float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "What is the volume attribute of a _RectangularPrism?", "input": "OpenMC Python API _RectangularPrism attribute volume", "output": "The volume attribute of a _RectangularPrism contains volume of the container.. It's a float value that you can access after creating a _RectangularPrism instance." }, { "instruction": "How do you call the __init__() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, width: Any, depth: Any, height: Any, sphere_radius: Any, center: Any). It takes 6 parameters." }, { "instruction": "How do you call the width() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.width() method signature", "output": "To call the width() method, use: @width.setter def width(self: Any, width: Any). It takes 2 parameters." }, { "instruction": "How do you call the depth() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.depth() method signature", "output": "To call the depth() method, use: @property def depth(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the depth() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.depth() method signature", "output": "To call the depth() method, use: @depth.setter def depth(self: Any, depth: Any). It takes 2 parameters." }, { "instruction": "How do you call the height() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.height() method signature", "output": "To call the height() method, use: @property def height(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the height() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.height() method signature", "output": "To call the height() method, use: @height.setter def height(self: Any, height: Any). It takes 2 parameters." }, { "instruction": "How do you call the limits() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.limits() method signature", "output": "To call the limits() method, use: @property def limits(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the limits() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.limits() method signature", "output": "To call the limits() method, use: @limits.setter def limits(self: Any, limits: Any). It takes 2 parameters." }, { "instruction": "How do you call the cell_length() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.cell_length() method signature", "output": "To call the cell_length() method, use: @property def cell_length(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_region() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.from_region() method signature", "output": "To call the from_region() method, use: @classmethod def from_region(self: Any, region: Any, sphere_radius: Any). It takes 3 parameters." }, { "instruction": "How do you call the random_point() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.random_point() method signature", "output": "To call the random_point() method, use: def random_point(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the repel_spheres() method in the _RectangularPrism class?", "input": "OpenMC Python API _RectangularPrism.repel_spheres() method signature", "output": "To call the repel_spheres() method, use: def repel_spheres(self: Any, p: Any, q: Any, d: Any, d_new: Any). It takes 5 parameters." }, { "instruction": "What is the _Cylinder class in OpenMC's Python API?", "input": "OpenMC Python API _Cylinder class", "output": "The _Cylinder class represents cylindrical container in which to pack spheres. It provides 15 methods and 0 properties for working with _cylinder data in OpenMC." }, { "instruction": "What does the _Cylinder class do in OpenMC's Python API?", "input": "OpenMC Python API _Cylinder class description", "output": "The _Cylinder class cylindrical container in which to pack spheres. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the length parameter do when creating a _Cylinder?", "input": "OpenMC Python API _Cylinder constructor parameter length", "output": "When creating a _Cylinder, the length parameter specifies length of the cylindrical container.. It should be a float value." }, { "instruction": "What does the radius parameter do when creating a _Cylinder?", "input": "OpenMC Python API _Cylinder constructor parameter radius", "output": "When creating a _Cylinder, the radius parameter specifies radius of the cylindrical container.. It should be a float value." }, { "instruction": "What does the axis parameter do when creating a _Cylinder?", "input": "OpenMC Python API _Cylinder constructor parameter axis", "output": "When creating a _Cylinder, the axis parameter specifies axis along which the length of the cylinder is aligned.. It should be a string value." }, { "instruction": "What does the sphere_radius parameter do when creating a _Cylinder?", "input": "OpenMC Python API _Cylinder constructor parameter sphere_radius", "output": "When creating a _Cylinder, the sphere_radius parameter specifies radius of spheres to be packed in container.. It should be a float value." }, { "instruction": "What does the center parameter do when creating a _Cylinder?", "input": "OpenMC Python API _Cylinder constructor parameter center", "output": "When creating a _Cylinder, the center parameter specifies cartesian coordinates of the center of the container. default is (0., 0., 0.). It should be a Iterable of float value." }, { "instruction": "What is the length attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute length", "output": "The length attribute of a _Cylinder contains length of the cylindrical container.. It's a float value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the radius attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute radius", "output": "The radius attribute of a _Cylinder contains radius of the cylindrical container.. It's a float value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the axis attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute axis", "output": "The axis attribute of a _Cylinder contains axis along which the length of the cylinder is aligned.. It's a string value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the sphere_radius attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute sphere_radius", "output": "The sphere_radius attribute of a _Cylinder contains radius of spheres to be packed in container.. It's a float value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the center attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute center", "output": "The center attribute of a _Cylinder contains cartesian coordinates of the center of the container. default is (0., 0., 0.). It's a list of float value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the shift attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute shift", "output": "The shift attribute of a _Cylinder contains rolled indices of the x-, y-, and z- coordinates of a sphere so the configuration is aligned with the correct axis. no shift corresponds to a cylinder along the z-axis.. It's a list of int value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the cell_length attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute cell_length", "output": "The cell_length attribute of a _Cylinder contains length in x-, y-, and z- directions of each cell in mesh overlaid on domain.. It's a list of float value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the limits attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute limits", "output": "The limits attribute of a _Cylinder contains maximum radial distance and minimum and maximum distance in the direction parallel to the axis where sphere center can be placed.. It's a list of float value that you can access after creating a _Cylinder instance." }, { "instruction": "What is the volume attribute of a _Cylinder?", "input": "OpenMC Python API _Cylinder attribute volume", "output": "The volume attribute of a _Cylinder contains volume of the container.. It's a float value that you can access after creating a _Cylinder instance." }, { "instruction": "How do you call the __init__() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, length: Any, radius: Any, axis: Any, sphere_radius: Any, center: Any). It takes 6 parameters." }, { "instruction": "How do you call the length() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.length() method signature", "output": "To call the length() method, use: @property def length(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the length() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.length() method signature", "output": "To call the length() method, use: @length.setter def length(self: Any, length: Any). It takes 2 parameters." }, { "instruction": "How do you call the radius() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.radius() method signature", "output": "To call the radius() method, use: @property def radius(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the radius() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.radius() method signature", "output": "To call the radius() method, use: @radius.setter def radius(self: Any, radius: Any). It takes 2 parameters." }, { "instruction": "How do you call the axis() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.axis() method signature", "output": "To call the axis() method, use: @property def axis(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the axis() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.axis() method signature", "output": "To call the axis() method, use: @axis.setter def axis(self: Any, axis: Any). It takes 2 parameters." }, { "instruction": "How do you call the shift() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.shift() method signature", "output": "To call the shift() method, use: @property def shift(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the limits() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.limits() method signature", "output": "To call the limits() method, use: @property def limits(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the limits() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.limits() method signature", "output": "To call the limits() method, use: @limits.setter def limits(self: Any, limits: Any). It takes 2 parameters." }, { "instruction": "How do you call the cell_length() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.cell_length() method signature", "output": "To call the cell_length() method, use: @property def cell_length(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_region() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.from_region() method signature", "output": "To call the from_region() method, use: @classmethod def from_region(self: Any, region: Any, sphere_radius: Any). It takes 3 parameters." }, { "instruction": "How do you call the random_point() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.random_point() method signature", "output": "To call the random_point() method, use: def random_point(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the repel_spheres() method in the _Cylinder class?", "input": "OpenMC Python API _Cylinder.repel_spheres() method signature", "output": "To call the repel_spheres() method, use: def repel_spheres(self: Any, p: Any, q: Any, d: Any, d_new: Any). It takes 5 parameters." }, { "instruction": "What is the _SphericalShell class in OpenMC's Python API?", "input": "OpenMC Python API _SphericalShell class", "output": "The _SphericalShell class represents spherical shell container in which to pack spheres. It provides 12 methods and 0 properties for working with _sphericalshell data in OpenMC." }, { "instruction": "What does the _SphericalShell class do in OpenMC's Python API?", "input": "OpenMC Python API _SphericalShell class description", "output": "The _SphericalShell class spherical shell container in which to pack spheres. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the radius parameter do when creating a _SphericalShell?", "input": "OpenMC Python API _SphericalShell constructor parameter radius", "output": "When creating a _SphericalShell, the radius parameter specifies outer radius of the spherical shell container.. It should be a float value." }, { "instruction": "What does the inner_radius parameter do when creating a _SphericalShell?", "input": "OpenMC Python API _SphericalShell constructor parameter inner_radius", "output": "When creating a _SphericalShell, the inner_radius parameter specifies inner radius of the spherical shell container.. It should be a float value." }, { "instruction": "What does the center parameter do when creating a _SphericalShell?", "input": "OpenMC Python API _SphericalShell constructor parameter center", "output": "When creating a _SphericalShell, the center parameter specifies cartesian coordinates of the center of the container. default is (0., 0., 0.). It should be a Iterable of float value." }, { "instruction": "What is the radius attribute of a _SphericalShell?", "input": "OpenMC Python API _SphericalShell attribute radius", "output": "The radius attribute of a _SphericalShell contains outer radius of the spherical shell container.. It's a float value that you can access after creating a _SphericalShell instance." }, { "instruction": "What is the inner_radius attribute of a _SphericalShell?", "input": "OpenMC Python API _SphericalShell attribute inner_radius", "output": "The inner_radius attribute of a _SphericalShell contains inner radius of the spherical shell container.. It's a float value that you can access after creating a _SphericalShell instance." }, { "instruction": "What is the sphere_radius attribute of a _SphericalShell?", "input": "OpenMC Python API _SphericalShell attribute sphere_radius", "output": "The sphere_radius attribute of a _SphericalShell contains radius of spheres to be packed in container.. It's a float value that you can access after creating a _SphericalShell instance." }, { "instruction": "What is the center attribute of a _SphericalShell?", "input": "OpenMC Python API _SphericalShell attribute center", "output": "The center attribute of a _SphericalShell contains cartesian coordinates of the center of the container. default is (0., 0., 0.). It's a list of float value that you can access after creating a _SphericalShell instance." }, { "instruction": "What is the cell_length attribute of a _SphericalShell?", "input": "OpenMC Python API _SphericalShell attribute cell_length", "output": "The cell_length attribute of a _SphericalShell contains length in x-, y-, and z- directions of each cell in mesh overlaid on domain.. It's a list of float value that you can access after creating a _SphericalShell instance." }, { "instruction": "What is the limits attribute of a _SphericalShell?", "input": "OpenMC Python API _SphericalShell attribute limits", "output": "The limits attribute of a _SphericalShell contains minimum and maximum radial distance where sphere center can be placed.. It's a list of float value that you can access after creating a _SphericalShell instance." }, { "instruction": "What is the volume attribute of a _SphericalShell?", "input": "OpenMC Python API _SphericalShell attribute volume", "output": "The volume attribute of a _SphericalShell contains volume of the container.. It's a float value that you can access after creating a _SphericalShell instance." }, { "instruction": "How do you call the __init__() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, radius: Any, inner_radius: Any, sphere_radius: Any, center: Any). It takes 5 parameters." }, { "instruction": "How do you call the radius() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.radius() method signature", "output": "To call the radius() method, use: @property def radius(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the radius() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.radius() method signature", "output": "To call the radius() method, use: @radius.setter def radius(self: Any, radius: Any). It takes 2 parameters." }, { "instruction": "How do you call the inner_radius() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.inner_radius() method signature", "output": "To call the inner_radius() method, use: @property def inner_radius(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the inner_radius() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.inner_radius() method signature", "output": "To call the inner_radius() method, use: @inner_radius.setter def inner_radius(self: Any, inner_radius: Any). It takes 2 parameters." }, { "instruction": "How do you call the limits() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.limits() method signature", "output": "To call the limits() method, use: @property def limits(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the limits() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.limits() method signature", "output": "To call the limits() method, use: @limits.setter def limits(self: Any, limits: Any). It takes 2 parameters." }, { "instruction": "How do you call the cell_length() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.cell_length() method signature", "output": "To call the cell_length() method, use: @property def cell_length(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_region() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.from_region() method signature", "output": "To call the from_region() method, use: @classmethod def from_region(self: Any, region: Any, sphere_radius: Any). It takes 3 parameters." }, { "instruction": "How do you call the random_point() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.random_point() method signature", "output": "To call the random_point() method, use: def random_point(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the repel_spheres() method in the _SphericalShell class?", "input": "OpenMC Python API _SphericalShell.repel_spheres() method signature", "output": "To call the repel_spheres() method, use: def repel_spheres(self: Any, p: Any, q: Any, d: Any, d_new: Any). It takes 5 parameters." }, { "instruction": "What does the _volume_sphere() function do in OpenMC's Python API?", "input": "OpenMC Python API _volume_sphere() function", "output": "The _volume_sphere() function return volume of a sphere of radius r. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _volume_sphere() function in OpenMC's Python API?", "input": "OpenMC Python API _volume_sphere() function purpose", "output": "The _volume_sphere() function return volume of a sphere of radius r. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _volume_sphere() function in OpenMC's Python API?", "input": "OpenMC Python API _volume_sphere() function signature", "output": "To call the _volume_sphere() function, use: def _volume_sphere(r: Any). It takes 1 parameters." }, { "instruction": "What does the create_triso_lattice() function do in OpenMC's Python API?", "input": "OpenMC Python API create_triso_lattice() function", "output": "The create_triso_lattice() function create a lattice containing triso particles for optimized tracking. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the create_triso_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API create_triso_lattice() function purpose", "output": "The create_triso_lattice() function create a lattice containing triso particles for optimized tracking. It's part of OpenMC's Python API." }, { "instruction": "How do you call the create_triso_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API create_triso_lattice() function signature", "output": "To call the create_triso_lattice() function, use: def create_triso_lattice(trisos: Any, lower_left: Any, pitch: Any, shape: Any, background: Any). It takes 5 parameters." }, { "instruction": "What does the trisos parameter do in the create_triso_lattice() function?", "input": "OpenMC Python API create_triso_lattice() parameter trisos", "output": "The trisos parameter list of triso particles to put in lattice. It should be a list of openmc.model.TRISO value." }, { "instruction": "What does the lower_left parameter do in the create_triso_lattice() function?", "input": "OpenMC Python API create_triso_lattice() parameter lower_left", "output": "The lower_left parameter lower-left cartesian coordinates of the lattice. It should be a Iterable of float value." }, { "instruction": "What does the pitch parameter do in the create_triso_lattice() function?", "input": "OpenMC Python API create_triso_lattice() parameter pitch", "output": "The pitch parameter pitch of the lattice elements in the x-, y-, and z-directions. It should be a Iterable of float value." }, { "instruction": "What does the shape parameter do in the create_triso_lattice() function?", "input": "OpenMC Python API create_triso_lattice() parameter shape", "output": "The shape parameter number of lattice elements in the x-, y-, and z-directions. It should be a Iterable of float value." }, { "instruction": "What does the background parameter do in the create_triso_lattice() function?", "input": "OpenMC Python API create_triso_lattice() parameter background", "output": "The background parameter a background material that is used anywhere within the lattice but outside a triso particle. It should be a openmc.Material value." }, { "instruction": "What does the create_triso_lattice() function return in OpenMC's Python API?", "input": "OpenMC Python API create_triso_lattice() return value", "output": "The create_triso_lattice() function returns a lattice containing the triso particles. The return type is openmc.RectLattice." }, { "instruction": "What does the _random_sequential_pack() function do in OpenMC's Python API?", "input": "OpenMC Python API _random_sequential_pack() function", "output": "The _random_sequential_pack() function random sequential packing of spheres within a container. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _random_sequential_pack() function in OpenMC's Python API?", "input": "OpenMC Python API _random_sequential_pack() function purpose", "output": "The _random_sequential_pack() function random sequential packing of spheres within a container. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _random_sequential_pack() function in OpenMC's Python API?", "input": "OpenMC Python API _random_sequential_pack() function signature", "output": "To call the _random_sequential_pack() function, use: def _random_sequential_pack(domain: Any, num_spheres: Any). It takes 2 parameters." }, { "instruction": "What does the domain parameter do in the _random_sequential_pack() function?", "input": "OpenMC Python API _random_sequential_pack() parameter domain", "output": "The domain parameter container in which to pack spheres.. It should be a openmc.model._Container value." }, { "instruction": "What does the num_spheres parameter do in the _random_sequential_pack() function?", "input": "OpenMC Python API _random_sequential_pack() parameter num_spheres", "output": "The num_spheres parameter number of spheres to pack.. It should be a int value." }, { "instruction": "What does the _close_random_pack() function do in OpenMC's Python API?", "input": "OpenMC Python API _close_random_pack() function", "output": "The _close_random_pack() function close random packing of spheres using the jodrey-tory algorithm. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _close_random_pack() function in OpenMC's Python API?", "input": "OpenMC Python API _close_random_pack() function purpose", "output": "The _close_random_pack() function close random packing of spheres using the jodrey-tory algorithm. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _close_random_pack() function in OpenMC's Python API?", "input": "OpenMC Python API _close_random_pack() function signature", "output": "To call the _close_random_pack() function, use: def _close_random_pack(domain: Any, spheres: Any, contraction_rate: Any). It takes 3 parameters." }, { "instruction": "What does the domain parameter do in the _close_random_pack() function?", "input": "OpenMC Python API _close_random_pack() parameter domain", "output": "The domain parameter container in which to pack spheres.. It should be a openmc.model._Container value." }, { "instruction": "What does the spheres parameter do in the _close_random_pack() function?", "input": "OpenMC Python API _close_random_pack() parameter spheres", "output": "The spheres parameter initial cartesian coordinates of centers of spheres.. It should be a numpy.ndarray value." }, { "instruction": "What does the contraction_rate parameter do in the _close_random_pack() function?", "input": "OpenMC Python API _close_random_pack() parameter contraction_rate", "output": "The contraction_rate parameter contraction rate of outer diameter.. It should be a float value." }, { "instruction": "What does the pack_spheres() function do in OpenMC's Python API?", "input": "OpenMC Python API pack_spheres() function", "output": "The pack_spheres() function generate a random, non-overlapping configuration of spheres within a container. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the pack_spheres() function in OpenMC's Python API?", "input": "OpenMC Python API pack_spheres() function purpose", "output": "The pack_spheres() function generate a random, non-overlapping configuration of spheres within a container. It's part of OpenMC's Python API." }, { "instruction": "How do you call the pack_spheres() function in OpenMC's Python API?", "input": "OpenMC Python API pack_spheres() function signature", "output": "To call the pack_spheres() function, use: def pack_spheres(radius: Any, region: Any, pf: Any, num_spheres: Any, initial_pf: Any, contraction_rate: Any, seed: Any). It takes 7 parameters." }, { "instruction": "What does the radius parameter do in the pack_spheres() function?", "input": "OpenMC Python API pack_spheres() parameter radius", "output": "The radius parameter outer radius of spheres.. It should be a float value." }, { "instruction": "What does the region parameter do in the pack_spheres() function?", "input": "OpenMC Python API pack_spheres() parameter region", "output": "The region parameter container in which the spheres are packed. supported shapes are rectangular prism, cylinder, sphere, and spherical shell.. It should be a openmc.Region value." }, { "instruction": "What does the pf parameter do in the pack_spheres() function?", "input": "OpenMC Python API pack_spheres() parameter pf", "output": "The pf parameter packing fraction of the spheres. one of 'pf' and 'num_spheres' must be specified; the other will be calculated. if both are specified, 'pf' takes precedence over 'num_spheres'.. It should be a float value." }, { "instruction": "What does the num_spheres parameter do in the pack_spheres() function?", "input": "OpenMC Python API pack_spheres() parameter num_spheres", "output": "The num_spheres parameter number of spheres to pack in the domain. one of 'num_spheres' and 'pf' must be specified; the other will be calculated.. It should be a int value." }, { "instruction": "What does the initial_pf parameter do in the pack_spheres() function?", "input": "OpenMC Python API pack_spheres() parameter initial_pf", "output": "The initial_pf parameter packing fraction used to initialize the configuration of spheres in the domain. default value is 0.3. it is not recommended to set the initial packing fraction much higher than 0.3 as the random sequential packing algorithm becomes prohibitively slow as it approaches its limit (~0.38).. It should be a float, optional value." }, { "instruction": "What does the contraction_rate parameter do in the pack_spheres() function?", "input": "OpenMC Python API pack_spheres() parameter contraction_rate", "output": "The contraction_rate parameter contraction rate of the outer diameter. higher packing fractions can be reached using a smaller contraction rate, but the algorithm will take longer to converge.. It should be a float, optional value." }, { "instruction": "What does the seed parameter do in the pack_spheres() function?", "input": "OpenMC Python API pack_spheres() parameter seed", "output": "The seed parameter pseudorandom number generator seed passed to :func:`random.seed`. It should be a int, optional value." }, { "instruction": "What does the add_rod() function do in OpenMC's Python API?", "input": "OpenMC Python API add_rod() function", "output": "The add_rod() function add a new rod to the priority queue. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the add_rod() function in OpenMC's Python API?", "input": "OpenMC Python API add_rod() function purpose", "output": "The add_rod() function add a new rod to the priority queue. It's part of OpenMC's Python API." }, { "instruction": "How do you call the add_rod() function in OpenMC's Python API?", "input": "OpenMC Python API add_rod() function signature", "output": "To call the add_rod() function, use: def add_rod(d: Any, i: Any, j: Any). It takes 3 parameters." }, { "instruction": "What does the d parameter do in the add_rod() function?", "input": "OpenMC Python API add_rod() parameter d", "output": "The d parameter distance between centers of spheres i and j. i, j : int index of spheres in spheres array.. It should be a float value." }, { "instruction": "What does the remove_rod() function do in OpenMC's Python API?", "input": "OpenMC Python API remove_rod() function", "output": "The remove_rod() function mark the rod containing sphere i as removed. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the remove_rod() function in OpenMC's Python API?", "input": "OpenMC Python API remove_rod() function purpose", "output": "The remove_rod() function mark the rod containing sphere i as removed. It's part of OpenMC's Python API." }, { "instruction": "How do you call the remove_rod() function in OpenMC's Python API?", "input": "OpenMC Python API remove_rod() function signature", "output": "To call the remove_rod() function, use: def remove_rod(i: Any). It takes 1 parameters." }, { "instruction": "What does the i parameter do in the remove_rod() function?", "input": "OpenMC Python API remove_rod() parameter i", "output": "The i parameter index of sphere in spheres array.. It should be a int value." }, { "instruction": "What does the pop_rod() function do in OpenMC's Python API?", "input": "OpenMC Python API pop_rod() function", "output": "The pop_rod() function remove and return the shortest rod. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the pop_rod() function in OpenMC's Python API?", "input": "OpenMC Python API pop_rod() function purpose", "output": "The pop_rod() function remove and return the shortest rod. It's part of OpenMC's Python API." }, { "instruction": "How do you call the pop_rod() function in OpenMC's Python API?", "input": "OpenMC Python API pop_rod() function signature", "output": "To call the pop_rod() function, use: def pop_rod(). It takes 0 parameters." }, { "instruction": "What does the pop_rod() function return in OpenMC's Python API?", "input": "OpenMC Python API pop_rod() return value", "output": "The pop_rod() function returns distance between centers of spheres i and j. i, j : int index of spheres in spheres array.. The return type is float." }, { "instruction": "What does the create_rod_list() function do in OpenMC's Python API?", "input": "OpenMC Python API create_rod_list() function", "output": "The create_rod_list() function generate sorted list of rods (distances between sphere centers).\n\n rods are arranged in a heap where each element contains the rod length\n and the sphere indices. a rod between spheres p and q is only\n included if the distance between p and q could not be changed by the\n elimination of a greater overlap, i.e. q has no nearer neighbors than p.\n\n a mapping of sphere ids to rods is maintained in 'rods_map'. each key\n in the dict is the id of a sphere that is in the rod list, and the\n value is the id of its nearest neighbor and the rod that contains them.\n the dict is used to find rods in the priority queue and to mark removed\n rods so rods can be \"removed\" without breaking the heap structure\n invariant.. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the create_rod_list() function in OpenMC's Python API?", "input": "OpenMC Python API create_rod_list() function purpose", "output": "The create_rod_list() function generate sorted list of rods (distances between sphere centers).\n\n rods are arranged in a heap where each element contains the rod length\n and the sphere indices. a rod between spheres p and q is only\n included if the distance between p and q could not be changed by the\n elimination of a greater overlap, i.e. q has no nearer neighbors than p.\n\n a mapping of sphere ids to rods is maintained in 'rods_map'. each key\n in the dict is the id of a sphere that is in the rod list, and the\n value is the id of its nearest neighbor and the rod that contains them.\n the dict is used to find rods in the priority queue and to mark removed\n rods so rods can be \"removed\" without breaking the heap structure\n invariant.. It's part of OpenMC's Python API." }, { "instruction": "How do you call the create_rod_list() function in OpenMC's Python API?", "input": "OpenMC Python API create_rod_list() function signature", "output": "To call the create_rod_list() function, use: def create_rod_list(). It takes 0 parameters." }, { "instruction": "What does the update_mesh() function do in OpenMC's Python API?", "input": "OpenMC Python API update_mesh() function", "output": "The update_mesh() function update which mesh cells the sphere is in based on new sphere center coordinates. 'mesh'/'mesh_map' is a two way dictionary used to look up which spheres are located within one diameter of a given mesh cell and which mesh cells a given sphere center is within one diameter of. this is used to speed up the nearest neighbor search. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the update_mesh() function in OpenMC's Python API?", "input": "OpenMC Python API update_mesh() function purpose", "output": "The update_mesh() function update which mesh cells the sphere is in based on new sphere center coordinates. 'mesh'/'mesh_map' is a two way dictionary used to look up which spheres are located within one diameter of a given mesh cell and which mesh cells a given sphere center is within one diameter of. this is used to speed up the nearest neighbor search. It's part of OpenMC's Python API." }, { "instruction": "How do you call the update_mesh() function in OpenMC's Python API?", "input": "OpenMC Python API update_mesh() function signature", "output": "To call the update_mesh() function, use: def update_mesh(i: Any). It takes 1 parameters." }, { "instruction": "What does the i parameter do in the update_mesh() function?", "input": "OpenMC Python API update_mesh() parameter i", "output": "The i parameter index of sphere in spheres array.. It should be a int value." }, { "instruction": "What does the reduce_outer_diameter() function do in OpenMC's Python API?", "input": "OpenMC Python API reduce_outer_diameter() function", "output": "The reduce_outer_diameter() function reduce the outer diameter so that at the (i+1)-st iteration it is: d_out^(i+1) = d_out^(i) - (1/2)^(j) * d_out0 * k / n, where k is the contraction rate, n is the number of spheres, and j = floor(-log10(pf_out - pf_in)). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the reduce_outer_diameter() function in OpenMC's Python API?", "input": "OpenMC Python API reduce_outer_diameter() function purpose", "output": "The reduce_outer_diameter() function reduce the outer diameter so that at the (i+1)-st iteration it is: d_out^(i+1) = d_out^(i) - (1/2)^(j) * d_out0 * k / n, where k is the contraction rate, n is the number of spheres, and j = floor(-log10(pf_out - pf_in)). It's part of OpenMC's Python API." }, { "instruction": "How do you call the reduce_outer_diameter() function in OpenMC's Python API?", "input": "OpenMC Python API reduce_outer_diameter() function signature", "output": "To call the reduce_outer_diameter() function, use: def reduce_outer_diameter(). It takes 0 parameters." }, { "instruction": "What does the nearest() function do in OpenMC's Python API?", "input": "OpenMC Python API nearest() function", "output": "The nearest() function find index of nearest neighbor of sphere i. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the nearest() function in OpenMC's Python API?", "input": "OpenMC Python API nearest() function purpose", "output": "The nearest() function find index of nearest neighbor of sphere i. It's part of OpenMC's Python API." }, { "instruction": "How do you call the nearest() function in OpenMC's Python API?", "input": "OpenMC Python API nearest() function signature", "output": "To call the nearest() function, use: def nearest(i: Any). It takes 1 parameters." }, { "instruction": "What does the i parameter do in the nearest() function?", "input": "OpenMC Python API nearest() parameter i", "output": "The i parameter index in spheres array of sphere for which to find nearest neighbor.. It should be a int value." }, { "instruction": "What does the update_rod_list() function do in OpenMC's Python API?", "input": "OpenMC Python API update_rod_list() function", "output": "The update_rod_list() function update the rod list with the new nearest neighbors of sphere since its overlap was eliminated. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the update_rod_list() function in OpenMC's Python API?", "input": "OpenMC Python API update_rod_list() function purpose", "output": "The update_rod_list() function update the rod list with the new nearest neighbors of sphere since its overlap was eliminated. It's part of OpenMC's Python API." }, { "instruction": "How do you call the update_rod_list() function in OpenMC's Python API?", "input": "OpenMC Python API update_rod_list() function signature", "output": "To call the update_rod_list() function, use: def update_rod_list(i: Any). It takes 1 parameters." }, { "instruction": "What does the i parameter do in the update_rod_list() function?", "input": "OpenMC Python API update_rod_list() parameter i", "output": "The i parameter index of sphere in spheres array.. It should be a int value." }, { "instruction": "What is the Nuclide class in OpenMC's Python API?", "input": "OpenMC Python API Nuclide class", "output": "The Nuclide class represents a nuclide that can be used in a material. It provides 2 methods and 0 properties for working with nuclide data in OpenMC." }, { "instruction": "What does the Nuclide class do in OpenMC's Python API?", "input": "OpenMC Python API Nuclide class description", "output": "The Nuclide class a nuclide that can be used in a material. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the name parameter do when creating a Nuclide?", "input": "OpenMC Python API Nuclide constructor parameter name", "output": "When creating a Nuclide, the name parameter specifies name of the nuclide, e.g. 'u235'. It should be a str value." }, { "instruction": "What is the name attribute of a Nuclide?", "input": "OpenMC Python API Nuclide attribute name", "output": "The name attribute of a Nuclide contains name of the nuclide, e.g. 'u235'. It's a str value that you can access after creating a Nuclide instance." }, { "instruction": "How do you call the __new__() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.__new__() method signature", "output": "To call the __new__() method, use: def __new__(cls: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the name() method in the Nuclide class?", "input": "OpenMC Python API Nuclide.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_openmoc_material() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_material() function", "output": "The get_openmoc_material() function return an openmoc material corresponding to an openmc material. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmoc_material() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_material() function purpose", "output": "The get_openmoc_material() function return an openmoc material corresponding to an openmc material. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmoc_material() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_material() function signature", "output": "To call the get_openmoc_material() function, use: def get_openmoc_material(openmc_material: Any). It takes 1 parameters." }, { "instruction": "What does the openmc_material parameter do in the get_openmoc_material() function?", "input": "OpenMC Python API get_openmoc_material() parameter openmc_material", "output": "The openmc_material parameter openmc material. It should be a openmc.Material value." }, { "instruction": "What does the get_openmoc_material() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_material() return value", "output": "The get_openmoc_material() function returns equivalent openmoc material. The return type is openmoc.Material." }, { "instruction": "What does the get_openmc_material() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_material() function", "output": "The get_openmc_material() function return an openmc material corresponding to an openmoc material. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmc_material() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_material() function purpose", "output": "The get_openmc_material() function return an openmc material corresponding to an openmoc material. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmc_material() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_material() function signature", "output": "To call the get_openmc_material() function, use: def get_openmc_material(openmoc_material: Any). It takes 1 parameters." }, { "instruction": "What does the openmoc_material parameter do in the get_openmc_material() function?", "input": "OpenMC Python API get_openmc_material() parameter openmoc_material", "output": "The openmoc_material parameter openmoc material. It should be a openmoc.Material value." }, { "instruction": "What does the get_openmc_material() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_material() return value", "output": "The get_openmc_material() function returns equivalent openmc material. The return type is openmc.Material." }, { "instruction": "What does the get_openmoc_surface() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_surface() function", "output": "The get_openmoc_surface() function return an openmoc surface corresponding to an openmc surface. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmoc_surface() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_surface() function purpose", "output": "The get_openmoc_surface() function return an openmoc surface corresponding to an openmc surface. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmoc_surface() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_surface() function signature", "output": "To call the get_openmoc_surface() function, use: def get_openmoc_surface(openmc_surface: Any). It takes 1 parameters." }, { "instruction": "What does the openmc_surface parameter do in the get_openmoc_surface() function?", "input": "OpenMC Python API get_openmoc_surface() parameter openmc_surface", "output": "The openmc_surface parameter openmc surface. It should be a openmc.Surface value." }, { "instruction": "What does the get_openmoc_surface() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_surface() return value", "output": "The get_openmoc_surface() function returns equivalent openmoc surface. The return type is openmoc.Surface." }, { "instruction": "What does the get_openmc_surface() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_surface() function", "output": "The get_openmc_surface() function return an openmc surface corresponding to an openmoc surface. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmc_surface() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_surface() function purpose", "output": "The get_openmc_surface() function return an openmc surface corresponding to an openmoc surface. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmc_surface() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_surface() function signature", "output": "To call the get_openmc_surface() function, use: def get_openmc_surface(openmoc_surface: Any). It takes 1 parameters." }, { "instruction": "What does the openmoc_surface parameter do in the get_openmc_surface() function?", "input": "OpenMC Python API get_openmc_surface() parameter openmoc_surface", "output": "The openmoc_surface parameter openmoc surface. It should be a openmoc.Surface value." }, { "instruction": "What does the get_openmc_surface() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_surface() return value", "output": "The get_openmc_surface() function returns equivalent openmc surface. The return type is openmc.Surface." }, { "instruction": "What does the get_openmoc_cell() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_cell() function", "output": "The get_openmoc_cell() function return an openmoc cell corresponding to an openmc cell. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmoc_cell() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_cell() function purpose", "output": "The get_openmoc_cell() function return an openmoc cell corresponding to an openmc cell. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmoc_cell() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_cell() function signature", "output": "To call the get_openmoc_cell() function, use: def get_openmoc_cell(openmc_cell: Any). It takes 1 parameters." }, { "instruction": "What does the openmc_cell parameter do in the get_openmoc_cell() function?", "input": "OpenMC Python API get_openmoc_cell() parameter openmc_cell", "output": "The openmc_cell parameter openmc cell. It should be a openmc.Cell value." }, { "instruction": "What does the get_openmoc_cell() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_cell() return value", "output": "The get_openmoc_cell() function returns equivalent openmoc cell. The return type is openmoc.Cell." }, { "instruction": "What does the get_openmoc_region() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_region() function", "output": "The get_openmoc_region() function return an openmoc region corresponding to an openmc region. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmoc_region() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_region() function purpose", "output": "The get_openmoc_region() function return an openmoc region corresponding to an openmc region. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmoc_region() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_region() function signature", "output": "To call the get_openmoc_region() function, use: def get_openmoc_region(openmc_region: Any). It takes 1 parameters." }, { "instruction": "What does the openmc_region parameter do in the get_openmoc_region() function?", "input": "OpenMC Python API get_openmoc_region() parameter openmc_region", "output": "The openmc_region parameter openmc region. It should be a openmc.Region value." }, { "instruction": "What does the get_openmoc_region() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_region() return value", "output": "The get_openmoc_region() function returns equivalent openmoc region. The return type is openmoc.Region." }, { "instruction": "What does the get_openmc_region() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_region() function", "output": "The get_openmc_region() function return an openmc region corresponding to an openmoc region. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmc_region() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_region() function purpose", "output": "The get_openmc_region() function return an openmc region corresponding to an openmoc region. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmc_region() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_region() function signature", "output": "To call the get_openmc_region() function, use: def get_openmc_region(openmoc_region: Any). It takes 1 parameters." }, { "instruction": "What does the openmoc_region parameter do in the get_openmc_region() function?", "input": "OpenMC Python API get_openmc_region() parameter openmoc_region", "output": "The openmoc_region parameter openmoc region. It should be a openmoc.Region value." }, { "instruction": "What does the get_openmc_region() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_region() return value", "output": "The get_openmc_region() function returns equivalent openmc region. The return type is openmc.Region." }, { "instruction": "What does the get_openmc_cell() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_cell() function", "output": "The get_openmc_cell() function return an openmc cell corresponding to an openmoc cell. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmc_cell() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_cell() function purpose", "output": "The get_openmc_cell() function return an openmc cell corresponding to an openmoc cell. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmc_cell() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_cell() function signature", "output": "To call the get_openmc_cell() function, use: def get_openmc_cell(openmoc_cell: Any). It takes 1 parameters." }, { "instruction": "What does the openmoc_cell parameter do in the get_openmc_cell() function?", "input": "OpenMC Python API get_openmc_cell() parameter openmoc_cell", "output": "The openmoc_cell parameter openmoc cell. It should be a openmoc.Cell value." }, { "instruction": "What does the get_openmc_cell() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_cell() return value", "output": "The get_openmc_cell() function returns equivalent openmc cell. The return type is openmc.Cell." }, { "instruction": "What does the get_openmoc_universe() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_universe() function", "output": "The get_openmoc_universe() function return an openmoc universe corresponding to an openmc universe. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmoc_universe() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_universe() function purpose", "output": "The get_openmoc_universe() function return an openmoc universe corresponding to an openmc universe. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmoc_universe() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_universe() function signature", "output": "To call the get_openmoc_universe() function, use: def get_openmoc_universe(openmc_universe: Any). It takes 1 parameters." }, { "instruction": "What does the openmc_universe parameter do in the get_openmoc_universe() function?", "input": "OpenMC Python API get_openmoc_universe() parameter openmc_universe", "output": "The openmc_universe parameter openmc universe. It should be a openmc.Universe value." }, { "instruction": "What does the get_openmoc_universe() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_universe() return value", "output": "The get_openmoc_universe() function returns equivalent openmoc universe. The return type is openmoc.Universe." }, { "instruction": "What does the get_openmc_universe() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_universe() function", "output": "The get_openmc_universe() function return an openmc universe corresponding to an openmoc universe. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmc_universe() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_universe() function purpose", "output": "The get_openmc_universe() function return an openmc universe corresponding to an openmoc universe. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmc_universe() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_universe() function signature", "output": "To call the get_openmc_universe() function, use: def get_openmc_universe(openmoc_universe: Any). It takes 1 parameters." }, { "instruction": "What does the openmoc_universe parameter do in the get_openmc_universe() function?", "input": "OpenMC Python API get_openmc_universe() parameter openmoc_universe", "output": "The openmoc_universe parameter openmoc universe. It should be a openmoc.Universe value." }, { "instruction": "What does the get_openmc_universe() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_universe() return value", "output": "The get_openmc_universe() function returns equivalent openmc universe. The return type is openmc.Universe." }, { "instruction": "What does the get_openmoc_lattice() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_lattice() function", "output": "The get_openmoc_lattice() function return an openmoc lattice corresponding to an openmoc lattice. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmoc_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_lattice() function purpose", "output": "The get_openmoc_lattice() function return an openmoc lattice corresponding to an openmoc lattice. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmoc_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_lattice() function signature", "output": "To call the get_openmoc_lattice() function, use: def get_openmoc_lattice(openmc_lattice: Any). It takes 1 parameters." }, { "instruction": "What does the openmc_lattice parameter do in the get_openmoc_lattice() function?", "input": "OpenMC Python API get_openmoc_lattice() parameter openmc_lattice", "output": "The openmc_lattice parameter openmc lattice. It should be a openmc.RectLattice value." }, { "instruction": "What does the get_openmoc_lattice() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_lattice() return value", "output": "The get_openmoc_lattice() function returns equivalent openmoc lattice. The return type is openmoc.Lattice." }, { "instruction": "What does the get_openmc_lattice() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_lattice() function", "output": "The get_openmc_lattice() function return an openmc lattice corresponding to an openmoc lattice. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmc_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_lattice() function purpose", "output": "The get_openmc_lattice() function return an openmc lattice corresponding to an openmoc lattice. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmc_lattice() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_lattice() function signature", "output": "To call the get_openmc_lattice() function, use: def get_openmc_lattice(openmoc_lattice: Any). It takes 1 parameters." }, { "instruction": "What does the openmoc_lattice parameter do in the get_openmc_lattice() function?", "input": "OpenMC Python API get_openmc_lattice() parameter openmoc_lattice", "output": "The openmoc_lattice parameter openmoc lattice. It should be a openmoc.Lattice value." }, { "instruction": "What does the get_openmc_lattice() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_lattice() return value", "output": "The get_openmc_lattice() function returns equivalent openmc lattice. The return type is openmc.RectLattice." }, { "instruction": "What does the get_openmoc_geometry() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_geometry() function", "output": "The get_openmoc_geometry() function return an openmc geometry corresponding to an openmoc geometry. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmoc_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_geometry() function purpose", "output": "The get_openmoc_geometry() function return an openmc geometry corresponding to an openmoc geometry. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmoc_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_geometry() function signature", "output": "To call the get_openmoc_geometry() function, use: def get_openmoc_geometry(openmc_geometry: Any). It takes 1 parameters." }, { "instruction": "What does the openmc_geometry parameter do in the get_openmoc_geometry() function?", "input": "OpenMC Python API get_openmoc_geometry() parameter openmc_geometry", "output": "The openmc_geometry parameter openmc geometry. It should be a openmc.Geometry value." }, { "instruction": "What does the get_openmoc_geometry() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmoc_geometry() return value", "output": "The get_openmoc_geometry() function returns equivalent openmoc geometry. The return type is openmoc.Geometry." }, { "instruction": "What does the get_openmc_geometry() function do in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_geometry() function", "output": "The get_openmc_geometry() function return an openmc geometry corresponding to an openmoc geometry. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_openmc_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_geometry() function purpose", "output": "The get_openmc_geometry() function return an openmc geometry corresponding to an openmoc geometry. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_openmc_geometry() function in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_geometry() function signature", "output": "To call the get_openmc_geometry() function, use: def get_openmc_geometry(openmoc_geometry: Any). It takes 1 parameters." }, { "instruction": "What does the openmoc_geometry parameter do in the get_openmc_geometry() function?", "input": "OpenMC Python API get_openmc_geometry() parameter openmoc_geometry", "output": "The openmoc_geometry parameter openmoc geometry. It should be a openmoc.Geometry value." }, { "instruction": "What does the get_openmc_geometry() function return in OpenMC's Python API?", "input": "OpenMC Python API get_openmc_geometry() return value", "output": "The get_openmc_geometry() function returns equivalent openmc geometry. The return type is openmc.Geometry." }, { "instruction": "What is the Particle class in OpenMC's Python API?", "input": "OpenMC Python API Particle class", "output": "The Particle class represents information used to restart a specific particle that caused a simulation to fail. It provides 1 methods and 0 properties for working with particle data in OpenMC." }, { "instruction": "What does the Particle class do in OpenMC's Python API?", "input": "OpenMC Python API Particle class description", "output": "The Particle class information used to restart a specific particle that caused a simulation to fail. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filename parameter do when creating a Particle?", "input": "OpenMC Python API Particle constructor parameter filename", "output": "When creating a Particle, the filename parameter specifies path to the particle restart file. It should be a str value." }, { "instruction": "What is the current_batch attribute of a Particle?", "input": "OpenMC Python API Particle attribute current_batch", "output": "The current_batch attribute of a Particle contains the batch containing the particle. It's a int value that you can access after creating a Particle instance." }, { "instruction": "What is the generations_per_batch attribute of a Particle?", "input": "OpenMC Python API Particle attribute generations_per_batch", "output": "The generations_per_batch attribute of a Particle contains number of generations per batch. It's a int value that you can access after creating a Particle instance." }, { "instruction": "What is the current_generation attribute of a Particle?", "input": "OpenMC Python API Particle attribute current_generation", "output": "The current_generation attribute of a Particle contains the generation containing the particle. It's a int value that you can access after creating a Particle instance." }, { "instruction": "What is the n_particles attribute of a Particle?", "input": "OpenMC Python API Particle attribute n_particles", "output": "The n_particles attribute of a Particle contains number of particles per generation. It's a int value that you can access after creating a Particle instance." }, { "instruction": "What is the run_mode attribute of a Particle?", "input": "OpenMC Python API Particle attribute run_mode", "output": "The run_mode attribute of a Particle contains type of simulation (criticality or fixed source). It's a int value that you can access after creating a Particle instance." }, { "instruction": "What is the id attribute of a Particle?", "input": "OpenMC Python API Particle attribute id", "output": "The id attribute of a Particle contains identifier of the particle. It's a long value that you can access after creating a Particle instance." }, { "instruction": "What is the type attribute of a Particle?", "input": "OpenMC Python API Particle attribute type", "output": "The type attribute of a Particle contains particle type (1 = neutron, 2 = photon, 3 = electron, 4 = positron). It's a int value that you can access after creating a Particle instance." }, { "instruction": "What is the weight attribute of a Particle?", "input": "OpenMC Python API Particle attribute weight", "output": "The weight attribute of a Particle contains weight of the particle. It's a float value that you can access after creating a Particle instance." }, { "instruction": "What is the energy attribute of a Particle?", "input": "OpenMC Python API Particle attribute energy", "output": "The energy attribute of a Particle contains energy of the particle in ev. It's a float value that you can access after creating a Particle instance." }, { "instruction": "What is the xyz attribute of a Particle?", "input": "OpenMC Python API Particle attribute xyz", "output": "The xyz attribute of a Particle contains position of the particle. It's a list of float value that you can access after creating a Particle instance." }, { "instruction": "What is the uvw attribute of a Particle?", "input": "OpenMC Python API Particle attribute uvw", "output": "The uvw attribute of a Particle contains directional cosines of the particle. It's a list of float value that you can access after creating a Particle instance." }, { "instruction": "How do you call the __init__() method in the Particle class?", "input": "OpenMC Python API Particle.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What is the PlotBase class in OpenMC's Python API?", "input": "OpenMC Python API PlotBase class", "output": "The PlotBase class represents parameters ---------- plot_id : int unique identifier for the plot name : str name of the plot. It provides 28 methods and 0 properties for working with plotbase data in OpenMC." }, { "instruction": "What does the PlotBase class do in OpenMC's Python API?", "input": "OpenMC Python API PlotBase class description", "output": "The PlotBase class parameters ---------- plot_id : int unique identifier for the plot name : str name of the plot. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the id attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute id", "output": "The id attribute of a PlotBase contains unique identifier. It's a int value that you can access after creating a PlotBase instance." }, { "instruction": "What is the name attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute name", "output": "The name attribute of a PlotBase contains name of the plot. It's a str value that you can access after creating a PlotBase instance." }, { "instruction": "What is the pixels attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute pixels", "output": "The pixels attribute of a PlotBase contains number of pixels to use in each direction. It's a Iterable of int value that you can access after creating a PlotBase instance." }, { "instruction": "What is the filename attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute filename", "output": "The filename attribute of a PlotBase contains path to write the plot to. It's a str value that you can access after creating a PlotBase instance." }, { "instruction": "What is the color_by attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute color_by", "output": "The color_by attribute of a PlotBase contains indicate whether the plot should be colored by cell or by material. It's a {'cell', 'material'} value that you can access after creating a PlotBase instance." }, { "instruction": "What is the background attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute background", "output": "The background attribute of a PlotBase contains color of the background. It's a Iterable of int or str value that you can access after creating a PlotBase instance." }, { "instruction": "What is the mask_components attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute mask_components", "output": "The mask_components attribute of a PlotBase contains the cells or materials (or corresponding ids) to mask. It's a Iterable of openmc.Cell or openmc.Material or int value that you can access after creating a PlotBase instance." }, { "instruction": "What is the mask_background attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute mask_background", "output": "The mask_background attribute of a PlotBase contains color to apply to all cells/materials listed in mask_components. It's a Iterable of int or str value that you can access after creating a PlotBase instance." }, { "instruction": "What is the show_overlaps attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute show_overlaps", "output": "The show_overlaps attribute of a PlotBase contains indicate whether or not overlapping regions are shown. It's a bool value that you can access after creating a PlotBase instance." }, { "instruction": "What is the overlap_color attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute overlap_color", "output": "The overlap_color attribute of a PlotBase contains color to apply to overlapping regions. It's a Iterable of int or str value that you can access after creating a PlotBase instance." }, { "instruction": "What is the colors attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute colors", "output": "The colors attribute of a PlotBase contains dictionary indicating that certain cells/materials should be displayed with a particular color. the keys can be of type :class:`~openmc.cell`, :class:`~openmc.material`, or int (id for a cell/material).. It's a dict value that you can access after creating a PlotBase instance." }, { "instruction": "What is the level attribute of a PlotBase?", "input": "OpenMC Python API PlotBase attribute level", "output": "The level attribute of a PlotBase contains universe depth to plot at. It's a int value that you can access after creating a PlotBase instance." }, { "instruction": "How do you call the __init__() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, plot_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the name() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the pixels() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.pixels() method signature", "output": "To call the pixels() method, use: @property def pixels(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the pixels() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.pixels() method signature", "output": "To call the pixels() method, use: @pixels.setter def pixels(self: Any, pixels: Any). It takes 2 parameters." }, { "instruction": "How do you call the filename() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.filename() method signature", "output": "To call the filename() method, use: @property def filename(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filename() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.filename() method signature", "output": "To call the filename() method, use: @filename.setter def filename(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "How do you call the color_by() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.color_by() method signature", "output": "To call the color_by() method, use: @property def color_by(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the color_by() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.color_by() method signature", "output": "To call the color_by() method, use: @color_by.setter def color_by(self: Any, color_by: Any). It takes 2 parameters." }, { "instruction": "How do you call the background() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.background() method signature", "output": "To call the background() method, use: @property def background(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the background() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.background() method signature", "output": "To call the background() method, use: @background.setter def background(self: Any, background: Any). It takes 2 parameters." }, { "instruction": "How do you call the mask_components() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.mask_components() method signature", "output": "To call the mask_components() method, use: @property def mask_components(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mask_components() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.mask_components() method signature", "output": "To call the mask_components() method, use: @mask_components.setter def mask_components(self: Any, mask_components: Any). It takes 2 parameters." }, { "instruction": "How do you call the mask_background() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.mask_background() method signature", "output": "To call the mask_background() method, use: @property def mask_background(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mask_background() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.mask_background() method signature", "output": "To call the mask_background() method, use: @mask_background.setter def mask_background(self: Any, mask_background: Any). It takes 2 parameters." }, { "instruction": "How do you call the show_overlaps() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.show_overlaps() method signature", "output": "To call the show_overlaps() method, use: @property def show_overlaps(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the show_overlaps() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.show_overlaps() method signature", "output": "To call the show_overlaps() method, use: @show_overlaps.setter def show_overlaps(self: Any, show_overlaps: Any). It takes 2 parameters." }, { "instruction": "How do you call the overlap_color() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.overlap_color() method signature", "output": "To call the overlap_color() method, use: @property def overlap_color(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the overlap_color() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.overlap_color() method signature", "output": "To call the overlap_color() method, use: @overlap_color.setter def overlap_color(self: Any, overlap_color: Any). It takes 2 parameters." }, { "instruction": "How do you call the colors() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.colors() method signature", "output": "To call the colors() method, use: @property def colors(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the colors() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.colors() method signature", "output": "To call the colors() method, use: @colors.setter def colors(self: Any, colors: Any). It takes 2 parameters." }, { "instruction": "How do you call the level() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.level() method signature", "output": "To call the level() method, use: @property def level(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the level() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.level() method signature", "output": "To call the level() method, use: @level.setter def level(self: Any, plot_level: Any). It takes 2 parameters." }, { "instruction": "How do you call the _check_color() method in the PlotBase class?", "input": "OpenMC Python API PlotBase._check_color() method signature", "output": "To call the _check_color() method, use: @staticmethod def _check_color(err_string: Any, color: Any). It takes 2 parameters." }, { "instruction": "How do you call the _get_id() method in the PlotBase class?", "input": "OpenMC Python API PlotBase._get_id() method signature", "output": "To call the _get_id() method, use: @staticmethod def _get_id(domain: Any). It takes 1 parameters." }, { "instruction": "What does the colorize() method do in the PlotBase class?", "input": "OpenMC Python API PlotBase.colorize() method", "output": "The colorize() method generate a color scheme for each domain in the plot. this routine may be used to generate random, reproducible color schemes. the colors generated are based upon cell/material ids in the geometry. It's used for plotbase operations." }, { "instruction": "How do you call the colorize() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.colorize() method signature", "output": "To call the colorize() method, use: def colorize(self: Any, geometry: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the geometry parameter do in the colorize() method?", "input": "OpenMC Python API PlotBase.colorize() parameter geometry", "output": "The geometry parameter the geometry for which the plot is defined. It should be a openmc.Geometry value." }, { "instruction": "What does the seed parameter do in the colorize() method?", "input": "OpenMC Python API PlotBase.colorize() parameter seed", "output": "The seed parameter the random number seed used to generate the color scheme. It should be a Integral value." }, { "instruction": "How do you call the _colors_to_xml() method in the PlotBase class?", "input": "OpenMC Python API PlotBase._colors_to_xml() method signature", "output": "To call the _colors_to_xml() method, use: def _colors_to_xml(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the PlotBase class?", "input": "OpenMC Python API PlotBase.to_xml_element() method", "output": "The to_xml_element() method save common plot attributes to xml element. It's used for plotbase operations." }, { "instruction": "How do you call the to_xml_element() method in the PlotBase class?", "input": "OpenMC Python API PlotBase.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the PlotBase class?", "input": "OpenMC Python API PlotBase.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing plot data. The return type is lxml.etree._Element." }, { "instruction": "What is the Plot class in OpenMC's Python API?", "input": "OpenMC Python API Plot class", "output": "The Plot class represents definition of a finite region of space to be plotted. openmc is capable of generating two-dimensional slice plots, or three-dimensional voxel or projection plots. colors that are used in plots can be given as rgb tuples, e.g. (255, 255, 255) would be white, or by a string indicating a valid `svg color `_. It provides 18 methods and 0 properties for working with plot data in OpenMC." }, { "instruction": "What does the Plot class do in OpenMC's Python API?", "input": "OpenMC Python API Plot class description", "output": "The Plot class definition of a finite region of space to be plotted. openmc is capable of generating two-dimensional slice plots, or three-dimensional voxel or projection plots. colors that are used in plots can be given as rgb tuples, e.g. (255, 255, 255) would be white, or by a string indicating a valid `svg color `_. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the plot_id parameter do when creating a Plot?", "input": "OpenMC Python API Plot constructor parameter plot_id", "output": "When creating a Plot, the plot_id parameter specifies unique identifier for the plot. It should be a int value." }, { "instruction": "What does the name parameter do when creating a Plot?", "input": "OpenMC Python API Plot constructor parameter name", "output": "When creating a Plot, the name parameter specifies name of the plot. It should be a str value." }, { "instruction": "What is the id attribute of a Plot?", "input": "OpenMC Python API Plot attribute id", "output": "The id attribute of a Plot contains unique identifier. It's a int value that you can access after creating a Plot instance." }, { "instruction": "What is the name attribute of a Plot?", "input": "OpenMC Python API Plot attribute name", "output": "The name attribute of a Plot contains name of the plot. It's a str value that you can access after creating a Plot instance." }, { "instruction": "What is the pixels attribute of a Plot?", "input": "OpenMC Python API Plot attribute pixels", "output": "The pixels attribute of a Plot contains number of pixels to use in each direction. It's a Iterable of int value that you can access after creating a Plot instance." }, { "instruction": "What is the filename attribute of a Plot?", "input": "OpenMC Python API Plot attribute filename", "output": "The filename attribute of a Plot contains path to write the plot to. It's a str value that you can access after creating a Plot instance." }, { "instruction": "What is the color_by attribute of a Plot?", "input": "OpenMC Python API Plot attribute color_by", "output": "The color_by attribute of a Plot contains indicate whether the plot should be colored by cell or by material. It's a {'cell', 'material'} value that you can access after creating a Plot instance." }, { "instruction": "What is the background attribute of a Plot?", "input": "OpenMC Python API Plot attribute background", "output": "The background attribute of a Plot contains color of the background. It's a Iterable of int or str value that you can access after creating a Plot instance." }, { "instruction": "What is the mask_components attribute of a Plot?", "input": "OpenMC Python API Plot attribute mask_components", "output": "The mask_components attribute of a Plot contains the cells or materials (or corresponding ids) to mask. It's a Iterable of openmc.Cell or openmc.Material or int value that you can access after creating a Plot instance." }, { "instruction": "What is the mask_background attribute of a Plot?", "input": "OpenMC Python API Plot attribute mask_background", "output": "The mask_background attribute of a Plot contains color to apply to all cells/materials listed in mask_components. It's a Iterable of int or str value that you can access after creating a Plot instance." }, { "instruction": "What is the show_overlaps attribute of a Plot?", "input": "OpenMC Python API Plot attribute show_overlaps", "output": "The show_overlaps attribute of a Plot contains indicate whether or not overlapping regions are shown. It's a bool value that you can access after creating a Plot instance." }, { "instruction": "What is the overlap_color attribute of a Plot?", "input": "OpenMC Python API Plot attribute overlap_color", "output": "The overlap_color attribute of a Plot contains color to apply to overlapping regions. It's a Iterable of int or str value that you can access after creating a Plot instance." }, { "instruction": "What is the colors attribute of a Plot?", "input": "OpenMC Python API Plot attribute colors", "output": "The colors attribute of a Plot contains dictionary indicating that certain cells/materials should be displayed with a particular color. the keys can be of type :class:`~openmc.cell`, :class:`~openmc.material`, or int (id for a cell/material).. It's a dict value that you can access after creating a Plot instance." }, { "instruction": "What is the level attribute of a Plot?", "input": "OpenMC Python API Plot attribute level", "output": "The level attribute of a Plot contains universe depth to plot at. It's a int value that you can access after creating a Plot instance." }, { "instruction": "What is the width attribute of a Plot?", "input": "OpenMC Python API Plot attribute width", "output": "The width attribute of a Plot contains width of the plot in each basis direction. It's a Iterable of float value that you can access after creating a Plot instance." }, { "instruction": "What is the origin attribute of a Plot?", "input": "OpenMC Python API Plot attribute origin", "output": "The origin attribute of a Plot contains origin (center) of the plot. It's a tuple or list of ndarray value that you can access after creating a Plot instance." }, { "instruction": "What is the type attribute of a Plot?", "input": "OpenMC Python API Plot attribute type", "output": "The type attribute of a Plot contains the type of the plot. It's a {'slice', 'voxel'} value that you can access after creating a Plot instance." }, { "instruction": "What is the basis attribute of a Plot?", "input": "OpenMC Python API Plot attribute basis", "output": "The basis attribute of a Plot contains the basis directions for the plot. It's a {'xy', 'xz', 'yz'} value that you can access after creating a Plot instance." }, { "instruction": "What is the meshlines attribute of a Plot?", "input": "OpenMC Python API Plot attribute meshlines", "output": "The meshlines attribute of a Plot contains dictionary defining type, id, linewidth and color of a mesh to be plotted on top of a plot. It's a dict value that you can access after creating a Plot instance." }, { "instruction": "How do you call the __init__() method in the Plot class?", "input": "OpenMC Python API Plot.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, plot_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the width() method in the Plot class?", "input": "OpenMC Python API Plot.width() method signature", "output": "To call the width() method, use: @property def width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the width() method in the Plot class?", "input": "OpenMC Python API Plot.width() method signature", "output": "To call the width() method, use: @width.setter def width(self: Any, width: Any). It takes 2 parameters." }, { "instruction": "How do you call the origin() method in the Plot class?", "input": "OpenMC Python API Plot.origin() method signature", "output": "To call the origin() method, use: @property def origin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the Plot class?", "input": "OpenMC Python API Plot.origin() method signature", "output": "To call the origin() method, use: @origin.setter def origin(self: Any, origin: Any). It takes 2 parameters." }, { "instruction": "How do you call the type() method in the Plot class?", "input": "OpenMC Python API Plot.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the type() method in the Plot class?", "input": "OpenMC Python API Plot.type() method signature", "output": "To call the type() method, use: @type.setter def type(self: Any, plottype: Any). It takes 2 parameters." }, { "instruction": "How do you call the basis() method in the Plot class?", "input": "OpenMC Python API Plot.basis() method signature", "output": "To call the basis() method, use: @property def basis(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the basis() method in the Plot class?", "input": "OpenMC Python API Plot.basis() method signature", "output": "To call the basis() method, use: @basis.setter def basis(self: Any, basis: Any). It takes 2 parameters." }, { "instruction": "How do you call the meshlines() method in the Plot class?", "input": "OpenMC Python API Plot.meshlines() method signature", "output": "To call the meshlines() method, use: @property def meshlines(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the meshlines() method in the Plot class?", "input": "OpenMC Python API Plot.meshlines() method signature", "output": "To call the meshlines() method, use: @meshlines.setter def meshlines(self: Any, meshlines: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Plot class?", "input": "OpenMC Python API Plot.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_geometry() method do in the Plot class?", "input": "OpenMC Python API Plot.from_geometry() method", "output": "The from_geometry() method return plot that encompasses a geometry. It's used for plot operations." }, { "instruction": "How do you call the from_geometry() method in the Plot class?", "input": "OpenMC Python API Plot.from_geometry() method signature", "output": "To call the from_geometry() method, use: @classmethod def from_geometry(cls: Any, geometry: Any, basis: Any, slice_coord: Any). It takes 4 parameters." }, { "instruction": "What does the geometry parameter do in the from_geometry() method?", "input": "OpenMC Python API Plot.from_geometry() parameter geometry", "output": "The geometry parameter the geometry to base the plot off of. It should be a openmc.Geometry value." }, { "instruction": "What does the basis parameter do in the from_geometry() method?", "input": "OpenMC Python API Plot.from_geometry() parameter basis", "output": "The basis parameter the basis directions for the plot. It should be a {'xy', 'xz', 'yz'} value." }, { "instruction": "What does the slice_coord parameter do in the from_geometry() method?", "input": "OpenMC Python API Plot.from_geometry() parameter slice_coord", "output": "The slice_coord parameter the level at which the slice plot should be plotted. for example, if the basis is 'xy', this would indicate the z value used in the origin.. It should be a float value." }, { "instruction": "What does the highlight_domains() method do in the Plot class?", "input": "OpenMC Python API Plot.highlight_domains() method", "output": "The highlight_domains() method use alpha compositing to highlight one or more domains in the plot. this routine generates a color scheme and applies alpha compositing to make all domains except the highlighted ones appear partially transparent. It's used for plot operations." }, { "instruction": "How do you call the highlight_domains() method in the Plot class?", "input": "OpenMC Python API Plot.highlight_domains() method signature", "output": "To call the highlight_domains() method, use: def highlight_domains(self: Any, geometry: Any, domains: Any, seed: Any, alpha: Any, background: Any). It takes 6 parameters." }, { "instruction": "What does the geometry parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plot.highlight_domains() parameter geometry", "output": "The geometry parameter the geometry for which the plot is defined. It should be a openmc.Geometry value." }, { "instruction": "What does the domains parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plot.highlight_domains() parameter domains", "output": "The domains parameter a collection of the domain ids to highlight in the plot. It should be a Iterable of openmc.Cell or openmc.Material value." }, { "instruction": "What does the seed parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plot.highlight_domains() parameter seed", "output": "The seed parameter the random number seed used to generate the color scheme. It should be a int value." }, { "instruction": "What does the alpha parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plot.highlight_domains() parameter alpha", "output": "The alpha parameter the value between 0 and 1 to apply in alpha compositing. It should be a float value." }, { "instruction": "What does the background parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plot.highlight_domains() parameter background", "output": "The background parameter the background color to apply in alpha compositing. It should be a 3-tuple of int or str value." }, { "instruction": "What does the to_xml_element() method do in the Plot class?", "input": "OpenMC Python API Plot.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the slice/voxel plot. It's used for plot operations." }, { "instruction": "How do you call the to_xml_element() method in the Plot class?", "input": "OpenMC Python API Plot.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Plot class?", "input": "OpenMC Python API Plot.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing plot data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Plot class?", "input": "OpenMC Python API Plot.from_xml_element() method", "output": "The from_xml_element() method generate plot object from an xml element. It's used for plot operations." }, { "instruction": "How do you call the from_xml_element() method in the Plot class?", "input": "OpenMC Python API Plot.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Plot.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the to_ipython_image() method do in the Plot class?", "input": "OpenMC Python API Plot.to_ipython_image() method", "output": "The to_ipython_image() method render plot as an image this method runs openmc in plotting mode to produce a .png file. .. versionchanged:: 0.13.0 the *convert_exec* argument was removed since openmc now produces .png images directly. It's used for plot operations." }, { "instruction": "How do you call the to_ipython_image() method in the Plot class?", "input": "OpenMC Python API Plot.to_ipython_image() method signature", "output": "To call the to_ipython_image() method, use: def to_ipython_image(self: Any, openmc_exec: Any, cwd: Any). It takes 3 parameters." }, { "instruction": "What does the openmc_exec parameter do in the to_ipython_image() method?", "input": "OpenMC Python API Plot.to_ipython_image() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. It should be a str value." }, { "instruction": "What does the cwd parameter do in the to_ipython_image() method?", "input": "OpenMC Python API Plot.to_ipython_image() parameter cwd", "output": "The cwd parameter path to working directory to run in. It should be a str, optional value." }, { "instruction": "What does the to_vtk() method do in the Plot class?", "input": "OpenMC Python API Plot.to_vtk() method", "output": "The to_vtk() method render plot as an voxel image this method runs openmc in plotting mode to produce a .vti file. .. versionadded:: 0.14.0. It's used for plot operations." }, { "instruction": "How do you call the to_vtk() method in the Plot class?", "input": "OpenMC Python API Plot.to_vtk() method signature", "output": "To call the to_vtk() method, use: def to_vtk(self: Any, output: Any, openmc_exec: str, cwd: str). It takes 4 parameters." }, { "instruction": "What does the output parameter do in the to_vtk() method?", "input": "OpenMC Python API Plot.to_vtk() parameter output", "output": "The output parameter path of the output .vti file produced. It should be a path-like value." }, { "instruction": "What does the openmc_exec parameter do in the to_vtk() method?", "input": "OpenMC Python API Plot.to_vtk() parameter openmc_exec", "output": "The openmc_exec parameter path to openmc executable. It should be a str value." }, { "instruction": "What does the cwd parameter do in the to_vtk() method?", "input": "OpenMC Python API Plot.to_vtk() parameter cwd", "output": "The cwd parameter path to working directory to run in. It should be a str, optional value." }, { "instruction": "What is the RayTracePlot class in OpenMC's Python API?", "input": "OpenMC Python API RayTracePlot class", "output": "The RayTracePlot class represents definition of a camera's view of openmc geometry the camera projection may either by orthographic or perspective. perspective projections are more similar to a pinhole camera, and orthographic projections preserve parallel lines and distances. this is an abstract base class that :class:`wireframeraytraceplot` and :class:`solidraytraceplot` finish the implementation of. .. versionadded:: 0.15.1. It provides 15 methods and 0 properties for working with raytraceplot data in OpenMC." }, { "instruction": "What does the RayTracePlot class do in OpenMC's Python API?", "input": "OpenMC Python API RayTracePlot class description", "output": "The RayTracePlot class definition of a camera's view of openmc geometry the camera projection may either by orthographic or perspective. perspective projections are more similar to a pinhole camera, and orthographic projections preserve parallel lines and distances. this is an abstract base class that :class:`wireframeraytraceplot` and :class:`solidraytraceplot` finish the implementation of. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the plot_id parameter do when creating a RayTracePlot?", "input": "OpenMC Python API RayTracePlot constructor parameter plot_id", "output": "When creating a RayTracePlot, the plot_id parameter specifies unique identifier for the plot. It should be a int value." }, { "instruction": "What does the name parameter do when creating a RayTracePlot?", "input": "OpenMC Python API RayTracePlot constructor parameter name", "output": "When creating a RayTracePlot, the name parameter specifies name of the plot. It should be a str value." }, { "instruction": "What is the horizontal_field_of_view attribute of a RayTracePlot?", "input": "OpenMC Python API RayTracePlot attribute horizontal_field_of_view", "output": "The horizontal_field_of_view attribute of a RayTracePlot contains field of view horizontally, in units of degrees, defaults to 70.. It's a float value that you can access after creating a RayTracePlot instance." }, { "instruction": "What is the camera_position attribute of a RayTracePlot?", "input": "OpenMC Python API RayTracePlot attribute camera_position", "output": "The camera_position attribute of a RayTracePlot contains position of the camera in 3d space. defaults to (1, 0, 0).. It's a tuple or list of ndarray value that you can access after creating a RayTracePlot instance." }, { "instruction": "What is the look_at attribute of a RayTracePlot?", "input": "OpenMC Python API RayTracePlot attribute look_at", "output": "The look_at attribute of a RayTracePlot contains the center of the camera's image points to this place in 3d space. set to (0, 0, 0) by default.. It's a tuple or list of ndarray value that you can access after creating a RayTracePlot instance." }, { "instruction": "What is the up attribute of a RayTracePlot?", "input": "OpenMC Python API RayTracePlot attribute up", "output": "The up attribute of a RayTracePlot contains which way is up for the camera. must not be parallel to the line between look_at and camera_position. set to (0, 0, 1) by default.. It's a tuple or list of ndarray value that you can access after creating a RayTracePlot instance." }, { "instruction": "What is the orthographic_width attribute of a RayTracePlot?", "input": "OpenMC Python API RayTracePlot attribute orthographic_width", "output": "The orthographic_width attribute of a RayTracePlot contains if set to a nonzero value, an orthographic projection is used. all rays traced from the orthographic pixel array travel in the same direction. the width of the starting array must be specified, unlike with the default perspective projection. the height of the array is deduced from the ratio of pixel dimensions for the image. defaults to zero, i.e. using perspective projection.. It's a float value that you can access after creating a RayTracePlot instance." }, { "instruction": "How do you call the __init__() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, plot_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the horizontal_field_of_view() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.horizontal_field_of_view() method signature", "output": "To call the horizontal_field_of_view() method, use: @property def horizontal_field_of_view(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the horizontal_field_of_view() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.horizontal_field_of_view() method signature", "output": "To call the horizontal_field_of_view() method, use: @horizontal_field_of_view.setter def horizontal_field_of_view(self: Any, horizontal_field_of_view: Any). It takes 2 parameters." }, { "instruction": "How do you call the camera_position() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.camera_position() method signature", "output": "To call the camera_position() method, use: @property def camera_position(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the camera_position() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.camera_position() method signature", "output": "To call the camera_position() method, use: @camera_position.setter def camera_position(self: Any, camera_position: Any). It takes 2 parameters." }, { "instruction": "How do you call the look_at() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.look_at() method signature", "output": "To call the look_at() method, use: @property def look_at(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the look_at() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.look_at() method signature", "output": "To call the look_at() method, use: @look_at.setter def look_at(self: Any, look_at: Any). It takes 2 parameters." }, { "instruction": "How do you call the up() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.up() method signature", "output": "To call the up() method, use: @property def up(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the up() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.up() method signature", "output": "To call the up() method, use: @up.setter def up(self: Any, up: Any). It takes 2 parameters." }, { "instruction": "How do you call the orthographic_width() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.orthographic_width() method signature", "output": "To call the orthographic_width() method, use: @property def orthographic_width(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the orthographic_width() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.orthographic_width() method signature", "output": "To call the orthographic_width() method, use: @orthographic_width.setter def orthographic_width(self: Any, orthographic_width: Any). It takes 2 parameters." }, { "instruction": "What does the _check_domains_consistent_with_color_by() method do in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot._check_domains_consistent_with_color_by() method", "output": "The _check_domains_consistent_with_color_by() method check domains are the same as the type we are coloring by. It's used for raytraceplot operations." }, { "instruction": "How do you call the _check_domains_consistent_with_color_by() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot._check_domains_consistent_with_color_by() method signature", "output": "To call the _check_domains_consistent_with_color_by() method, use: def _check_domains_consistent_with_color_by(self: Any, domains: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the ray trace plot. It's used for raytraceplot operations." }, { "instruction": "How do you call the to_xml_element() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing plot data. The return type is lxml.etree._Element." }, { "instruction": "How do you call the __repr__() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the _read_xml_attributes() method do in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot._read_xml_attributes() method", "output": "The _read_xml_attributes() method helper function called by from_xml_element of child classes. these are common vaues to be read by any ray traced plot. It's used for raytraceplot operations." }, { "instruction": "How do you call the _read_xml_attributes() method in the RayTracePlot class?", "input": "OpenMC Python API RayTracePlot._read_xml_attributes() method signature", "output": "To call the _read_xml_attributes() method, use: def _read_xml_attributes(self: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the WireframeRayTracePlot class in OpenMC's Python API?", "input": "OpenMC Python API WireframeRayTracePlot class", "output": "The WireframeRayTracePlot class represents plots wireframes of geometry with volume rendered colors colors are defined in the same manner as the plot class, but with the addition of a coloring parameter resembling a macroscopic cross section in units of inverse centimeters. the volume rendering technique is used to color regions of the model. an infinite cross section denotes a fully opaque region, and zero represents a transparent region which will expose the color of the regions behind it. .. versionchanged:: 0.15.1 renamed from projectionplot to wireframeraytraceplot. It provides 13 methods and 0 properties for working with wireframeraytraceplot data in OpenMC." }, { "instruction": "What does the WireframeRayTracePlot class do in OpenMC's Python API?", "input": "OpenMC Python API WireframeRayTracePlot class description", "output": "The WireframeRayTracePlot class plots wireframes of geometry with volume rendered colors colors are defined in the same manner as the plot class, but with the addition of a coloring parameter resembling a macroscopic cross section in units of inverse centimeters. the volume rendering technique is used to color regions of the model. an infinite cross section denotes a fully opaque region, and zero represents a transparent region which will expose the color of the regions behind it. .. versionchanged:: 0.15.1 renamed from projectionplot to wireframeraytraceplot. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the plot_id parameter do when creating a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot constructor parameter plot_id", "output": "When creating a WireframeRayTracePlot, the plot_id parameter specifies unique identifier for the plot. It should be a int value." }, { "instruction": "What does the name parameter do when creating a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot constructor parameter name", "output": "When creating a WireframeRayTracePlot, the name parameter specifies name of the plot. It should be a str value." }, { "instruction": "What is the id attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute id", "output": "The id attribute of a WireframeRayTracePlot contains unique identifier. It's a int value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the name attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute name", "output": "The name attribute of a WireframeRayTracePlot contains name of the plot. It's a str value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the pixels attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute pixels", "output": "The pixels attribute of a WireframeRayTracePlot contains number of pixels to use in each direction. It's a Iterable of int value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the filename attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute filename", "output": "The filename attribute of a WireframeRayTracePlot contains path to write the plot to. It's a str value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the color_by attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute color_by", "output": "The color_by attribute of a WireframeRayTracePlot contains indicate whether the plot should be colored by cell or by material. It's a {'cell', 'material'} value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the background attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute background", "output": "The background attribute of a WireframeRayTracePlot contains color of the background. It's a Iterable of int or str value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the mask_components attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute mask_components", "output": "The mask_components attribute of a WireframeRayTracePlot contains the cells or materials (or corresponding ids) to mask. It's a Iterable of openmc.Cell or openmc.Material or int value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the mask_background attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute mask_background", "output": "The mask_background attribute of a WireframeRayTracePlot contains color to apply to all cells/materials listed in mask_components. It's a Iterable of int or str value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the show_overlaps attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute show_overlaps", "output": "The show_overlaps attribute of a WireframeRayTracePlot contains indicate whether or not overlapping regions are shown. It's a bool value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the overlap_color attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute overlap_color", "output": "The overlap_color attribute of a WireframeRayTracePlot contains color to apply to overlapping regions. It's a Iterable of int or str value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the colors attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute colors", "output": "The colors attribute of a WireframeRayTracePlot contains dictionary indicating that certain cells/materials should be displayed with a particular color. the keys can be of type :class:`~openmc.cell`, :class:`~openmc.material`, or int (id for a cell/material).. It's a dict value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the level attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute level", "output": "The level attribute of a WireframeRayTracePlot contains universe depth to plot at. It's a int value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the horizontal_field_of_view attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute horizontal_field_of_view", "output": "The horizontal_field_of_view attribute of a WireframeRayTracePlot contains field of view horizontally, in units of degrees, defaults to 70.. It's a float value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the camera_position attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute camera_position", "output": "The camera_position attribute of a WireframeRayTracePlot contains position of the camera in 3d space. defaults to (1, 0, 0).. It's a tuple or list of ndarray value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the look_at attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute look_at", "output": "The look_at attribute of a WireframeRayTracePlot contains the center of the camera's image points to this place in 3d space. set to (0, 0, 0) by default.. It's a tuple or list of ndarray value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the up attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute up", "output": "The up attribute of a WireframeRayTracePlot contains which way is up for the camera. must not be parallel to the line between look_at and camera_position. set to (0, 0, 1) by default.. It's a tuple or list of ndarray value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the orthographic_width attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute orthographic_width", "output": "The orthographic_width attribute of a WireframeRayTracePlot contains if set to a nonzero value, an orthographic projection is used. all rays traced from the orthographic pixel array travel in the same direction. the width of the starting array must be specified, unlike with the default perspective projection. the height of the array is deduced from the ratio of pixel dimensions for the image. defaults to zero, i.e. using perspective projection.. It's a float value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the wireframe_thickness attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute wireframe_thickness", "output": "The wireframe_thickness attribute of a WireframeRayTracePlot contains line thickness employed for drawing wireframes around cells or material regions. can be set to zero for no wireframes at all. defaults to one pixel.. It's a int value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the wireframe_color attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute wireframe_color", "output": "The wireframe_color attribute of a WireframeRayTracePlot contains rgb color of the wireframe lines. defaults to black.. It's a tuple of ints value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the wireframe_domains attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute wireframe_domains", "output": "The wireframe_domains attribute of a WireframeRayTracePlot contains if provided, the wireframe is only drawn around these. if color_by is by material, it must be a list of materials, else cells.. It's a iterable of either Material or Cells value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "What is the xs attribute of a WireframeRayTracePlot?", "input": "OpenMC Python API WireframeRayTracePlot attribute xs", "output": "The xs attribute of a WireframeRayTracePlot contains a mapping from cell/material ids to floats. the floating point values are macroscopic cross sections influencing the volume rendering opacity of each geometric region. zero corresponds to perfect transparency, and infinity equivalent to opaque. these must be set by the user, but default values can be obtained using the :meth:`set_transparent` method.. It's a dict value that you can access after creating a WireframeRayTracePlot instance." }, { "instruction": "How do you call the __init__() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, plot_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the wireframe_thickness() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.wireframe_thickness() method signature", "output": "To call the wireframe_thickness() method, use: @property def wireframe_thickness(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the wireframe_thickness() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.wireframe_thickness() method signature", "output": "To call the wireframe_thickness() method, use: @wireframe_thickness.setter def wireframe_thickness(self: Any, wireframe_thickness: Any). It takes 2 parameters." }, { "instruction": "How do you call the wireframe_color() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.wireframe_color() method signature", "output": "To call the wireframe_color() method, use: @property def wireframe_color(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the wireframe_color() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.wireframe_color() method signature", "output": "To call the wireframe_color() method, use: @wireframe_color.setter def wireframe_color(self: Any, wireframe_color: Any). It takes 2 parameters." }, { "instruction": "How do you call the wireframe_domains() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.wireframe_domains() method signature", "output": "To call the wireframe_domains() method, use: @property def wireframe_domains(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the wireframe_domains() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.wireframe_domains() method signature", "output": "To call the wireframe_domains() method, use: @wireframe_domains.setter def wireframe_domains(self: Any, wireframe_domains: Any). It takes 2 parameters." }, { "instruction": "How do you call the xs() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.xs() method signature", "output": "To call the xs() method, use: @property def xs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xs() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.xs() method signature", "output": "To call the xs() method, use: @xs.setter def xs(self: Any, xs: Any). It takes 2 parameters." }, { "instruction": "What does the set_transparent() method do in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.set_transparent() method", "output": "The set_transparent() method sets all volume rendering xs to zero for the model. It's used for wireframeraytraceplot operations." }, { "instruction": "How do you call the set_transparent() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.set_transparent() method signature", "output": "To call the set_transparent() method, use: def set_transparent(self: Any, geometry: Any). It takes 2 parameters." }, { "instruction": "What does the geometry parameter do in the set_transparent() method?", "input": "OpenMC Python API WireframeRayTracePlot.set_transparent() parameter geometry", "output": "The geometry parameter the geometry for which the plot is defined. It should be a openmc.Geometry value." }, { "instruction": "How do you call the __repr__() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the projection plot. It's used for wireframeraytraceplot operations." }, { "instruction": "How do you call the to_xml_element() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing plot data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.from_xml_element() method", "output": "The from_xml_element() method generate plot object from an xml element. It's used for wireframeraytraceplot operations." }, { "instruction": "How do you call the from_xml_element() method in the WireframeRayTracePlot class?", "input": "OpenMC Python API WireframeRayTracePlot.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API WireframeRayTracePlot.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the SolidRayTracePlot class in OpenMC's Python API?", "input": "OpenMC Python API SolidRayTracePlot class", "output": "The SolidRayTracePlot class represents phong shading-based rendering of an openmc geometry this class defines a plot that uses phong shading to enhance the visualization of an openmc geometry by incorporating diffuse lighting and configurable opacity for certain regions. it extends :class:`raytraceplot` by adding parameters related to lighting and transparency. .. versionadded:: 0.15.1. It provides 11 methods and 0 properties for working with solidraytraceplot data in OpenMC." }, { "instruction": "What does the SolidRayTracePlot class do in OpenMC's Python API?", "input": "OpenMC Python API SolidRayTracePlot class description", "output": "The SolidRayTracePlot class phong shading-based rendering of an openmc geometry this class defines a plot that uses phong shading to enhance the visualization of an openmc geometry by incorporating diffuse lighting and configurable opacity for certain regions. it extends :class:`raytraceplot` by adding parameters related to lighting and transparency. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the plot_id parameter do when creating a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot constructor parameter plot_id", "output": "When creating a SolidRayTracePlot, the plot_id parameter specifies unique identifier for the plot. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot constructor parameter name", "output": "When creating a SolidRayTracePlot, the name parameter specifies name of the plot. It should be a str, optional value." }, { "instruction": "What is the id attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute id", "output": "The id attribute of a SolidRayTracePlot contains unique identifier. It's a int value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the name attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute name", "output": "The name attribute of a SolidRayTracePlot contains name of the plot. It's a str value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the pixels attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute pixels", "output": "The pixels attribute of a SolidRayTracePlot contains number of pixels to use in each direction. It's a Iterable of int value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the filename attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute filename", "output": "The filename attribute of a SolidRayTracePlot contains path to write the plot to. It's a str value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the color_by attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute color_by", "output": "The color_by attribute of a SolidRayTracePlot contains indicate whether the plot should be colored by cell or by material. It's a {'cell', 'material'} value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the overlap_color attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute overlap_color", "output": "The overlap_color attribute of a SolidRayTracePlot contains color to apply to overlapping regions. It's a Iterable of int or str value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the colors attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute colors", "output": "The colors attribute of a SolidRayTracePlot contains dictionary indicating that certain cells/materials should be displayed with a particular color. the keys can be of type :class:`~openmc.cell`, :class:`~openmc.material`, or int (id for a cell/material).. It's a dict value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the horizontal_field_of_view attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute horizontal_field_of_view", "output": "The horizontal_field_of_view attribute of a SolidRayTracePlot contains field of view horizontally, in units of degrees, defaults to 70.. It's a float value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the camera_position attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute camera_position", "output": "The camera_position attribute of a SolidRayTracePlot contains position of the camera in 3d space. defaults to (1, 0, 0).. It's a tuple or list of ndarray value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the look_at attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute look_at", "output": "The look_at attribute of a SolidRayTracePlot contains the center of the camera's image points to this place in 3d space. set to (0, 0, 0) by default.. It's a tuple or list of ndarray value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the up attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute up", "output": "The up attribute of a SolidRayTracePlot contains which way is up for the camera. must not be parallel to the line between look_at and camera_position. set to (0, 0, 1) by default.. It's a tuple or list of ndarray value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the orthographic_width attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute orthographic_width", "output": "The orthographic_width attribute of a SolidRayTracePlot contains if set to a nonzero value, an orthographic projection is used. all rays traced from the orthographic pixel array travel in the same direction. the width of the starting array must be specified, unlike with the default perspective projection. the height of the array is deduced from the ratio of pixel dimensions for the image. defaults to zero, i.e. using perspective projection.. It's a float value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the light_position attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute light_position", "output": "The light_position attribute of a SolidRayTracePlot contains position of the light source in 3d space. defaults to none, which places the light at the camera position.. It's a tuple or list of float value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the diffuse_fraction attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute diffuse_fraction", "output": "The diffuse_fraction attribute of a SolidRayTracePlot contains fraction of lighting that is diffuse (non-directional). defaults to 0.1. must be between 0 and 1.. It's a float value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "What is the opaque_domains attribute of a SolidRayTracePlot?", "input": "OpenMC Python API SolidRayTracePlot attribute opaque_domains", "output": "The opaque_domains attribute of a SolidRayTracePlot contains list of domains (e.g., cells or materials) that should be rendered as opaque rather than allowing transparency.. It's a list value that you can access after creating a SolidRayTracePlot instance." }, { "instruction": "How do you call the __init__() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, plot_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the light_position() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.light_position() method signature", "output": "To call the light_position() method, use: @property def light_position(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the light_position() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.light_position() method signature", "output": "To call the light_position() method, use: @light_position.setter def light_position(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the diffuse_fraction() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.diffuse_fraction() method signature", "output": "To call the diffuse_fraction() method, use: @property def diffuse_fraction(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the diffuse_fraction() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.diffuse_fraction() method signature", "output": "To call the diffuse_fraction() method, use: @diffuse_fraction.setter def diffuse_fraction(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the opaque_domains() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.opaque_domains() method signature", "output": "To call the opaque_domains() method, use: @property def opaque_domains(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the opaque_domains() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.opaque_domains() method signature", "output": "To call the opaque_domains() method, use: @opaque_domains.setter def opaque_domains(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the solid ray-traced plot. It's used for solidraytraceplot operations." }, { "instruction": "How do you call the to_xml_element() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing plot data. The return type is lxml.etree._Element." }, { "instruction": "What does the _read_phong_attributes() method do in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot._read_phong_attributes() method", "output": "The _read_phong_attributes() method read attributes specific to the phong plot from an xml element. It's used for solidraytraceplot operations." }, { "instruction": "How do you call the _read_phong_attributes() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot._read_phong_attributes() method signature", "output": "To call the _read_phong_attributes() method, use: def _read_phong_attributes(self: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the from_xml_element() method do in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.from_xml_element() method", "output": "The from_xml_element() method generate plot object from an xml element. It's used for solidraytraceplot operations." }, { "instruction": "How do you call the from_xml_element() method in the SolidRayTracePlot class?", "input": "OpenMC Python API SolidRayTracePlot.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API SolidRayTracePlot.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Plots class in OpenMC's Python API?", "input": "OpenMC Python API Plots class", "output": "The Plots class represents collection of plots used for an openmc simulation. this class corresponds directly to the plots.xml input file. it can be thought of as a normal python list where each member is inherits from :class:`plotbase`. it behaves like a list as the following example demonstrates: >>> xz_plot = openmc.plot() >>> big_plot = openmc.plot() >>> small_plot = openmc.plot() >>> p = openmc.plots((xz_plot, big_plot)) >>> p.append(small_plot) >>> small_plot = p.pop(). It provides 10 methods and 0 properties for working with plots data in OpenMC." }, { "instruction": "What does the Plots class do in OpenMC's Python API?", "input": "OpenMC Python API Plots class description", "output": "The Plots class collection of plots used for an openmc simulation. this class corresponds directly to the plots.xml input file. it can be thought of as a normal python list where each member is inherits from :class:`plotbase`. it behaves like a list as the following example demonstrates: >>> xz_plot = openmc.plot() >>> big_plot = openmc.plot() >>> small_plot = openmc.plot() >>> p = openmc.plots((xz_plot, big_plot)) >>> p.append(small_plot) >>> small_plot = p.pop(). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the plots parameter do when creating a Plots?", "input": "OpenMC Python API Plots constructor parameter plots", "output": "When creating a Plots, the plots parameter specifies plots to add to the collection. It should be a Iterable of openmc.PlotBase value." }, { "instruction": "How do you call the __init__() method in the Plots class?", "input": "OpenMC Python API Plots.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, plots: Any). It takes 2 parameters." }, { "instruction": "What does the append() method do in the Plots class?", "input": "OpenMC Python API Plots.append() method", "output": "The append() method append plot to collection. It's used for plots operations." }, { "instruction": "How do you call the append() method in the Plots class?", "input": "OpenMC Python API Plots.append() method signature", "output": "To call the append() method, use: def append(self: Any, plot: Any). It takes 2 parameters." }, { "instruction": "What does the plot parameter do in the append() method?", "input": "OpenMC Python API Plots.append() parameter plot", "output": "The plot parameter plot to append. It should be a openmc.PlotBase value." }, { "instruction": "What does the insert() method do in the Plots class?", "input": "OpenMC Python API Plots.insert() method", "output": "The insert() method insert plot before index. It's used for plots operations." }, { "instruction": "How do you call the insert() method in the Plots class?", "input": "OpenMC Python API Plots.insert() method signature", "output": "To call the insert() method, use: def insert(self: Any, index: Any, plot: Any). It takes 3 parameters." }, { "instruction": "What does the index parameter do in the insert() method?", "input": "OpenMC Python API Plots.insert() parameter index", "output": "The index parameter index in list. It should be a int value." }, { "instruction": "What does the plot parameter do in the insert() method?", "input": "OpenMC Python API Plots.insert() parameter plot", "output": "The plot parameter plot to insert. It should be a openmc.Plot value." }, { "instruction": "What does the colorize() method do in the Plots class?", "input": "OpenMC Python API Plots.colorize() method", "output": "The colorize() method generate a consistent color scheme for each domain in each plot. this routine may be used to generate random, reproducible color schemes. the colors generated are based upon cell/material ids in the geometry. the color schemes will be consistent for all plots in \"plots.xml\". It's used for plots operations." }, { "instruction": "How do you call the colorize() method in the Plots class?", "input": "OpenMC Python API Plots.colorize() method signature", "output": "To call the colorize() method, use: def colorize(self: Any, geometry: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the geometry parameter do in the colorize() method?", "input": "OpenMC Python API Plots.colorize() parameter geometry", "output": "The geometry parameter the geometry for which the plots are defined. It should be a openmc.Geometry value." }, { "instruction": "What does the seed parameter do in the colorize() method?", "input": "OpenMC Python API Plots.colorize() parameter seed", "output": "The seed parameter the random number seed used to generate the color scheme. It should be a Integral value." }, { "instruction": "What does the highlight_domains() method do in the Plots class?", "input": "OpenMC Python API Plots.highlight_domains() method", "output": "The highlight_domains() method use alpha compositing to highlight one or more domains in the plot. this routine generates a color scheme and applies alpha compositing to make all domains except the highlighted ones appear partially transparent. It's used for plots operations." }, { "instruction": "How do you call the highlight_domains() method in the Plots class?", "input": "OpenMC Python API Plots.highlight_domains() method signature", "output": "To call the highlight_domains() method, use: def highlight_domains(self: Any, geometry: Any, domains: Any, seed: Any, alpha: Any, background: Any). It takes 6 parameters." }, { "instruction": "What does the geometry parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plots.highlight_domains() parameter geometry", "output": "The geometry parameter the geometry for which the plot is defined. It should be a openmc.Geometry value." }, { "instruction": "What does the domains parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plots.highlight_domains() parameter domains", "output": "The domains parameter a collection of the domain ids to highlight in the plot. It should be a Iterable of openmc.Cell or openmc.Material value." }, { "instruction": "What does the seed parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plots.highlight_domains() parameter seed", "output": "The seed parameter the random number seed used to generate the color scheme. It should be a int value." }, { "instruction": "What does the alpha parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plots.highlight_domains() parameter alpha", "output": "The alpha parameter the value between 0 and 1 to apply in alpha compositing. It should be a float value." }, { "instruction": "What does the background parameter do in the highlight_domains() method?", "input": "OpenMC Python API Plots.highlight_domains() parameter background", "output": "The background parameter the background color to apply in alpha compositing. It should be a 3-tuple of int or str value." }, { "instruction": "How do you call the _create_plot_subelements() method in the Plots class?", "input": "OpenMC Python API Plots._create_plot_subelements() method signature", "output": "To call the _create_plot_subelements() method, use: def _create_plot_subelements(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the Plots class?", "input": "OpenMC Python API Plots.to_xml_element() method", "output": "The to_xml_element() method create a 'plots' element to be written to an xml file. It's used for plots operations." }, { "instruction": "How do you call the to_xml_element() method in the Plots class?", "input": "OpenMC Python API Plots.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Plots class?", "input": "OpenMC Python API Plots.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing all plot elements. The return type is lxml.etree._Element." }, { "instruction": "What does the export_to_xml() method do in the Plots class?", "input": "OpenMC Python API Plots.export_to_xml() method", "output": "The export_to_xml() method export plot specifications to an xml file. It's used for plots operations." }, { "instruction": "How do you call the export_to_xml() method in the Plots class?", "input": "OpenMC Python API Plots.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the export_to_xml() method?", "input": "OpenMC Python API Plots.export_to_xml() parameter path", "output": "The path parameter path to file to write. defaults to 'plots.xml'.. It should be a str value." }, { "instruction": "What does the from_xml_element() method do in the Plots class?", "input": "OpenMC Python API Plots.from_xml_element() method", "output": "The from_xml_element() method generate plots collection from xml file. It's used for plots operations." }, { "instruction": "How do you call the from_xml_element() method in the Plots class?", "input": "OpenMC Python API Plots.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Plots.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the from_xml() method do in the Plots class?", "input": "OpenMC Python API Plots.from_xml() method", "output": "The from_xml() method generate plots collection from xml file. It's used for plots operations." }, { "instruction": "How do you call the from_xml() method in the Plots class?", "input": "OpenMC Python API Plots.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the from_xml() method?", "input": "OpenMC Python API Plots.from_xml() parameter path", "output": "The path parameter path to plots xml file. It should be a str, optional value." }, { "instruction": "How do you call the add_plot_params() function in OpenMC's Python API?", "input": "OpenMC Python API add_plot_params() function signature", "output": "To call the add_plot_params() function, use: def add_plot_params(func: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_plot_image() function in OpenMC's Python API?", "input": "OpenMC Python API _get_plot_image() function signature", "output": "To call the _get_plot_image() function, use: def _get_plot_image(plot: Any, cwd: Any). It takes 2 parameters." }, { "instruction": "What does the voxel_to_vtk() function do in OpenMC's Python API?", "input": "OpenMC Python API voxel_to_vtk() function", "output": "The voxel_to_vtk() function converts a voxel hdf5 file to a vtk file .. versionadded:: 0.14.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the voxel_to_vtk() function in OpenMC's Python API?", "input": "OpenMC Python API voxel_to_vtk() function purpose", "output": "The voxel_to_vtk() function converts a voxel hdf5 file to a vtk file .. versionadded:: 0.14.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the voxel_to_vtk() function in OpenMC's Python API?", "input": "OpenMC Python API voxel_to_vtk() function signature", "output": "To call the voxel_to_vtk() function, use: def voxel_to_vtk(voxel_file: PathLike, output: PathLike). It takes 2 parameters." }, { "instruction": "What does the voxel_file parameter do in the voxel_to_vtk() function?", "input": "OpenMC Python API voxel_to_vtk() parameter voxel_file", "output": "The voxel_file parameter path of the input h5 to convert. It should be a path-like value." }, { "instruction": "What does the output parameter do in the voxel_to_vtk() function?", "input": "OpenMC Python API voxel_to_vtk() parameter output", "output": "The output parameter path of the output vti file produced. It should be a path-like value." }, { "instruction": "What does the _get_legend_label() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_legend_label() function", "output": "The _get_legend_label() function gets a label for the element or nuclide or material and reaction plotted. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_legend_label() function in OpenMC's Python API?", "input": "OpenMC Python API _get_legend_label() function purpose", "output": "The _get_legend_label() function gets a label for the element or nuclide or material and reaction plotted. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_legend_label() function in OpenMC's Python API?", "input": "OpenMC Python API _get_legend_label() function signature", "output": "To call the _get_legend_label() function, use: def _get_legend_label(this: Any, type: Any). It takes 2 parameters." }, { "instruction": "What does the _get_yaxis_label() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_yaxis_label() function", "output": "The _get_yaxis_label() function gets a y axis label for the type of data plotted. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_yaxis_label() function in OpenMC's Python API?", "input": "OpenMC Python API _get_yaxis_label() function purpose", "output": "The _get_yaxis_label() function gets a y axis label for the type of data plotted. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_yaxis_label() function in OpenMC's Python API?", "input": "OpenMC Python API _get_yaxis_label() function signature", "output": "To call the _get_yaxis_label() function, use: def _get_yaxis_label(reactions: Any, divisor_types: Any). It takes 2 parameters." }, { "instruction": "What does the _get_title() function do in OpenMC's Python API?", "input": "OpenMC Python API _get_title() function", "output": "The _get_title() function gets a title for the type of data plotted. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _get_title() function in OpenMC's Python API?", "input": "OpenMC Python API _get_title() function purpose", "output": "The _get_title() function gets a title for the type of data plotted. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _get_title() function in OpenMC's Python API?", "input": "OpenMC Python API _get_title() function signature", "output": "To call the _get_title() function, use: def _get_title(reactions: Any). It takes 1 parameters." }, { "instruction": "What does the plot_xs() function do in OpenMC's Python API?", "input": "OpenMC Python API plot_xs() function", "output": "The plot_xs() function creates a figure of continuous-energy cross sections for this item. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the plot_xs() function in OpenMC's Python API?", "input": "OpenMC Python API plot_xs() function purpose", "output": "The plot_xs() function creates a figure of continuous-energy cross sections for this item. It's part of OpenMC's Python API." }, { "instruction": "How do you call the plot_xs() function in OpenMC's Python API?", "input": "OpenMC Python API plot_xs() function signature", "output": "To call the plot_xs() function, use: def plot_xs(reactions: Any, divisor_types: Any, temperature: float, axis: Any, sab_name: Any, ce_cross_sections: Any, mg_cross_sections: Any, enrichment: Any, plot_CE: bool, orders: Any, divisor_orders: Any, energy_axis_units: str). It takes 12 parameters." }, { "instruction": "What does the reactions parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter reactions", "output": "The reactions parameter keys can be either a nuclide or element in string form or an openmc.material object. values are a list of the types of cross sections to include in the plot.. It should be a dict value." }, { "instruction": "What does the divisor_types parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter divisor_types", "output": "The divisor_types parameter cross section types which will divide those produced by types before plotting. a type of 'unity' can be used to effectively not divide some types.. It should be a Iterable of values of PLOT_TYPES, optional value." }, { "instruction": "What does the temperature parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter temperature", "output": "The temperature parameter temperature in kelvin to plot. if not specified, a default temperature of 294k will be plotted. note that the nearest temperature in the library for each nuclide will be used as opposed to using any interpolation.. It should be a float, optional value." }, { "instruction": "What does the axis parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter axis", "output": "The axis parameter a previously generated axis to use for plotting. if not specified, a new axis and figure will be generated.. It should be a matplotlib.axes, optional value." }, { "instruction": "What does the sab_name parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter sab_name", "output": "The sab_name parameter name of s(a,b) library to apply to mt=2 data when applicable.. It should be a str, optional value." }, { "instruction": "What does the ce_cross_sections parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter ce_cross_sections", "output": "The ce_cross_sections parameter location of cross_sections.xml file. default is none.. It should be a str, optional value." }, { "instruction": "What does the mg_cross_sections parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter mg_cross_sections", "output": "The mg_cross_sections parameter location of mgxs hdf5 library file. default is none.. It should be a str, optional value." }, { "instruction": "What does the enrichment parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter enrichment", "output": "The enrichment parameter enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none.. It should be a float, optional value." }, { "instruction": "What does the plot_CE parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter plot_CE", "output": "The plot_CE parameter denotes whether or not continuous-energy will be plotted. defaults to plotting the continuous-energy data.. It should be a bool, optional value." }, { "instruction": "What does the orders parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter orders", "output": "The orders parameter the scattering order or delayed group index to use for the corresponding entry in types. defaults to the 0th order for scattering and the total delayed neutron data. this only applies to plots of multi-group data.. It should be a Iterable of Integral, optional value." }, { "instruction": "What does the divisor_orders parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter divisor_orders", "output": "The divisor_orders parameter same as orders, but for divisor_types **kwargs : all keyword arguments are passed to :func:`matplotlib.pyplot.figure`.. It should be a Iterable of Integral, optional value." }, { "instruction": "What does the energy_axis_units parameter do in the plot_xs() function?", "input": "OpenMC Python API plot_xs() parameter energy_axis_units", "output": "The energy_axis_units parameter units used on the plot energy axis .. versionadded:: 0.15.0. It should be a {'eV', 'keV', 'MeV'} value." }, { "instruction": "What does the plot_xs() function return in OpenMC's Python API?", "input": "OpenMC Python API plot_xs() return value", "output": "The plot_xs() function returns if axis is none, then a matplotlib figure of the generated cross section will be returned. otherwise, a value of none will be returned as the figure and axes have already been generated.. The return type is matplotlib.figure.Figure." }, { "instruction": "What does the calculate_cexs() function do in OpenMC's Python API?", "input": "OpenMC Python API calculate_cexs() function", "output": "The calculate_cexs() function calculates continuous-energy cross sections of a requested type. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the calculate_cexs() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_cexs() function purpose", "output": "The calculate_cexs() function calculates continuous-energy cross sections of a requested type. It's part of OpenMC's Python API." }, { "instruction": "How do you call the calculate_cexs() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_cexs() function signature", "output": "To call the calculate_cexs() function, use: def calculate_cexs(this: Any, types: Any, temperature: Any, sab_name: Any, cross_sections: Any, enrichment: Any, ncrystal_cfg: Any). It takes 7 parameters." }, { "instruction": "What does the this parameter do in the calculate_cexs() function?", "input": "OpenMC Python API calculate_cexs() parameter this", "output": "The this parameter object to source data from. nuclides and elements should be input as a str. It should be a str or openmc.Material value." }, { "instruction": "What does the types parameter do in the calculate_cexs() function?", "input": "OpenMC Python API calculate_cexs() parameter types", "output": "The types parameter the type of cross sections to calculate. It should be a Iterable of values of PLOT_TYPES value." }, { "instruction": "What does the temperature parameter do in the calculate_cexs() function?", "input": "OpenMC Python API calculate_cexs() parameter temperature", "output": "The temperature parameter temperature in kelvin to plot. if not specified, a default temperature of 294k will be plotted. note that the nearest temperature in the library for each nuclide will be used as opposed to using any interpolation.. It should be a float, optional value." }, { "instruction": "What does the sab_name parameter do in the calculate_cexs() function?", "input": "OpenMC Python API calculate_cexs() parameter sab_name", "output": "The sab_name parameter name of s(a,b) library to apply to mt=2 data when applicable.. It should be a str, optional value." }, { "instruction": "What does the cross_sections parameter do in the calculate_cexs() function?", "input": "OpenMC Python API calculate_cexs() parameter cross_sections", "output": "The cross_sections parameter location of cross_sections.xml file. default is none.. It should be a str, optional value." }, { "instruction": "What does the enrichment parameter do in the calculate_cexs() function?", "input": "OpenMC Python API calculate_cexs() parameter enrichment", "output": "The enrichment parameter enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none (natural composition).. It should be a float, optional value." }, { "instruction": "What does the ncrystal_cfg parameter do in the calculate_cexs() function?", "input": "OpenMC Python API calculate_cexs() parameter ncrystal_cfg", "output": "The ncrystal_cfg parameter configuration string for ncrystal material.. It should be a str, optional value." }, { "instruction": "What does the calculate_cexs() function return in OpenMC's Python API?", "input": "OpenMC Python API calculate_cexs() return value", "output": "The calculate_cexs() function returns energies at which cross sections are calculated, in units of ev. The return type is numpy.ndarray." }, { "instruction": "What does the calculate_cexs() function return in OpenMC's Python API?", "input": "OpenMC Python API calculate_cexs() return value", "output": "The calculate_cexs() function returns cross sections calculated at the energy grid described by energy_grid. The return type is numpy.ndarray." }, { "instruction": "What does the _calculate_cexs_nuclide() function do in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_nuclide() function", "output": "The _calculate_cexs_nuclide() function calculates continuous-energy cross sections of a requested type. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _calculate_cexs_nuclide() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_nuclide() function purpose", "output": "The _calculate_cexs_nuclide() function calculates continuous-energy cross sections of a requested type. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _calculate_cexs_nuclide() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_nuclide() function signature", "output": "To call the _calculate_cexs_nuclide() function, use: def _calculate_cexs_nuclide(this: Any, types: Any, temperature: Any, sab_name: Any, cross_sections: Any, ncrystal_cfg: Any). It takes 6 parameters." }, { "instruction": "What does the this parameter do in the _calculate_cexs_nuclide() function?", "input": "OpenMC Python API _calculate_cexs_nuclide() parameter this", "output": "The this parameter nuclide object to source data from. It should be a str value." }, { "instruction": "What does the types parameter do in the _calculate_cexs_nuclide() function?", "input": "OpenMC Python API _calculate_cexs_nuclide() parameter types", "output": "The types parameter the type of cross sections to calculate; values can either be those in openmc.plot_types or keys from openmc.data.reaction_mt which correspond to a reaction description e.g '(n,2n)' or integers which correspond to reaction channel (mt) numbers.. It should be a Iterable of str or Integral value." }, { "instruction": "What does the temperature parameter do in the _calculate_cexs_nuclide() function?", "input": "OpenMC Python API _calculate_cexs_nuclide() parameter temperature", "output": "The temperature parameter temperature in kelvin to plot. if not specified, a default temperature of 294k will be plotted. note that the nearest temperature in the library for each nuclide will be used as opposed to using any interpolation.. It should be a float, optional value." }, { "instruction": "What does the sab_name parameter do in the _calculate_cexs_nuclide() function?", "input": "OpenMC Python API _calculate_cexs_nuclide() parameter sab_name", "output": "The sab_name parameter name of s(a,b) library to apply to mt=2 data when applicable.. It should be a str, optional value." }, { "instruction": "What does the cross_sections parameter do in the _calculate_cexs_nuclide() function?", "input": "OpenMC Python API _calculate_cexs_nuclide() parameter cross_sections", "output": "The cross_sections parameter location of cross_sections.xml file. default is none.. It should be a str, optional value." }, { "instruction": "What does the ncrystal_cfg parameter do in the _calculate_cexs_nuclide() function?", "input": "OpenMC Python API _calculate_cexs_nuclide() parameter ncrystal_cfg", "output": "The ncrystal_cfg parameter configuration string for ncrystal material.. It should be a str, optional value." }, { "instruction": "What does the _calculate_cexs_nuclide() function return in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_nuclide() return value", "output": "The _calculate_cexs_nuclide() function returns energies at which cross sections are calculated, in units of ev. The return type is numpy.ndarray." }, { "instruction": "What does the _calculate_cexs_nuclide() function return in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_nuclide() return value", "output": "The _calculate_cexs_nuclide() function returns requested cross section functions. The return type is Iterable of Callable." }, { "instruction": "What does the _calculate_cexs_elem_mat() function do in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_elem_mat() function", "output": "The _calculate_cexs_elem_mat() function calculates continuous-energy cross sections of a requested type. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _calculate_cexs_elem_mat() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_elem_mat() function purpose", "output": "The _calculate_cexs_elem_mat() function calculates continuous-energy cross sections of a requested type. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _calculate_cexs_elem_mat() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_elem_mat() function signature", "output": "To call the _calculate_cexs_elem_mat() function, use: def _calculate_cexs_elem_mat(this: Any, types: Any, temperature: Any, cross_sections: Any, sab_name: Any, enrichment: Any). It takes 6 parameters." }, { "instruction": "What does the this parameter do in the _calculate_cexs_elem_mat() function?", "input": "OpenMC Python API _calculate_cexs_elem_mat() parameter this", "output": "The this parameter object to source data from. element can be input as str. It should be a openmc.Material or str value." }, { "instruction": "What does the types parameter do in the _calculate_cexs_elem_mat() function?", "input": "OpenMC Python API _calculate_cexs_elem_mat() parameter types", "output": "The types parameter the type of cross sections to calculate. It should be a Iterable of values of PLOT_TYPES value." }, { "instruction": "What does the temperature parameter do in the _calculate_cexs_elem_mat() function?", "input": "OpenMC Python API _calculate_cexs_elem_mat() parameter temperature", "output": "The temperature parameter temperature in kelvin to plot. if not specified, a default temperature of 294k will be plotted. note that the nearest temperature in the library for each nuclide will be used as opposed to using any interpolation.. It should be a float, optional value." }, { "instruction": "What does the cross_sections parameter do in the _calculate_cexs_elem_mat() function?", "input": "OpenMC Python API _calculate_cexs_elem_mat() parameter cross_sections", "output": "The cross_sections parameter location of cross_sections.xml file. default is none.. It should be a str, optional value." }, { "instruction": "What does the sab_name parameter do in the _calculate_cexs_elem_mat() function?", "input": "OpenMC Python API _calculate_cexs_elem_mat() parameter sab_name", "output": "The sab_name parameter name of s(a,b) library to apply to mt=2 data when applicable.. It should be a str, optional value." }, { "instruction": "What does the enrichment parameter do in the _calculate_cexs_elem_mat() function?", "input": "OpenMC Python API _calculate_cexs_elem_mat() parameter enrichment", "output": "The enrichment parameter enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none (natural composition).. It should be a float, optional value." }, { "instruction": "What does the _calculate_cexs_elem_mat() function return in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_elem_mat() return value", "output": "The _calculate_cexs_elem_mat() function returns energies at which cross sections are calculated, in units of ev. The return type is numpy.ndarray." }, { "instruction": "What does the _calculate_cexs_elem_mat() function return in OpenMC's Python API?", "input": "OpenMC Python API _calculate_cexs_elem_mat() return value", "output": "The _calculate_cexs_elem_mat() function returns cross sections calculated at the energy grid described by energy_grid. The return type is numpy.ndarray." }, { "instruction": "What does the calculate_mgxs() function do in OpenMC's Python API?", "input": "OpenMC Python API calculate_mgxs() function", "output": "The calculate_mgxs() function calculates multi-group cross sections of a requested type. if the data for the nuclide or macroscopic object in the library is represented as angle-dependent data then this method will return the geometric average cross section over all angles. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the calculate_mgxs() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_mgxs() function purpose", "output": "The calculate_mgxs() function calculates multi-group cross sections of a requested type. if the data for the nuclide or macroscopic object in the library is represented as angle-dependent data then this method will return the geometric average cross section over all angles. It's part of OpenMC's Python API." }, { "instruction": "How do you call the calculate_mgxs() function in OpenMC's Python API?", "input": "OpenMC Python API calculate_mgxs() function signature", "output": "To call the calculate_mgxs() function, use: def calculate_mgxs(this: Any, types: Any, orders: Any, temperature: Any, cross_sections: Any, ce_cross_sections: Any, enrichment: Any). It takes 7 parameters." }, { "instruction": "What does the this parameter do in the calculate_mgxs() function?", "input": "OpenMC Python API calculate_mgxs() parameter this", "output": "The this parameter object to source data from. nuclides and elements can be input as a str. It should be a str or openmc.Material value." }, { "instruction": "What does the types parameter do in the calculate_mgxs() function?", "input": "OpenMC Python API calculate_mgxs() parameter types", "output": "The types parameter the type of cross sections to calculate. It should be a Iterable of values of PLOT_TYPES_MGXS value." }, { "instruction": "What does the orders parameter do in the calculate_mgxs() function?", "input": "OpenMC Python API calculate_mgxs() parameter orders", "output": "The orders parameter the scattering order or delayed group index to use for the corresponding entry in types. defaults to the 0th order for scattering and the total delayed neutron data.. It should be a Iterable of Integral, optional value." }, { "instruction": "What does the temperature parameter do in the calculate_mgxs() function?", "input": "OpenMC Python API calculate_mgxs() parameter temperature", "output": "The temperature parameter temperature in kelvin to plot. if not specified, a default temperature of 294k will be plotted. note that the nearest temperature in the library for each nuclide will be used as opposed to using any interpolation.. It should be a float, optional value." }, { "instruction": "What does the cross_sections parameter do in the calculate_mgxs() function?", "input": "OpenMC Python API calculate_mgxs() parameter cross_sections", "output": "The cross_sections parameter location of mgxs hdf5 library file. default is none.. It should be a str, optional value." }, { "instruction": "What does the ce_cross_sections parameter do in the calculate_mgxs() function?", "input": "OpenMC Python API calculate_mgxs() parameter ce_cross_sections", "output": "The ce_cross_sections parameter location of continuous-energy cross_sections.xml file. default is none.. It should be a str, optional value." }, { "instruction": "What does the enrichment parameter do in the calculate_mgxs() function?", "input": "OpenMC Python API calculate_mgxs() parameter enrichment", "output": "The enrichment parameter enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none (natural composition).. It should be a float, optional value." }, { "instruction": "What does the calculate_mgxs() function return in OpenMC's Python API?", "input": "OpenMC Python API calculate_mgxs() return value", "output": "The calculate_mgxs() function returns energies at which cross sections are calculated, in units of ev. The return type is numpy.ndarray." }, { "instruction": "What does the calculate_mgxs() function return in OpenMC's Python API?", "input": "OpenMC Python API calculate_mgxs() return value", "output": "The calculate_mgxs() function returns cross sections calculated at the energy grid described by energy_grid. The return type is numpy.ndarray." }, { "instruction": "What does the _calculate_mgxs_nuc_macro() function do in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() function", "output": "The _calculate_mgxs_nuc_macro() function determines the multi-group cross sections of a nuclide or macroscopic object. if the data for the nuclide or macroscopic object in the library is represented as angle-dependent data then this method will return the geometric average cross section over all angles. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _calculate_mgxs_nuc_macro() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() function purpose", "output": "The _calculate_mgxs_nuc_macro() function determines the multi-group cross sections of a nuclide or macroscopic object. if the data for the nuclide or macroscopic object in the library is represented as angle-dependent data then this method will return the geometric average cross section over all angles. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _calculate_mgxs_nuc_macro() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() function signature", "output": "To call the _calculate_mgxs_nuc_macro() function, use: def _calculate_mgxs_nuc_macro(this: Any, types: Any, library: Any, orders: Any, temperature: Any). It takes 5 parameters." }, { "instruction": "What does the this parameter do in the _calculate_mgxs_nuc_macro() function?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() parameter this", "output": "The this parameter object to source data from. It should be a str value." }, { "instruction": "What does the types parameter do in the _calculate_mgxs_nuc_macro() function?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() parameter types", "output": "The types parameter the type of cross sections to calculate; values can either be those in openmc.plot_types_mgxs. It should be a Iterable of str value." }, { "instruction": "What does the library parameter do in the _calculate_mgxs_nuc_macro() function?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() parameter library", "output": "The library parameter mgxs library containing the data of interest. It should be a openmc.MGXSLibrary value." }, { "instruction": "What does the orders parameter do in the _calculate_mgxs_nuc_macro() function?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() parameter orders", "output": "The orders parameter the scattering order or delayed group index to use for the corresponding entry in types. defaults to the 0th order for scattering and the total delayed neutron data.. It should be a Iterable of Integral, optional value." }, { "instruction": "What does the temperature parameter do in the _calculate_mgxs_nuc_macro() function?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() parameter temperature", "output": "The temperature parameter temperature in kelvin to plot. if not specified, a default temperature of 294k will be plotted. note that the nearest temperature in the library for each nuclide will be used as opposed to using any interpolation.. It should be a float, optional value." }, { "instruction": "What does the _calculate_mgxs_nuc_macro() function return in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_nuc_macro() return value", "output": "The _calculate_mgxs_nuc_macro() function returns cross sections calculated at the energy grid described by energy_grid. The return type is numpy.ndarray." }, { "instruction": "What does the _calculate_mgxs_elem_mat() function do in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() function", "output": "The _calculate_mgxs_elem_mat() function determines the multi-group cross sections of an element or material object. if the data for the nuclide or macroscopic object in the library is represented as angle-dependent data then this method will return the geometric average cross section over all angles. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _calculate_mgxs_elem_mat() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() function purpose", "output": "The _calculate_mgxs_elem_mat() function determines the multi-group cross sections of an element or material object. if the data for the nuclide or macroscopic object in the library is represented as angle-dependent data then this method will return the geometric average cross section over all angles. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _calculate_mgxs_elem_mat() function in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() function signature", "output": "To call the _calculate_mgxs_elem_mat() function, use: def _calculate_mgxs_elem_mat(this: Any, types: Any, library: Any, orders: Any, temperature: Any, ce_cross_sections: Any, enrichment: Any). It takes 7 parameters." }, { "instruction": "What does the this parameter do in the _calculate_mgxs_elem_mat() function?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() parameter this", "output": "The this parameter object to source data from. elements can be input as a str. It should be a str or openmc.Material value." }, { "instruction": "What does the types parameter do in the _calculate_mgxs_elem_mat() function?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() parameter types", "output": "The types parameter the type of cross sections to calculate; values can either be those in openmc.plot_types_mgxs. It should be a Iterable of str value." }, { "instruction": "What does the library parameter do in the _calculate_mgxs_elem_mat() function?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() parameter library", "output": "The library parameter mgxs library containing the data of interest. It should be a openmc.MGXSLibrary value." }, { "instruction": "What does the orders parameter do in the _calculate_mgxs_elem_mat() function?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() parameter orders", "output": "The orders parameter the scattering order or delayed group index to use for the corresponding entry in types. defaults to the 0th order for scattering and the total delayed neutron data.. It should be a Iterable of Integral, optional value." }, { "instruction": "What does the temperature parameter do in the _calculate_mgxs_elem_mat() function?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() parameter temperature", "output": "The temperature parameter temperature in kelvin to plot. if not specified, a default temperature of 294k will be plotted. note that the nearest temperature in the library for each nuclide will be used as opposed to using any interpolation.. It should be a float, optional value." }, { "instruction": "What does the ce_cross_sections parameter do in the _calculate_mgxs_elem_mat() function?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() parameter ce_cross_sections", "output": "The ce_cross_sections parameter location of continuous-energy cross_sections.xml file. default is none. this is used only for expanding the elements. It should be a str, optional value." }, { "instruction": "What does the enrichment parameter do in the _calculate_mgxs_elem_mat() function?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() parameter enrichment", "output": "The enrichment parameter enrichment for u235 in weight percent. for example, input 4.95 for 4.95 weight percent enriched u. default is none (natural composition).. It should be a float, optional value." }, { "instruction": "What does the _calculate_mgxs_elem_mat() function return in OpenMC's Python API?", "input": "OpenMC Python API _calculate_mgxs_elem_mat() return value", "output": "The _calculate_mgxs_elem_mat() function returns cross sections calculated at the energy grid described by energy_grid. The return type is numpy.ndarray." }, { "instruction": "What is the Polynomial class in OpenMC's Python API?", "input": "OpenMC Python API Polynomial class", "output": "The Polynomial class represents abstract polynomial class for creating polynomials.. It provides 1 methods and 0 properties for working with polynomial data in OpenMC." }, { "instruction": "What does the Polynomial class do in OpenMC's Python API?", "input": "OpenMC Python API Polynomial class description", "output": "The Polynomial class abstract polynomial class for creating polynomials.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the Polynomial class?", "input": "OpenMC Python API Polynomial.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, coef: Any). It takes 2 parameters." }, { "instruction": "What is the ZernikeRadial class in OpenMC's Python API?", "input": "OpenMC Python API ZernikeRadial class", "output": "The ZernikeRadial class represents create radial only zernike polynomials given coefficients and domain. the radial only zernike polynomials are defined as in :class:`zernikeradialfilter`. .. versionadded:: 0.12. It provides 3 methods and 0 properties for working with zernikeradial data in OpenMC." }, { "instruction": "What does the ZernikeRadial class do in OpenMC's Python API?", "input": "OpenMC Python API ZernikeRadial class description", "output": "The ZernikeRadial class create radial only zernike polynomials given coefficients and domain. the radial only zernike polynomials are defined as in :class:`zernikeradialfilter`. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the coef parameter do when creating a ZernikeRadial?", "input": "OpenMC Python API ZernikeRadial constructor parameter coef", "output": "When creating a ZernikeRadial, the coef parameter specifies a list of coefficients of each term in radial only zernike polynomials. It should be a Iterable of float value." }, { "instruction": "What does the radius parameter do when creating a ZernikeRadial?", "input": "OpenMC Python API ZernikeRadial constructor parameter radius", "output": "When creating a ZernikeRadial, the radius parameter specifies domain of zernike polynomials to be applied on. default is 1.. It should be a float value." }, { "instruction": "What is the order attribute of a ZernikeRadial?", "input": "OpenMC Python API ZernikeRadial attribute order", "output": "The order attribute of a ZernikeRadial contains the maximum (even) order of zernike polynomials.. It's a int value that you can access after creating a ZernikeRadial instance." }, { "instruction": "What is the radius attribute of a ZernikeRadial?", "input": "OpenMC Python API ZernikeRadial attribute radius", "output": "The radius attribute of a ZernikeRadial contains domain of zernike polynomials to be applied on. default is 1.. It's a float value that you can access after creating a ZernikeRadial instance." }, { "instruction": "What is the norm_coef attribute of a ZernikeRadial?", "input": "OpenMC Python API ZernikeRadial attribute norm_coef", "output": "The norm_coef attribute of a ZernikeRadial contains the list of coefficients of each term in the polynomials after normalization.. It's a iterable of float value that you can access after creating a ZernikeRadial instance." }, { "instruction": "How do you call the __init__() method in the ZernikeRadial class?", "input": "OpenMC Python API ZernikeRadial.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, coef: Any, radius: Any). It takes 3 parameters." }, { "instruction": "How do you call the order() method in the ZernikeRadial class?", "input": "OpenMC Python API ZernikeRadial.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __call__() method in the ZernikeRadial class?", "input": "OpenMC Python API ZernikeRadial.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, r: Any). It takes 2 parameters." }, { "instruction": "What is the Zernike class in OpenMC's Python API?", "input": "OpenMC Python API Zernike class", "output": "The Zernike class represents create zernike polynomials given coefficients and domain. the azimuthal zernike polynomials are defined as in :class:`zernikefilter`. .. versionadded:: 0.12. It provides 3 methods and 0 properties for working with zernike data in OpenMC." }, { "instruction": "What does the Zernike class do in OpenMC's Python API?", "input": "OpenMC Python API Zernike class description", "output": "The Zernike class create zernike polynomials given coefficients and domain. the azimuthal zernike polynomials are defined as in :class:`zernikefilter`. .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the coef parameter do when creating a Zernike?", "input": "OpenMC Python API Zernike constructor parameter coef", "output": "When creating a Zernike, the coef parameter specifies a list of coefficients of each term in zernike polynomials. It should be a Iterable of float value." }, { "instruction": "What does the radius parameter do when creating a Zernike?", "input": "OpenMC Python API Zernike constructor parameter radius", "output": "When creating a Zernike, the radius parameter specifies domain of zernike polynomials to be applied on. default is 1.. It should be a float value." }, { "instruction": "What is the order attribute of a Zernike?", "input": "OpenMC Python API Zernike attribute order", "output": "The order attribute of a Zernike contains the maximum (even) order of zernike polynomials.. It's a int value that you can access after creating a Zernike instance." }, { "instruction": "What is the radius attribute of a Zernike?", "input": "OpenMC Python API Zernike attribute radius", "output": "The radius attribute of a Zernike contains domain of zernike polynomials to be applied on. default is 1.. It's a float value that you can access after creating a Zernike instance." }, { "instruction": "What is the theta attribute of a Zernike?", "input": "OpenMC Python API Zernike attribute theta", "output": "The theta attribute of a Zernike contains azimuthal of zernike polynomial to be applied on. default is 0.. It's a float value that you can access after creating a Zernike instance." }, { "instruction": "What is the norm_coef attribute of a Zernike?", "input": "OpenMC Python API Zernike attribute norm_coef", "output": "The norm_coef attribute of a Zernike contains the list of coefficients of each term in the polynomials after normalization.. It's a iterable of float value that you can access after creating a Zernike instance." }, { "instruction": "How do you call the __init__() method in the Zernike class?", "input": "OpenMC Python API Zernike.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, coef: Any, radius: Any). It takes 3 parameters." }, { "instruction": "How do you call the order() method in the Zernike class?", "input": "OpenMC Python API Zernike.order() method signature", "output": "To call the order() method, use: @property def order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __call__() method in the Zernike class?", "input": "OpenMC Python API Zernike.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, r: Any, theta: Any). It takes 3 parameters." }, { "instruction": "What does the legendre_from_expcoef() function do in OpenMC's Python API?", "input": "OpenMC Python API legendre_from_expcoef() function", "output": "The legendre_from_expcoef() function return a legendre series object based on expansion coefficients. given a list of coefficients from fet tally and a array of down, return the numpy legendre object. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the legendre_from_expcoef() function in OpenMC's Python API?", "input": "OpenMC Python API legendre_from_expcoef() function purpose", "output": "The legendre_from_expcoef() function return a legendre series object based on expansion coefficients. given a list of coefficients from fet tally and a array of down, return the numpy legendre object. It's part of OpenMC's Python API." }, { "instruction": "How do you call the legendre_from_expcoef() function in OpenMC's Python API?", "input": "OpenMC Python API legendre_from_expcoef() function signature", "output": "To call the legendre_from_expcoef() function, use: def legendre_from_expcoef(coef: Any, domain: Any). It takes 2 parameters." }, { "instruction": "What does the coef parameter do in the legendre_from_expcoef() function?", "input": "OpenMC Python API legendre_from_expcoef() parameter coef", "output": "The coef parameter a list of coefficients of each term in legendre polynomials. It should be a Iterable of float value." }, { "instruction": "What does the domain parameter do in the legendre_from_expcoef() function?", "input": "OpenMC Python API legendre_from_expcoef() parameter domain", "output": "The domain parameter domain of the legendre polynomial. It should be a (2,) List of float value." }, { "instruction": "What is the Region class in OpenMC's Python API?", "input": "OpenMC Python API Region class", "output": "The Region class represents region of space that can be assigned to a cell. region is an abstract base class that is inherited by :class:`openmc.halfspace`, :class:`openmc.intersection`, :class:`openmc.union`, and :class:`openmc.complement`. each of those respective classes are typically not instantiated directly but rather are created through operators of the surface and region classes. It provides 14 methods and 0 properties for working with region data in OpenMC." }, { "instruction": "What does the Region class do in OpenMC's Python API?", "input": "OpenMC Python API Region class description", "output": "The Region class region of space that can be assigned to a cell. region is an abstract base class that is inherited by :class:`openmc.halfspace`, :class:`openmc.intersection`, :class:`openmc.union`, and :class:`openmc.complement`. each of those respective classes are typically not instantiated directly but rather are created through operators of the surface and region classes. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the bounding_box attribute of a Region?", "input": "OpenMC Python API Region attribute bounding_box", "output": "The bounding_box attribute of a Region contains axis-aligned bounding box of the region. It's a openmc.BoundingBox value that you can access after creating a Region instance." }, { "instruction": "How do you call the __and__() method in the Region class?", "input": "OpenMC Python API Region.__and__() method signature", "output": "To call the __and__() method, use: def __and__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __or__() method in the Region class?", "input": "OpenMC Python API Region.__or__() method signature", "output": "To call the __or__() method, use: def __or__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __invert__() method in the Region class?", "input": "OpenMC Python API Region.__invert__() method signature", "output": "To call the __invert__() method, use: @abstractmethod def __invert__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __contains__() method in the Region class?", "input": "OpenMC Python API Region.__contains__() method signature", "output": "To call the __contains__() method, use: @abstractmethod def __contains__(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the Region class?", "input": "OpenMC Python API Region.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property, @abstractmethod def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __str__() method in the Region class?", "input": "OpenMC Python API Region.__str__() method signature", "output": "To call the __str__() method, use: @abstractmethod def __str__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the Region class?", "input": "OpenMC Python API Region.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the get_surfaces() method do in the Region class?", "input": "OpenMC Python API Region.get_surfaces() method", "output": "The get_surfaces() method recursively find all surfaces referenced by a region and return them. It's used for region operations." }, { "instruction": "How do you call the get_surfaces() method in the Region class?", "input": "OpenMC Python API Region.get_surfaces() method signature", "output": "To call the get_surfaces() method, use: def get_surfaces(self: Any, surfaces: Any). It takes 2 parameters." }, { "instruction": "What does the surfaces parameter do in the get_surfaces() method?", "input": "OpenMC Python API Region.get_surfaces() parameter surfaces", "output": "The surfaces parameter dictionary mapping surface ids to :class:`openmc.surface` instances. It should be a dict, optional value." }, { "instruction": "What does the get_surfaces() method return in the Region class?", "input": "OpenMC Python API Region.get_surfaces() return value", "output": "The get_surfaces() method returns dictionary mapping surface ids to :class:`openmc.surface` instances. The return type is dict." }, { "instruction": "What does the remove_redundant_surfaces() method do in the Region class?", "input": "OpenMC Python API Region.remove_redundant_surfaces() method", "output": "The remove_redundant_surfaces() method recursively remove all redundant surfaces referenced by this region .. versionadded:: 0.12. It's used for region operations." }, { "instruction": "How do you call the remove_redundant_surfaces() method in the Region class?", "input": "OpenMC Python API Region.remove_redundant_surfaces() method signature", "output": "To call the remove_redundant_surfaces() method, use: def remove_redundant_surfaces(self: Any, redundant_surfaces: Any). It takes 2 parameters." }, { "instruction": "What does the redundant_surfaces parameter do in the remove_redundant_surfaces() method?", "input": "OpenMC Python API Region.remove_redundant_surfaces() parameter redundant_surfaces", "output": "The redundant_surfaces parameter dictionary mapping redundant surface ids to class:`openmc.surface` instances that should replace them.. It should be a dict value." }, { "instruction": "What does the from_expression() method do in the Region class?", "input": "OpenMC Python API Region.from_expression() method", "output": "The from_expression() method generate a region given an infix expression. It's used for region operations." }, { "instruction": "How do you call the from_expression() method in the Region class?", "input": "OpenMC Python API Region.from_expression() method signature", "output": "To call the from_expression() method, use: @staticmethod def from_expression(expression: Any, surfaces: Any). It takes 2 parameters." }, { "instruction": "What does the expression parameter do in the from_expression() method?", "input": "OpenMC Python API Region.from_expression() parameter expression", "output": "The expression parameter boolean expression relating surface half-spaces. the possible operators are union '|', intersection ' ', and complement '~'. for example, '(1 -2) | 3 ~(4 -5)'.. It should be a str value." }, { "instruction": "What does the surfaces parameter do in the from_expression() method?", "input": "OpenMC Python API Region.from_expression() parameter surfaces", "output": "The surfaces parameter dictionary whose keys are surface ids that appear in the boolean expression and whose values are surface objects.. It should be a dict value." }, { "instruction": "What does the clone() method do in the Region class?", "input": "OpenMC Python API Region.clone() method", "output": "The clone() method create a copy of this region - each of the surfaces in the region's nodes will be cloned and will have new unique ids. It's used for region operations." }, { "instruction": "How do you call the clone() method in the Region class?", "input": "OpenMC Python API Region.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the memo parameter do in the clone() method?", "input": "OpenMC Python API Region.clone() parameter memo", "output": "The memo parameter a nested dictionary of previously cloned objects. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the clone() method return in the Region class?", "input": "OpenMC Python API Region.clone() return value", "output": "The clone() method returns the clone of this region. The return type is openmc.Region." }, { "instruction": "What does the translate() method do in the Region class?", "input": "OpenMC Python API Region.translate() method", "output": "The translate() method translate region in given direction. It's used for region operations." }, { "instruction": "How do you call the translate() method in the Region class?", "input": "OpenMC Python API Region.translate() method signature", "output": "To call the translate() method, use: def translate(self: Any, vector: Any, inplace: Any, memo: Any). It takes 4 parameters." }, { "instruction": "What does the vector parameter do in the translate() method?", "input": "OpenMC Python API Region.translate() parameter vector", "output": "The vector parameter direction in which region should be translated. It should be a iterable of float value." }, { "instruction": "What does the inplace parameter do in the translate() method?", "input": "OpenMC Python API Region.translate() parameter inplace", "output": "The inplace parameter whether or not to return a region based on new surfaces or one based on the original surfaces that have been modified. .. versionadded:: 0.13.1. It should be a bool value." }, { "instruction": "What does the memo parameter do in the translate() method?", "input": "OpenMC Python API Region.translate() parameter memo", "output": "The memo parameter dictionary used for memoization. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the rotate() method do in the Region class?", "input": "OpenMC Python API Region.rotate() method", "output": "The rotate() method rotate surface by angles provided or by applying matrix directly. .. versionadded:: 0.12. It's used for region operations." }, { "instruction": "How do you call the rotate() method in the Region class?", "input": "OpenMC Python API Region.rotate() method signature", "output": "To call the rotate() method, use: def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any, memo: Any). It takes 6 parameters." }, { "instruction": "What does the rotation parameter do in the rotate() method?", "input": "OpenMC Python API Region.rotate() parameter rotation", "output": "The rotation parameter a 3-tuple of angles :math:`(\\phi, \\theta, \\psi)` in degrees where the first element is the rotation about the x-axis in the fixed laboratory frame, the second element is the rotation about the y-axis in the fixed laboratory frame, and the third element is the rotation about the z-axis in the fixed laboratory frame. the rotations are active rotations. additionally a 3x3 rotation matrix can be specified directly either as a nested iterable or array.. It should be a 3-tuple of float, or 3x3 iterable value." }, { "instruction": "What does the pivot parameter do in the rotate() method?", "input": "OpenMC Python API Region.rotate() parameter pivot", "output": "The pivot parameter (x, y, z) coordinates for the point to rotate about. defaults to (0., 0., 0.). It should be a iterable of float, optional value." }, { "instruction": "What does the order parameter do in the rotate() method?", "input": "OpenMC Python API Region.rotate() parameter order", "output": "The order parameter a string of 'x', 'y', and 'z' in some order specifying which rotation to perform first, second, and third. defaults to 'xyz' which means, the rotation by angle :math:`\\phi` about x will be applied first, followed by :math:`\\theta` about y and then :math:`\\psi` about z. this corresponds to an x-y-z extrinsic rotation as well as a z-y'-x'' intrinsic rotation using tait-bryan. It should be a str, optional value." }, { "instruction": "What does the angles parameter do in the rotate() method?", "input": "OpenMC Python API Region.rotate() parameter angles", "output": "The angles parameter . It should be a math:`(\\phi, \\theta, \\psi)`. value." }, { "instruction": "What does the inplace parameter do in the rotate() method?", "input": "OpenMC Python API Region.rotate() parameter inplace", "output": "The inplace parameter whether or not to return a new instance of surface or to modify the coefficients of this surface in place. defaults to false.. It should be a bool value." }, { "instruction": "What does the memo parameter do in the rotate() method?", "input": "OpenMC Python API Region.rotate() parameter memo", "output": "The memo parameter dictionary used for memoization. It should be a dict or None value." }, { "instruction": "What does the plot() method do in the Region class?", "input": "OpenMC Python API Region.plot() method", "output": "The plot() method display a slice plot of the region.\n\n .. versionadded:: 0.15.0. It's used for region operations." }, { "instruction": "How do you call the plot() method in the Region class?", "input": "OpenMC Python API Region.plot() method signature", "output": "To call the plot() method, use: @add_plot_params def plot(self: Any). It takes 1 parameters." }, { "instruction": "What is the Intersection class in OpenMC's Python API?", "input": "OpenMC Python API Intersection class", "output": "The Intersection class represents intersection of two or more regions. instances of intersection are generally created via the & operator applied to two instances of :class:`openmc.region`. this is illustrated in the following example: >>> equator = openmc.zplane(z0=0.0) >>> earth = openmc.sphere(r=637.1e6) >>> northern_hemisphere = -earth & +equator >>> southern_hemisphere = -earth & -equator >>> type(northern_hemisphere) instances of this class behave like a mutable sequence, e.g., they can be indexed and have an append() method. It provides 12 methods and 0 properties for working with intersection data in OpenMC." }, { "instruction": "What does the Intersection class do in OpenMC's Python API?", "input": "OpenMC Python API Intersection class description", "output": "The Intersection class intersection of two or more regions. instances of intersection are generally created via the & operator applied to two instances of :class:`openmc.region`. this is illustrated in the following example: >>> equator = openmc.zplane(z0=0.0) >>> earth = openmc.sphere(r=637.1e6) >>> northern_hemisphere = -earth & +equator >>> southern_hemisphere = -earth & -equator >>> type(northern_hemisphere) instances of this class behave like a mutable sequence, e.g., they can be indexed and have an append() method. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the nodes parameter do when creating a Intersection?", "input": "OpenMC Python API Intersection constructor parameter nodes", "output": "When creating a Intersection, the nodes parameter specifies regions to take the intersection of. It should be a iterable of openmc.Region value." }, { "instruction": "What is the bounding_box attribute of a Intersection?", "input": "OpenMC Python API Intersection attribute bounding_box", "output": "The bounding_box attribute of a Intersection contains axis-aligned bounding box of the region. It's a openmc.BoundingBox value that you can access after creating a Intersection instance." }, { "instruction": "How do you call the __init__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, nodes: Any). It takes 2 parameters." }, { "instruction": "How do you call the __and__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__and__() method signature", "output": "To call the __and__() method, use: def __and__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __iand__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__iand__() method signature", "output": "To call the __iand__() method, use: def __iand__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __invert__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__invert__() method signature", "output": "To call the __invert__() method, use: def __invert__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getitem__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __setitem__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__setitem__() method signature", "output": "To call the __setitem__() method, use: def __setitem__(self: Any, key: Any, value: Any). It takes 3 parameters." }, { "instruction": "How do you call the __delitem__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__delitem__() method signature", "output": "To call the __delitem__() method, use: def __delitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the insert() method in the Intersection class?", "input": "OpenMC Python API Intersection.insert() method signature", "output": "To call the insert() method, use: def insert(self: Any, index: Any, value: Any). It takes 3 parameters." }, { "instruction": "What does the __contains__() method do in the Intersection class?", "input": "OpenMC Python API Intersection.__contains__() method", "output": "The __contains__() method check whether a point is contained in the region. It's used for intersection operations." }, { "instruction": "How do you call the __contains__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the __contains__() method?", "input": "OpenMC Python API Intersection.__contains__() parameter point", "output": "The point parameter cartesian coordinates, :math:`(x',y',z')`, of the point. It should be a 3-tuple of float value." }, { "instruction": "How do you call the __str__() method in the Intersection class?", "input": "OpenMC Python API Intersection.__str__() method signature", "output": "To call the __str__() method, use: def __str__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the Intersection class?", "input": "OpenMC Python API Intersection.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "What is the Union class in OpenMC's Python API?", "input": "OpenMC Python API Union class", "output": "The Union class represents union of two or more regions. instances of union are generally created via the | operator applied to two instances of :class:`openmc.region`. this is illustrated in the following example: >>> s1 = openmc.zplane(z0=0.0) >>> s2 = openmc.sphere(r=637.1e6) >>> type(-s2 | +s1) instances of this class behave like a mutable sequence, e.g., they can be indexed and have an append() method. It provides 12 methods and 0 properties for working with union data in OpenMC." }, { "instruction": "What does the Union class do in OpenMC's Python API?", "input": "OpenMC Python API Union class description", "output": "The Union class union of two or more regions. instances of union are generally created via the | operator applied to two instances of :class:`openmc.region`. this is illustrated in the following example: >>> s1 = openmc.zplane(z0=0.0) >>> s2 = openmc.sphere(r=637.1e6) >>> type(-s2 | +s1) instances of this class behave like a mutable sequence, e.g., they can be indexed and have an append() method. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the nodes parameter do when creating a Union?", "input": "OpenMC Python API Union constructor parameter nodes", "output": "When creating a Union, the nodes parameter specifies regions to take the union of. It should be a iterable of openmc.Region value." }, { "instruction": "What is the bounding_box attribute of a Union?", "input": "OpenMC Python API Union attribute bounding_box", "output": "The bounding_box attribute of a Union contains axis-aligned bounding box of the region. It's a openmc.BoundingBox value that you can access after creating a Union instance." }, { "instruction": "How do you call the __init__() method in the Union class?", "input": "OpenMC Python API Union.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, nodes: Any). It takes 2 parameters." }, { "instruction": "How do you call the __or__() method in the Union class?", "input": "OpenMC Python API Union.__or__() method signature", "output": "To call the __or__() method, use: def __or__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __ior__() method in the Union class?", "input": "OpenMC Python API Union.__ior__() method signature", "output": "To call the __ior__() method, use: def __ior__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __invert__() method in the Union class?", "input": "OpenMC Python API Union.__invert__() method signature", "output": "To call the __invert__() method, use: def __invert__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getitem__() method in the Union class?", "input": "OpenMC Python API Union.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __setitem__() method in the Union class?", "input": "OpenMC Python API Union.__setitem__() method signature", "output": "To call the __setitem__() method, use: def __setitem__(self: Any, key: Any, value: Any). It takes 3 parameters." }, { "instruction": "How do you call the __delitem__() method in the Union class?", "input": "OpenMC Python API Union.__delitem__() method signature", "output": "To call the __delitem__() method, use: def __delitem__(self: Any, key: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the Union class?", "input": "OpenMC Python API Union.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the insert() method in the Union class?", "input": "OpenMC Python API Union.insert() method signature", "output": "To call the insert() method, use: def insert(self: Any, index: Any, value: Any). It takes 3 parameters." }, { "instruction": "What does the __contains__() method do in the Union class?", "input": "OpenMC Python API Union.__contains__() method", "output": "The __contains__() method check whether a point is contained in the region. It's used for union operations." }, { "instruction": "How do you call the __contains__() method in the Union class?", "input": "OpenMC Python API Union.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the __contains__() method?", "input": "OpenMC Python API Union.__contains__() parameter point", "output": "The point parameter cartesian coordinates, :math:`(x',y',z')`, of the point. It should be a 3-tuple of float value." }, { "instruction": "How do you call the __str__() method in the Union class?", "input": "OpenMC Python API Union.__str__() method signature", "output": "To call the __str__() method, use: def __str__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the Union class?", "input": "OpenMC Python API Union.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "What is the Complement class in OpenMC's Python API?", "input": "OpenMC Python API Complement class", "output": "The Complement class represents complement of a region. the complement of an existing :class:`openmc.region` can be created by using the ~ operator as the following example demonstrates: >>> xl = openmc.xplane(-10.0) >>> xr = openmc.xplane(10.0) >>> yl = openmc.yplane(-10.0) >>> yr = openmc.yplane(10.0) >>> inside_box = +xl & -xr & +yl & -yr >>> outside_box = ~inside_box >>> type(outside_box) . It provides 12 methods and 0 properties for working with complement data in OpenMC." }, { "instruction": "What does the Complement class do in OpenMC's Python API?", "input": "OpenMC Python API Complement class description", "output": "The Complement class complement of a region. the complement of an existing :class:`openmc.region` can be created by using the ~ operator as the following example demonstrates: >>> xl = openmc.xplane(-10.0) >>> xr = openmc.xplane(10.0) >>> yl = openmc.yplane(-10.0) >>> yr = openmc.yplane(10.0) >>> inside_box = +xl & -xr & +yl & -yr >>> outside_box = ~inside_box >>> type(outside_box) . It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the node parameter do when creating a Complement?", "input": "OpenMC Python API Complement constructor parameter node", "output": "When creating a Complement, the node parameter specifies region to take the complement of. It should be a openmc.Region value." }, { "instruction": "What is the node attribute of a Complement?", "input": "OpenMC Python API Complement attribute node", "output": "The node attribute of a Complement contains regions to take the complement of. It's a openmc.Region value that you can access after creating a Complement instance." }, { "instruction": "What is the bounding_box attribute of a Complement?", "input": "OpenMC Python API Complement attribute bounding_box", "output": "The bounding_box attribute of a Complement contains axis-aligned bounding box of the region. It's a openmc.BoundingBox value that you can access after creating a Complement instance." }, { "instruction": "How do you call the __init__() method in the Complement class?", "input": "OpenMC Python API Complement.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, node: Region). It takes 2 parameters." }, { "instruction": "What does the __contains__() method do in the Complement class?", "input": "OpenMC Python API Complement.__contains__() method", "output": "The __contains__() method check whether a point is contained in the region. It's used for complement operations." }, { "instruction": "How do you call the __contains__() method in the Complement class?", "input": "OpenMC Python API Complement.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the __contains__() method?", "input": "OpenMC Python API Complement.__contains__() parameter point", "output": "The point parameter cartesian coordinates, :math:`(x',y',z')`, of the point. It should be a 3-tuple of float value." }, { "instruction": "How do you call the __invert__() method in the Complement class?", "input": "OpenMC Python API Complement.__invert__() method signature", "output": "To call the __invert__() method, use: def __invert__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __str__() method in the Complement class?", "input": "OpenMC Python API Complement.__str__() method signature", "output": "To call the __str__() method, use: def __str__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the node() method in the Complement class?", "input": "OpenMC Python API Complement.node() method signature", "output": "To call the node() method, use: @property def node(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the node() method in the Complement class?", "input": "OpenMC Python API Complement.node() method signature", "output": "To call the node() method, use: @node.setter def node(self: Any, node: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the Complement class?", "input": "OpenMC Python API Complement.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_surfaces() method do in the Complement class?", "input": "OpenMC Python API Complement.get_surfaces() method", "output": "The get_surfaces() method recursively find and return all the surfaces referenced by the node. It's used for complement operations." }, { "instruction": "How do you call the get_surfaces() method in the Complement class?", "input": "OpenMC Python API Complement.get_surfaces() method signature", "output": "To call the get_surfaces() method, use: def get_surfaces(self: Any, surfaces: Any). It takes 2 parameters." }, { "instruction": "What does the surfaces parameter do in the get_surfaces() method?", "input": "OpenMC Python API Complement.get_surfaces() parameter surfaces", "output": "The surfaces parameter dictionary mapping surface ids to :class:`openmc.surface` instances. It should be a dict, optional value." }, { "instruction": "What does the get_surfaces() method return in the Complement class?", "input": "OpenMC Python API Complement.get_surfaces() return value", "output": "The get_surfaces() method returns dictionary mapping surface ids to :class:`openmc.surface` instances. The return type is dict." }, { "instruction": "What does the remove_redundant_surfaces() method do in the Complement class?", "input": "OpenMC Python API Complement.remove_redundant_surfaces() method", "output": "The remove_redundant_surfaces() method recursively remove all redundant surfaces referenced by this region .. versionadded:: 0.12. It's used for complement operations." }, { "instruction": "How do you call the remove_redundant_surfaces() method in the Complement class?", "input": "OpenMC Python API Complement.remove_redundant_surfaces() method signature", "output": "To call the remove_redundant_surfaces() method, use: def remove_redundant_surfaces(self: Any, redundant_surfaces: Any). It takes 2 parameters." }, { "instruction": "What does the redundant_surfaces parameter do in the remove_redundant_surfaces() method?", "input": "OpenMC Python API Complement.remove_redundant_surfaces() parameter redundant_surfaces", "output": "The redundant_surfaces parameter dictionary mapping redundant surface ids to class:`openmc.surface` instances that should replace them.. It should be a dict value." }, { "instruction": "How do you call the clone() method in the Complement class?", "input": "OpenMC Python API Complement.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "How do you call the translate() method in the Complement class?", "input": "OpenMC Python API Complement.translate() method signature", "output": "To call the translate() method, use: def translate(self: Any, vector: Any, inplace: Any, memo: Any). It takes 4 parameters." }, { "instruction": "How do you call the rotate() method in the Complement class?", "input": "OpenMC Python API Complement.rotate() method signature", "output": "To call the rotate() method, use: def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any, memo: Any). It takes 6 parameters." }, { "instruction": "How do you call the can_be_combined() function in OpenMC's Python API?", "input": "OpenMC Python API can_be_combined() function signature", "output": "To call the can_be_combined() function, use: def can_be_combined(region: Any). It takes 1 parameters." }, { "instruction": "How do you call the apply_operator() function in OpenMC's Python API?", "input": "OpenMC Python API apply_operator() function signature", "output": "To call the apply_operator() function, use: def apply_operator(output: Any, operator: Any). It takes 2 parameters." }, { "instruction": "What does the _search_keff() function do in OpenMC's Python API?", "input": "OpenMC Python API _search_keff() function", "output": "The _search_keff() function function which will actually create our model, run the calculation, and obtain the result. this function will be passed to the root finding algorithm. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _search_keff() function in OpenMC's Python API?", "input": "OpenMC Python API _search_keff() function purpose", "output": "The _search_keff() function function which will actually create our model, run the calculation, and obtain the result. this function will be passed to the root finding algorithm. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _search_keff() function in OpenMC's Python API?", "input": "OpenMC Python API _search_keff() function signature", "output": "To call the _search_keff() function, use: def _search_keff(guess: Any, target: Any, model_builder: Any, model_args: Any, print_iterations: Any, run_args: Any, guesses: Any, results: Any). It takes 8 parameters." }, { "instruction": "What does the guess parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter guess", "output": "The guess parameter current guess for the parameter to be searched in `model_builder`.. It should be a Real value." }, { "instruction": "What does the target_keff parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter target_keff", "output": "The target_keff parameter value to search for. It should be a Real value." }, { "instruction": "What does the model_builder parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter model_builder", "output": "The model_builder parameter callable function which builds a model according to a passed parameter. this function must return an openmc.model.model object.. It should be a collections.Callable value." }, { "instruction": "What does the model_args parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter model_args", "output": "The model_args parameter keyword-based arguments to pass to the `model_builder` method.. It should be a dict value." }, { "instruction": "What does the print_iterations parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter print_iterations", "output": "The print_iterations parameter whether or not to print the guess and the resultant keff during the iteration process.. It should be a bool value." }, { "instruction": "What does the run_args parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter run_args", "output": "The run_args parameter keyword arguments to pass to :meth:`openmc.model.run`.. It should be a dict value." }, { "instruction": "What does the guesses parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter guesses", "output": "The guesses parameter running list of guesses thus far, to be updated during the execution of this function.. It should be a Iterable of Real value." }, { "instruction": "What does the results parameter do in the _search_keff() function?", "input": "OpenMC Python API _search_keff() parameter results", "output": "The results parameter running list of results thus far, to be updated during the execution of this function.. It should be a Iterable of Real value." }, { "instruction": "What does the search_for_keff() function do in OpenMC's Python API?", "input": "OpenMC Python API search_for_keff() function", "output": "The search_for_keff() function function to perform a keff search by modifying a model parametrized by a single independent variable. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the search_for_keff() function in OpenMC's Python API?", "input": "OpenMC Python API search_for_keff() function purpose", "output": "The search_for_keff() function function to perform a keff search by modifying a model parametrized by a single independent variable. It's part of OpenMC's Python API." }, { "instruction": "How do you call the search_for_keff() function in OpenMC's Python API?", "input": "OpenMC Python API search_for_keff() function signature", "output": "To call the search_for_keff() function, use: def search_for_keff(model_builder: Any, initial_guess: Any, target: Any, bracket: Any, model_args: Any, tol: Any, bracketed_method: Any, print_iterations: Any, run_args: Any). It takes 9 parameters." }, { "instruction": "What does the model_builder parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter model_builder", "output": "The model_builder parameter callable function which builds a model according to a passed parameter. this function must return an openmc.model.model object.. It should be a collections.Callable value." }, { "instruction": "What does the initial_guess parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter initial_guess", "output": "The initial_guess parameter initial guess for the parameter to be searched in `model_builder`. one of `guess` or `bracket` must be provided.. It should be a Real, optional value." }, { "instruction": "What does the target parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter target", "output": "The target parameter keff value to search for, defaults to 1.0.. It should be a Real, optional value." }, { "instruction": "What does the bracket parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter bracket", "output": "The bracket parameter bracketing interval to search for the solution; if not provided, a generic non-bracketing method is used. if provided, the brackets are used. defaults to no brackets provided. one of `guess` or `bracket` must be provided. if both are provided, the bracket will be preferentially used.. It should be a None or Iterable of Real, optional value." }, { "instruction": "What does the model_args parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter model_args", "output": "The model_args parameter keyword-based arguments to pass to the `model_builder` method. defaults to no arguments.. It should be a dict, optional value." }, { "instruction": "What does the tol parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter tol", "output": "The tol parameter tolerance to pass to the search method. It should be a float value." }, { "instruction": "What does the bracketed_method parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter bracketed_method", "output": "The bracketed_method parameter solution method to use; only applies if `bracket` is set, otherwise the secant method is used. defaults to 'bisect'.. It should be a {'brentq', 'brenth', 'ridder', 'bisect'}, optional value." }, { "instruction": "What does the print_iterations parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter print_iterations", "output": "The print_iterations parameter whether or not to print the guess and the result during the iteration process. defaults to false.. It should be a bool value." }, { "instruction": "What does the run_args parameter do in the search_for_keff() function?", "input": "OpenMC Python API search_for_keff() parameter run_args", "output": "The run_args parameter keyword arguments to pass to :meth:`openmc.model.run`. defaults to no arguments. .. versionadded:: 0.13.1 **kwargs all remaining keyword arguments are passed to the root-finding method.. It should be a dict, optional value." }, { "instruction": "What does the search_for_keff() function return in OpenMC's Python API?", "input": "OpenMC Python API search_for_keff() return value", "output": "The search_for_keff() function returns estimated value of the variable parameter where keff is the targeted value. The return type is float." }, { "instruction": "What does the search_for_keff() function return in OpenMC's Python API?", "input": "OpenMC Python API search_for_keff() return value", "output": "The search_for_keff() function returns list of guesses attempted by the search. The return type is List of Real." }, { "instruction": "What does the search_for_keff() function return in OpenMC's Python API?", "input": "OpenMC Python API search_for_keff() return value", "output": "The search_for_keff() function returns list of keffs and uncertainties corresponding to the guess attempted by the search. The return type is List of 2-tuple of Real." }, { "instruction": "What is the Settings class in OpenMC's Python API?", "input": "OpenMC Python API Settings class", "output": "The Settings class represents settings used for an openmc simulation. It provides 236 methods and 0 properties for working with settings data in OpenMC." }, { "instruction": "What does the Settings class do in OpenMC's Python API?", "input": "OpenMC Python API Settings class description", "output": "The Settings class settings used for an openmc simulation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the batches attribute of a Settings?", "input": "OpenMC Python API Settings attribute batches", "output": "The batches attribute of a Settings contains number of batches to simulate. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the confidence_intervals attribute of a Settings?", "input": "OpenMC Python API Settings attribute confidence_intervals", "output": "The confidence_intervals attribute of a Settings contains if true, uncertainties on tally results will be reported as the half-width of the 95% two-sided confidence interval. if false, uncertainties on tally results will be reported as the sample standard deviation.. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the create_fission_neutrons attribute of a Settings?", "input": "OpenMC Python API Settings attribute create_fission_neutrons", "output": "The create_fission_neutrons attribute of a Settings contains indicate whether fission neutrons should be created or not.. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the cutoff attribute of a Settings?", "input": "OpenMC Python API Settings attribute cutoff", "output": "The cutoff attribute of a Settings contains dictionary defining weight cutoff, energy cutoff and time cutoff. the dictionary may have the following keys, 'weight', 'weight_avg', 'survival_normalization', 'energy_neutron', 'energy_photon', 'energy_electron', 'energy_positron', 'time_neutron', 'time_photon', 'time_electron', and 'time_positron'. value for 'weight' should be a float indicating weight cutoff below which particle undergo russian roulette. value for 'weight_avg' should be a float indicating weight assigned to particles that are not killed after russian roulette. value of energy should be a float indicating energy in ev below which particle type will be killed. value of time should be a float in seconds. particles will be killed exactly at the specified time. value for 'survival_normalization' is a bool indicating whether or not the weight cutoff parameters will be applied relative to the particle's starting weight or to its current weight.. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the delayed_photon_scaling attribute of a Settings?", "input": "OpenMC Python API Settings attribute delayed_photon_scaling", "output": "The delayed_photon_scaling attribute of a Settings contains indicate whether to scale the fission photon yield by (egp + egd)/egp where egp is the energy release of prompt photons and egd is the energy release of delayed photons. .. versionadded:: 0.12. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the electron_treatment attribute of a Settings?", "input": "OpenMC Python API Settings attribute electron_treatment", "output": "The electron_treatment attribute of a Settings contains whether to deposit all energy from electrons locally ('led') or create secondary bremsstrahlung photons ('ttb').. It's a {'led', 'ttb'} value that you can access after creating a Settings instance." }, { "instruction": "What is the energy_mode attribute of a Settings?", "input": "OpenMC Python API Settings attribute energy_mode", "output": "The energy_mode attribute of a Settings contains set whether the calculation should be continuous-energy or multi-group.. It's a {'continuous-energy', 'multi-group'} value that you can access after creating a Settings instance." }, { "instruction": "What is the entropy_mesh attribute of a Settings?", "input": "OpenMC Python API Settings attribute entropy_mesh", "output": "The entropy_mesh attribute of a Settings contains mesh to be used to calculate shannon entropy. if the mesh dimensions are not specified, openmc assigns a mesh such that 20 source sites per mesh cell are to be expected on average.. It's a openmc.RegularMesh value that you can access after creating a Settings instance." }, { "instruction": "What is the event_based attribute of a Settings?", "input": "OpenMC Python API Settings attribute event_based", "output": "The event_based attribute of a Settings contains indicate whether to use event-based parallelism instead of the default history-based parallelism. .. versionadded:: 0.12. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the generations_per_batch attribute of a Settings?", "input": "OpenMC Python API Settings attribute generations_per_batch", "output": "The generations_per_batch attribute of a Settings contains number of generations per batch. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the ifp_n_generation attribute of a Settings?", "input": "OpenMC Python API Settings attribute ifp_n_generation", "output": "The ifp_n_generation attribute of a Settings contains number of generations to consider for the iterated fission probability method.. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the max_lost_particles attribute of a Settings?", "input": "OpenMC Python API Settings attribute max_lost_particles", "output": "The max_lost_particles attribute of a Settings contains maximum number of lost particles .. versionadded:: 0.12. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the rel_max_lost_particles attribute of a Settings?", "input": "OpenMC Python API Settings attribute rel_max_lost_particles", "output": "The rel_max_lost_particles attribute of a Settings contains maximum number of lost particles, relative to the total number of particles .. versionadded:: 0.12. It's a float value that you can access after creating a Settings instance." }, { "instruction": "What is the inactive attribute of a Settings?", "input": "OpenMC Python API Settings attribute inactive", "output": "The inactive attribute of a Settings contains number of inactive batches. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the keff_trigger attribute of a Settings?", "input": "OpenMC Python API Settings attribute keff_trigger", "output": "The keff_trigger attribute of a Settings contains dictionary defining a trigger on eigenvalue. the dictionary must have two keys, 'type' and 'threshold'. acceptable values corresponding to type are 'variance', 'std_dev', and 'rel_err'. the threshold value should be a float indicating the variance, standard deviation, or relative error used.. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the log_grid_bins attribute of a Settings?", "input": "OpenMC Python API Settings attribute log_grid_bins", "output": "The log_grid_bins attribute of a Settings contains number of bins for logarithmic energy grid search. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the material_cell_offsets attribute of a Settings?", "input": "OpenMC Python API Settings attribute material_cell_offsets", "output": "The material_cell_offsets attribute of a Settings contains generate an \"offset table\" for material cells by default. these tables are necessary when a particular instance of a cell needs to be tallied. .. versionadded:: 0.12. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the max_particles_in_flight attribute of a Settings?", "input": "OpenMC Python API Settings attribute max_particles_in_flight", "output": "The max_particles_in_flight attribute of a Settings contains number of neutrons to run concurrently when using event-based parallelism. .. versionadded:: 0.12. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the max_particle_events attribute of a Settings?", "input": "OpenMC Python API Settings attribute max_particle_events", "output": "The max_particle_events attribute of a Settings contains maximum number of allowed particle events per source particle. .. versionadded:: 0.15.0. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the max_order attribute of a Settings?", "input": "OpenMC Python API Settings attribute max_order", "output": "The max_order attribute of a Settings contains maximum scattering order to apply globally when in multi-group mode.. It's a None or int value that you can access after creating a Settings instance." }, { "instruction": "What is the max_history_splits attribute of a Settings?", "input": "OpenMC Python API Settings attribute max_history_splits", "output": "The max_history_splits attribute of a Settings contains maximum number of times a particle can split during a history .. versionadded:: 0.13. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the max_tracks attribute of a Settings?", "input": "OpenMC Python API Settings attribute max_tracks", "output": "The max_tracks attribute of a Settings contains maximum number of tracks written to a track file (per mpi process). .. versionadded:: 0.13.1. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the max_write_lost_particles attribute of a Settings?", "input": "OpenMC Python API Settings attribute max_write_lost_particles", "output": "The max_write_lost_particles attribute of a Settings contains maximum number of particle restart files (per mpi process) to write for lost particles. .. versionadded:: 0.14.0. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the no_reduce attribute of a Settings?", "input": "OpenMC Python API Settings attribute no_reduce", "output": "The no_reduce attribute of a Settings contains indicate that all user-defined and global tallies should not be reduced across processes in a parallel calculation.. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the output attribute of a Settings?", "input": "OpenMC Python API Settings attribute output", "output": "The output attribute of a Settings contains dictionary indicating what files to output. acceptable keys are: :path: string indicating a directory where output files should be written :summary: whether the 'summary.h5' file should be written (bool) :tallies: whether the 'tallies.out' file should be written (bool). It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the particles attribute of a Settings?", "input": "OpenMC Python API Settings attribute particles", "output": "The particles attribute of a Settings contains number of particles per generation. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the photon_transport attribute of a Settings?", "input": "OpenMC Python API Settings attribute photon_transport", "output": "The photon_transport attribute of a Settings contains whether to use photon transport.. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the plot_seed attribute of a Settings?", "input": "OpenMC Python API Settings attribute plot_seed", "output": "The plot_seed attribute of a Settings contains initial seed for randomly generated plot colors.. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the ptables attribute of a Settings?", "input": "OpenMC Python API Settings attribute ptables", "output": "The ptables attribute of a Settings contains determine whether probability tables are used.. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the random_ray attribute of a Settings?", "input": "OpenMC Python API Settings attribute random_ray", "output": "The random_ray attribute of a Settings contains options for configuring the random ray solver. acceptable keys are: :distance_inactive: indicates the total active distance in [cm] a ray should travel :distance_active: indicates the total active distance in [cm] a ray should travel :ray_source: starting ray distribution (must be uniform in space and angle) as specified by a :class:`openmc.sourcebase` object. :volume_estimator: choice of volume estimator for the random ray solver. options are 'naive', 'simulation_averaged', or 'hybrid'. the default is 'hybrid'. :source_shape: assumed shape of the source distribution within each source region. options are 'flat' (default), 'linear', or 'linear_xy'. :volume_normalized_flux_tallies: whether to normalize flux tallies by volume (bool). the default is 'false'. when enabled, flux tallies will be reported in units of cm/cm^3. when disabled, flux tallies will be reported in units of cm (i.e., total distance traveled by neutrons in the spatial tally region). :adjoint: whether to run the random ray solver in adjoint mode (bool). the default is 'false'. :sample_method: sampling method for the ray starting location and direction of travel. options are `prng` (default) or 'halton`. :source_region_meshes: list of tuples where each tuple contains a mesh and a list of domains. each domain is an instance of openmc.material, openmc.cell, or openmc.universe. the mesh will be applied to the listed domains to subdivide source regions so as to improve accuracy and/or conform with tally meshes. :diagonal_stabilization_rho: the rho factor for use with diagonal stabilization. this technique is applied when negative diagonal (in-group) elements are detected in the scattering matrix of input mgxs data, which is a common feature of transport corrected mgxs data. the default is 1.0, which ensures no negative diagonal elements are present in the iteration matrix and thus stabilizes the simulation. a value of 0.0 will disable diagonal stabilization. values between 0.0 and 1.0 will apply a degree of stabilization, which may be desirable as stronger diagonal stabilization also tends to dampen the convergence rate of the solver, thus requiring more iterations to converge. .. versionadded:: 0.15.0. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the resonance_scattering attribute of a Settings?", "input": "OpenMC Python API Settings attribute resonance_scattering", "output": "The resonance_scattering attribute of a Settings contains settings for resonance elastic scattering. accepted keys are 'enable' (bool), 'method' (str), 'energy_min' (float), 'energy_max' (float), and 'nuclides' (list). the 'method' can be set to 'dbrc' (doppler broadening rejection correction) or 'rvs' (relative velocity sampling). if not specified, 'rvs' is the default method. the 'energy_min' and 'energy_max' values indicate the minimum and maximum energies above and below which the resonance elastic scattering method is to be applied. the 'nuclides' list indicates what nuclides the method should be applied to. in its absence, the method will be applied to all nuclides with 0 k elastic scattering data present.. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the run_mode attribute of a Settings?", "input": "OpenMC Python API Settings attribute run_mode", "output": "The run_mode attribute of a Settings contains the type of calculation to perform (default is 'eigenvalue'). It's a {'eigenvalue', 'fixed source', 'plot', 'volume', 'particle restart'} value that you can access after creating a Settings instance." }, { "instruction": "What is the seed attribute of a Settings?", "input": "OpenMC Python API Settings attribute seed", "output": "The seed attribute of a Settings contains seed for the linear congruential pseudorandom number generator. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the stride attribute of a Settings?", "input": "OpenMC Python API Settings attribute stride", "output": "The stride attribute of a Settings contains number of random numbers allocated for each source particle history. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the source attribute of a Settings?", "input": "OpenMC Python API Settings attribute source", "output": "The source attribute of a Settings contains distribution of source sites in space, angle, and energy. It's a Iterable of openmc.SourceBase value that you can access after creating a Settings instance." }, { "instruction": "What is the sourcepoint attribute of a Settings?", "input": "OpenMC Python API Settings attribute sourcepoint", "output": "The sourcepoint attribute of a Settings contains options for writing source points. acceptable keys are: :batches: list of batches at which to write source :overwrite: bool indicating whether to overwrite :separate: bool indicating whether the source should be written as a separate file :write: bool indicating whether or not to write the source :mcpl: bool indicating whether to write the source as an mcpl file. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the statepoint attribute of a Settings?", "input": "OpenMC Python API Settings attribute statepoint", "output": "The statepoint attribute of a Settings contains options for writing state points. acceptable keys are: :batches: list of batches at which to write statepoint files. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the surf_source_read attribute of a Settings?", "input": "OpenMC Python API Settings attribute surf_source_read", "output": "The surf_source_read attribute of a Settings contains options for reading surface source points. acceptable keys are: :path: path to surface source file (str).. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the surf_source_write attribute of a Settings?", "input": "OpenMC Python API Settings attribute surf_source_write", "output": "The surf_source_write attribute of a Settings contains options for writing surface source points. acceptable keys are: :surface_ids: list of surface ids at which crossing particles are to be banked (int) :max_particles: maximum number of particles to be banked on surfaces per process (int) :max_source_files: maximum number of surface source files to be created (int) :mcpl: output in the form of an mcpl-file (bool) :cell: cell id used to determine if particles crossing identified surfaces are to be banked. particles coming from or going to this declared cell will be banked (int) :cellfrom: cell id used to determine if particles crossing identified surfaces are to be banked. particles coming from this declared cell will be banked (int) :cellto: cell id used to determine if particles crossing identified surfaces are to be banked. particles going to this declared cell will be banked (int). It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the survival_biasing attribute of a Settings?", "input": "OpenMC Python API Settings attribute survival_biasing", "output": "The survival_biasing attribute of a Settings contains indicate whether survival biasing is to be used. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the tabular_legendre attribute of a Settings?", "input": "OpenMC Python API Settings attribute tabular_legendre", "output": "The tabular_legendre attribute of a Settings contains determines if a multi-group scattering moment kernel expanded via legendre polynomials is to be converted to a tabular distribution or not. accepted keys are 'enable' and 'num_points'. the value for 'enable' is a bool stating whether the conversion to tabular is performed; the value for 'num_points' sets the number of points to use in the tabular distribution, should 'enable' be true.. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the temperature attribute of a Settings?", "input": "OpenMC Python API Settings attribute temperature", "output": "The temperature attribute of a Settings contains defines a default temperature and method for treating intermediate temperatures at which nuclear data doesn't exist. accepted keys are 'default', 'method', 'range', 'tolerance', and 'multipole'. the value for 'default' should be a float representing the default temperature in kelvin. the value for 'method' should be 'nearest' or 'interpolation'. if the method is 'nearest', 'tolerance' indicates a range of temperature within which cross sections may be used. if the method is 'interpolation', 'tolerance' indicates the range of temperatures outside of the available cross section temperatures where cross sections will evaluate to the nearer bound. the value for 'range' should be a pair of minimum and maximum temperatures which are used to indicate that cross sections be loaded at all temperatures within the range. 'multipole' is a boolean indicating whether or not the windowed multipole method should be used to evaluate resolved resonance cross sections.. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the trace attribute of a Settings?", "input": "OpenMC Python API Settings attribute trace", "output": "The trace attribute of a Settings contains show detailed information about a single particle, indicated by three. It's a tuple or list value that you can access after creating a Settings instance." }, { "instruction": "What is the integers attribute of a Settings?", "input": "OpenMC Python API Settings attribute integers", "output": "The integers attribute of a Settings contains . It's a the batch number, generation number, and particle number value that you can access after creating a Settings instance." }, { "instruction": "What is the track attribute of a Settings?", "input": "OpenMC Python API Settings attribute track", "output": "The track attribute of a Settings contains specify particles for which track files should be written. each particle is identified by a tuple with the batch number, generation number, and particle number.. It's a tuple or list value that you can access after creating a Settings instance." }, { "instruction": "What is the trigger_active attribute of a Settings?", "input": "OpenMC Python API Settings attribute trigger_active", "output": "The trigger_active attribute of a Settings contains indicate whether tally triggers are used. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the trigger_batch_interval attribute of a Settings?", "input": "OpenMC Python API Settings attribute trigger_batch_interval", "output": "The trigger_batch_interval attribute of a Settings contains number of batches in between convergence checks. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the trigger_max_batches attribute of a Settings?", "input": "OpenMC Python API Settings attribute trigger_max_batches", "output": "The trigger_max_batches attribute of a Settings contains maximum number of batches simulated. if this is set, the number of batches specified via ``batches`` is interpreted as the minimum number of batches. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the uniform_source_sampling attribute of a Settings?", "input": "OpenMC Python API Settings attribute uniform_source_sampling", "output": "The uniform_source_sampling attribute of a Settings contains whether to sampling among multiple sources uniformly, applying their strengths as weights to sampled particles.. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the ufs_mesh attribute of a Settings?", "input": "OpenMC Python API Settings attribute ufs_mesh", "output": "The ufs_mesh attribute of a Settings contains mesh to be used for redistributing source sites via the uniform fission site (ufs) method.. It's a openmc.RegularMesh value that you can access after creating a Settings instance." }, { "instruction": "What is the use_decay_photons attribute of a Settings?", "input": "OpenMC Python API Settings attribute use_decay_photons", "output": "The use_decay_photons attribute of a Settings contains produce decay photons from neutron reactions instead of prompt. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the verbosity attribute of a Settings?", "input": "OpenMC Python API Settings attribute verbosity", "output": "The verbosity attribute of a Settings contains verbosity during simulation between 1 and 10. verbosity levels are described in :ref:`verbosity`.. It's a int value that you can access after creating a Settings instance." }, { "instruction": "What is the volume_calculations attribute of a Settings?", "input": "OpenMC Python API Settings attribute volume_calculations", "output": "The volume_calculations attribute of a Settings contains stochastic volume calculation specifications. It's a VolumeCalculation or iterable of VolumeCalculation value that you can access after creating a Settings instance." }, { "instruction": "What is the weight_windows attribute of a Settings?", "input": "OpenMC Python API Settings attribute weight_windows", "output": "The weight_windows attribute of a Settings contains weight windows to use for variance reduction .. versionadded:: 0.13. It's a WeightWindows or iterable of WeightWindows value that you can access after creating a Settings instance." }, { "instruction": "What is the weight_window_checkpoints attribute of a Settings?", "input": "OpenMC Python API Settings attribute weight_window_checkpoints", "output": "The weight_window_checkpoints attribute of a Settings contains indicates the checkpoints for weight window split/roulettes. valid keys include \"collision\" and \"surface\". values must be of type bool. .. versionadded:: 0.14.0. It's a dict value that you can access after creating a Settings instance." }, { "instruction": "What is the weight_window_generators attribute of a Settings?", "input": "OpenMC Python API Settings attribute weight_window_generators", "output": "The weight_window_generators attribute of a Settings contains weight windows generation parameters to apply during simulation .. versionadded:: 0.14.0. It's a WeightWindowGenerator or iterable of WeightWindowGenerator value that you can access after creating a Settings instance." }, { "instruction": "What is the create_delayed_neutrons attribute of a Settings?", "input": "OpenMC Python API Settings attribute create_delayed_neutrons", "output": "The create_delayed_neutrons attribute of a Settings contains whether delayed neutrons are created in fission. .. versionadded:: 0.13.3. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the weight_windows_on attribute of a Settings?", "input": "OpenMC Python API Settings attribute weight_windows_on", "output": "The weight_windows_on attribute of a Settings contains whether weight windows are enabled .. versionadded:: 0.13. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "What is the weight_windows_file attribute of a Settings?", "input": "OpenMC Python API Settings attribute weight_windows_file", "output": "The weight_windows_file attribute of a Settings contains path to a weight window file to load during simulation initialization .. versionadded::0.14.0. It's a Pathlike value that you can access after creating a Settings instance." }, { "instruction": "What is the write_initial_source attribute of a Settings?", "input": "OpenMC Python API Settings attribute write_initial_source", "output": "The write_initial_source attribute of a Settings contains indicate whether to write the initial source distribution to file. It's a bool value that you can access after creating a Settings instance." }, { "instruction": "How do you call the __init__() method in the Settings class?", "input": "OpenMC Python API Settings.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the run_mode() method in the Settings class?", "input": "OpenMC Python API Settings.run_mode() method signature", "output": "To call the run_mode() method, use: @property def run_mode(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the run_mode() method in the Settings class?", "input": "OpenMC Python API Settings.run_mode() method signature", "output": "To call the run_mode() method, use: @run_mode.setter def run_mode(self: Any, run_mode: str). It takes 2 parameters." }, { "instruction": "How do you call the batches() method in the Settings class?", "input": "OpenMC Python API Settings.batches() method signature", "output": "To call the batches() method, use: @property def batches(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the batches() method in the Settings class?", "input": "OpenMC Python API Settings.batches() method signature", "output": "To call the batches() method, use: @batches.setter def batches(self: Any, batches: int). It takes 2 parameters." }, { "instruction": "How do you call the generations_per_batch() method in the Settings class?", "input": "OpenMC Python API Settings.generations_per_batch() method signature", "output": "To call the generations_per_batch() method, use: @property def generations_per_batch(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the generations_per_batch() method in the Settings class?", "input": "OpenMC Python API Settings.generations_per_batch() method signature", "output": "To call the generations_per_batch() method, use: @generations_per_batch.setter def generations_per_batch(self: Any, generations_per_batch: int). It takes 2 parameters." }, { "instruction": "How do you call the inactive() method in the Settings class?", "input": "OpenMC Python API Settings.inactive() method signature", "output": "To call the inactive() method, use: @property def inactive(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the inactive() method in the Settings class?", "input": "OpenMC Python API Settings.inactive() method signature", "output": "To call the inactive() method, use: @inactive.setter def inactive(self: Any, inactive: int). It takes 2 parameters." }, { "instruction": "How do you call the max_lost_particles() method in the Settings class?", "input": "OpenMC Python API Settings.max_lost_particles() method signature", "output": "To call the max_lost_particles() method, use: @property def max_lost_particles(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_lost_particles() method in the Settings class?", "input": "OpenMC Python API Settings.max_lost_particles() method signature", "output": "To call the max_lost_particles() method, use: @max_lost_particles.setter def max_lost_particles(self: Any, max_lost_particles: int). It takes 2 parameters." }, { "instruction": "How do you call the rel_max_lost_particles() method in the Settings class?", "input": "OpenMC Python API Settings.rel_max_lost_particles() method signature", "output": "To call the rel_max_lost_particles() method, use: @property def rel_max_lost_particles(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the rel_max_lost_particles() method in the Settings class?", "input": "OpenMC Python API Settings.rel_max_lost_particles() method signature", "output": "To call the rel_max_lost_particles() method, use: @rel_max_lost_particles.setter def rel_max_lost_particles(self: Any, rel_max_lost_particles: float). It takes 2 parameters." }, { "instruction": "How do you call the max_write_lost_particles() method in the Settings class?", "input": "OpenMC Python API Settings.max_write_lost_particles() method signature", "output": "To call the max_write_lost_particles() method, use: @property def max_write_lost_particles(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_write_lost_particles() method in the Settings class?", "input": "OpenMC Python API Settings.max_write_lost_particles() method signature", "output": "To call the max_write_lost_particles() method, use: @max_write_lost_particles.setter def max_write_lost_particles(self: Any, max_write_lost_particles: int). It takes 2 parameters." }, { "instruction": "How do you call the particles() method in the Settings class?", "input": "OpenMC Python API Settings.particles() method signature", "output": "To call the particles() method, use: @property def particles(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the particles() method in the Settings class?", "input": "OpenMC Python API Settings.particles() method signature", "output": "To call the particles() method, use: @particles.setter def particles(self: Any, particles: int). It takes 2 parameters." }, { "instruction": "How do you call the keff_trigger() method in the Settings class?", "input": "OpenMC Python API Settings.keff_trigger() method signature", "output": "To call the keff_trigger() method, use: @property def keff_trigger(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the keff_trigger() method in the Settings class?", "input": "OpenMC Python API Settings.keff_trigger() method signature", "output": "To call the keff_trigger() method, use: @keff_trigger.setter def keff_trigger(self: Any, keff_trigger: dict). It takes 2 parameters." }, { "instruction": "How do you call the energy_mode() method in the Settings class?", "input": "OpenMC Python API Settings.energy_mode() method signature", "output": "To call the energy_mode() method, use: @property def energy_mode(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_mode() method in the Settings class?", "input": "OpenMC Python API Settings.energy_mode() method signature", "output": "To call the energy_mode() method, use: @energy_mode.setter def energy_mode(self: Any, energy_mode: str). It takes 2 parameters." }, { "instruction": "How do you call the max_order() method in the Settings class?", "input": "OpenMC Python API Settings.max_order() method signature", "output": "To call the max_order() method, use: @property def max_order(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_order() method in the Settings class?", "input": "OpenMC Python API Settings.max_order() method signature", "output": "To call the max_order() method, use: @max_order.setter def max_order(self: Any, max_order: Any). It takes 2 parameters." }, { "instruction": "How do you call the source() method in the Settings class?", "input": "OpenMC Python API Settings.source() method signature", "output": "To call the source() method, use: @property def source(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the source() method in the Settings class?", "input": "OpenMC Python API Settings.source() method signature", "output": "To call the source() method, use: @source.setter def source(self: Any, source: Any). It takes 2 parameters." }, { "instruction": "How do you call the confidence_intervals() method in the Settings class?", "input": "OpenMC Python API Settings.confidence_intervals() method signature", "output": "To call the confidence_intervals() method, use: @property def confidence_intervals(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the confidence_intervals() method in the Settings class?", "input": "OpenMC Python API Settings.confidence_intervals() method signature", "output": "To call the confidence_intervals() method, use: @confidence_intervals.setter def confidence_intervals(self: Any, confidence_intervals: bool). It takes 2 parameters." }, { "instruction": "How do you call the electron_treatment() method in the Settings class?", "input": "OpenMC Python API Settings.electron_treatment() method signature", "output": "To call the electron_treatment() method, use: @property def electron_treatment(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the electron_treatment() method in the Settings class?", "input": "OpenMC Python API Settings.electron_treatment() method signature", "output": "To call the electron_treatment() method, use: @electron_treatment.setter def electron_treatment(self: Any, electron_treatment: str). It takes 2 parameters." }, { "instruction": "How do you call the ptables() method in the Settings class?", "input": "OpenMC Python API Settings.ptables() method signature", "output": "To call the ptables() method, use: @property def ptables(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ptables() method in the Settings class?", "input": "OpenMC Python API Settings.ptables() method signature", "output": "To call the ptables() method, use: @ptables.setter def ptables(self: Any, ptables: bool). It takes 2 parameters." }, { "instruction": "How do you call the photon_transport() method in the Settings class?", "input": "OpenMC Python API Settings.photon_transport() method signature", "output": "To call the photon_transport() method, use: @property def photon_transport(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the photon_transport() method in the Settings class?", "input": "OpenMC Python API Settings.photon_transport() method signature", "output": "To call the photon_transport() method, use: @photon_transport.setter def photon_transport(self: Any, photon_transport: bool). It takes 2 parameters." }, { "instruction": "How do you call the uniform_source_sampling() method in the Settings class?", "input": "OpenMC Python API Settings.uniform_source_sampling() method signature", "output": "To call the uniform_source_sampling() method, use: @property def uniform_source_sampling(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the uniform_source_sampling() method in the Settings class?", "input": "OpenMC Python API Settings.uniform_source_sampling() method signature", "output": "To call the uniform_source_sampling() method, use: @uniform_source_sampling.setter def uniform_source_sampling(self: Any, uniform_source_sampling: bool). It takes 2 parameters." }, { "instruction": "How do you call the plot_seed() method in the Settings class?", "input": "OpenMC Python API Settings.plot_seed() method signature", "output": "To call the plot_seed() method, use: @property def plot_seed(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the plot_seed() method in the Settings class?", "input": "OpenMC Python API Settings.plot_seed() method signature", "output": "To call the plot_seed() method, use: @plot_seed.setter def plot_seed(self: Any, seed: Any). It takes 2 parameters." }, { "instruction": "How do you call the seed() method in the Settings class?", "input": "OpenMC Python API Settings.seed() method signature", "output": "To call the seed() method, use: @property def seed(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the seed() method in the Settings class?", "input": "OpenMC Python API Settings.seed() method signature", "output": "To call the seed() method, use: @seed.setter def seed(self: Any, seed: int). It takes 2 parameters." }, { "instruction": "How do you call the stride() method in the Settings class?", "input": "OpenMC Python API Settings.stride() method signature", "output": "To call the stride() method, use: @property def stride(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the stride() method in the Settings class?", "input": "OpenMC Python API Settings.stride() method signature", "output": "To call the stride() method, use: @stride.setter def stride(self: Any, stride: int). It takes 2 parameters." }, { "instruction": "How do you call the survival_biasing() method in the Settings class?", "input": "OpenMC Python API Settings.survival_biasing() method signature", "output": "To call the survival_biasing() method, use: @property def survival_biasing(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the survival_biasing() method in the Settings class?", "input": "OpenMC Python API Settings.survival_biasing() method signature", "output": "To call the survival_biasing() method, use: @survival_biasing.setter def survival_biasing(self: Any, survival_biasing: bool). It takes 2 parameters." }, { "instruction": "How do you call the entropy_mesh() method in the Settings class?", "input": "OpenMC Python API Settings.entropy_mesh() method signature", "output": "To call the entropy_mesh() method, use: @property def entropy_mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the entropy_mesh() method in the Settings class?", "input": "OpenMC Python API Settings.entropy_mesh() method signature", "output": "To call the entropy_mesh() method, use: @entropy_mesh.setter def entropy_mesh(self: Any, entropy: RegularMesh). It takes 2 parameters." }, { "instruction": "How do you call the trigger_active() method in the Settings class?", "input": "OpenMC Python API Settings.trigger_active() method signature", "output": "To call the trigger_active() method, use: @property def trigger_active(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the trigger_active() method in the Settings class?", "input": "OpenMC Python API Settings.trigger_active() method signature", "output": "To call the trigger_active() method, use: @trigger_active.setter def trigger_active(self: Any, trigger_active: bool). It takes 2 parameters." }, { "instruction": "How do you call the trigger_max_batches() method in the Settings class?", "input": "OpenMC Python API Settings.trigger_max_batches() method signature", "output": "To call the trigger_max_batches() method, use: @property def trigger_max_batches(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the trigger_max_batches() method in the Settings class?", "input": "OpenMC Python API Settings.trigger_max_batches() method signature", "output": "To call the trigger_max_batches() method, use: @trigger_max_batches.setter def trigger_max_batches(self: Any, trigger_max_batches: int). It takes 2 parameters." }, { "instruction": "How do you call the trigger_batch_interval() method in the Settings class?", "input": "OpenMC Python API Settings.trigger_batch_interval() method signature", "output": "To call the trigger_batch_interval() method, use: @property def trigger_batch_interval(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the trigger_batch_interval() method in the Settings class?", "input": "OpenMC Python API Settings.trigger_batch_interval() method signature", "output": "To call the trigger_batch_interval() method, use: @trigger_batch_interval.setter def trigger_batch_interval(self: Any, trigger_batch_interval: int). It takes 2 parameters." }, { "instruction": "How do you call the output() method in the Settings class?", "input": "OpenMC Python API Settings.output() method signature", "output": "To call the output() method, use: @property def output(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the output() method in the Settings class?", "input": "OpenMC Python API Settings.output() method signature", "output": "To call the output() method, use: @output.setter def output(self: Any, output: dict). It takes 2 parameters." }, { "instruction": "How do you call the sourcepoint() method in the Settings class?", "input": "OpenMC Python API Settings.sourcepoint() method signature", "output": "To call the sourcepoint() method, use: @property def sourcepoint(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sourcepoint() method in the Settings class?", "input": "OpenMC Python API Settings.sourcepoint() method signature", "output": "To call the sourcepoint() method, use: @sourcepoint.setter def sourcepoint(self: Any, sourcepoint: dict). It takes 2 parameters." }, { "instruction": "How do you call the statepoint() method in the Settings class?", "input": "OpenMC Python API Settings.statepoint() method signature", "output": "To call the statepoint() method, use: @property def statepoint(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the statepoint() method in the Settings class?", "input": "OpenMC Python API Settings.statepoint() method signature", "output": "To call the statepoint() method, use: @statepoint.setter def statepoint(self: Any, statepoint: dict). It takes 2 parameters." }, { "instruction": "How do you call the surf_source_read() method in the Settings class?", "input": "OpenMC Python API Settings.surf_source_read() method signature", "output": "To call the surf_source_read() method, use: @property def surf_source_read(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the surf_source_read() method in the Settings class?", "input": "OpenMC Python API Settings.surf_source_read() method signature", "output": "To call the surf_source_read() method, use: @surf_source_read.setter def surf_source_read(self: Any, ssr: dict). It takes 2 parameters." }, { "instruction": "How do you call the surf_source_write() method in the Settings class?", "input": "OpenMC Python API Settings.surf_source_write() method signature", "output": "To call the surf_source_write() method, use: @property def surf_source_write(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the surf_source_write() method in the Settings class?", "input": "OpenMC Python API Settings.surf_source_write() method signature", "output": "To call the surf_source_write() method, use: @surf_source_write.setter def surf_source_write(self: Any, surf_source_write: dict). It takes 2 parameters." }, { "instruction": "How do you call the no_reduce() method in the Settings class?", "input": "OpenMC Python API Settings.no_reduce() method signature", "output": "To call the no_reduce() method, use: @property def no_reduce(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the no_reduce() method in the Settings class?", "input": "OpenMC Python API Settings.no_reduce() method signature", "output": "To call the no_reduce() method, use: @no_reduce.setter def no_reduce(self: Any, no_reduce: bool). It takes 2 parameters." }, { "instruction": "How do you call the verbosity() method in the Settings class?", "input": "OpenMC Python API Settings.verbosity() method signature", "output": "To call the verbosity() method, use: @property def verbosity(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the verbosity() method in the Settings class?", "input": "OpenMC Python API Settings.verbosity() method signature", "output": "To call the verbosity() method, use: @verbosity.setter def verbosity(self: Any, verbosity: int). It takes 2 parameters." }, { "instruction": "How do you call the ifp_n_generation() method in the Settings class?", "input": "OpenMC Python API Settings.ifp_n_generation() method signature", "output": "To call the ifp_n_generation() method, use: @property def ifp_n_generation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ifp_n_generation() method in the Settings class?", "input": "OpenMC Python API Settings.ifp_n_generation() method signature", "output": "To call the ifp_n_generation() method, use: @ifp_n_generation.setter def ifp_n_generation(self: Any, ifp_n_generation: int). It takes 2 parameters." }, { "instruction": "How do you call the tabular_legendre() method in the Settings class?", "input": "OpenMC Python API Settings.tabular_legendre() method signature", "output": "To call the tabular_legendre() method, use: @property def tabular_legendre(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tabular_legendre() method in the Settings class?", "input": "OpenMC Python API Settings.tabular_legendre() method signature", "output": "To call the tabular_legendre() method, use: @tabular_legendre.setter def tabular_legendre(self: Any, tabular_legendre: dict). It takes 2 parameters." }, { "instruction": "How do you call the temperature() method in the Settings class?", "input": "OpenMC Python API Settings.temperature() method signature", "output": "To call the temperature() method, use: @property def temperature(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the temperature() method in the Settings class?", "input": "OpenMC Python API Settings.temperature() method signature", "output": "To call the temperature() method, use: @temperature.setter def temperature(self: Any, temperature: dict). It takes 2 parameters." }, { "instruction": "How do you call the trace() method in the Settings class?", "input": "OpenMC Python API Settings.trace() method signature", "output": "To call the trace() method, use: @property def trace(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the trace() method in the Settings class?", "input": "OpenMC Python API Settings.trace() method signature", "output": "To call the trace() method, use: @trace.setter def trace(self: Any, trace: Iterable). It takes 2 parameters." }, { "instruction": "How do you call the track() method in the Settings class?", "input": "OpenMC Python API Settings.track() method signature", "output": "To call the track() method, use: @property def track(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the track() method in the Settings class?", "input": "OpenMC Python API Settings.track() method signature", "output": "To call the track() method, use: @track.setter def track(self: Any, track: Any). It takes 2 parameters." }, { "instruction": "How do you call the cutoff() method in the Settings class?", "input": "OpenMC Python API Settings.cutoff() method signature", "output": "To call the cutoff() method, use: @property def cutoff(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cutoff() method in the Settings class?", "input": "OpenMC Python API Settings.cutoff() method signature", "output": "To call the cutoff() method, use: @cutoff.setter def cutoff(self: Any, cutoff: dict). It takes 2 parameters." }, { "instruction": "How do you call the ufs_mesh() method in the Settings class?", "input": "OpenMC Python API Settings.ufs_mesh() method signature", "output": "To call the ufs_mesh() method, use: @property def ufs_mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ufs_mesh() method in the Settings class?", "input": "OpenMC Python API Settings.ufs_mesh() method signature", "output": "To call the ufs_mesh() method, use: @ufs_mesh.setter def ufs_mesh(self: Any, ufs_mesh: RegularMesh). It takes 2 parameters." }, { "instruction": "How do you call the resonance_scattering() method in the Settings class?", "input": "OpenMC Python API Settings.resonance_scattering() method signature", "output": "To call the resonance_scattering() method, use: @property def resonance_scattering(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the resonance_scattering() method in the Settings class?", "input": "OpenMC Python API Settings.resonance_scattering() method signature", "output": "To call the resonance_scattering() method, use: @resonance_scattering.setter def resonance_scattering(self: Any, res: dict). It takes 2 parameters." }, { "instruction": "How do you call the volume_calculations() method in the Settings class?", "input": "OpenMC Python API Settings.volume_calculations() method signature", "output": "To call the volume_calculations() method, use: @property def volume_calculations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume_calculations() method in the Settings class?", "input": "OpenMC Python API Settings.volume_calculations() method signature", "output": "To call the volume_calculations() method, use: @volume_calculations.setter def volume_calculations(self: Any, vol_calcs: Any). It takes 2 parameters." }, { "instruction": "How do you call the create_fission_neutrons() method in the Settings class?", "input": "OpenMC Python API Settings.create_fission_neutrons() method signature", "output": "To call the create_fission_neutrons() method, use: @property def create_fission_neutrons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the create_fission_neutrons() method in the Settings class?", "input": "OpenMC Python API Settings.create_fission_neutrons() method signature", "output": "To call the create_fission_neutrons() method, use: @create_fission_neutrons.setter def create_fission_neutrons(self: Any, create_fission_neutrons: bool). It takes 2 parameters." }, { "instruction": "How do you call the create_delayed_neutrons() method in the Settings class?", "input": "OpenMC Python API Settings.create_delayed_neutrons() method signature", "output": "To call the create_delayed_neutrons() method, use: @property def create_delayed_neutrons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the create_delayed_neutrons() method in the Settings class?", "input": "OpenMC Python API Settings.create_delayed_neutrons() method signature", "output": "To call the create_delayed_neutrons() method, use: @create_delayed_neutrons.setter def create_delayed_neutrons(self: Any, create_delayed_neutrons: bool). It takes 2 parameters." }, { "instruction": "How do you call the delayed_photon_scaling() method in the Settings class?", "input": "OpenMC Python API Settings.delayed_photon_scaling() method signature", "output": "To call the delayed_photon_scaling() method, use: @property def delayed_photon_scaling(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the delayed_photon_scaling() method in the Settings class?", "input": "OpenMC Python API Settings.delayed_photon_scaling() method signature", "output": "To call the delayed_photon_scaling() method, use: @delayed_photon_scaling.setter def delayed_photon_scaling(self: Any, value: bool). It takes 2 parameters." }, { "instruction": "How do you call the material_cell_offsets() method in the Settings class?", "input": "OpenMC Python API Settings.material_cell_offsets() method signature", "output": "To call the material_cell_offsets() method, use: @property def material_cell_offsets(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the material_cell_offsets() method in the Settings class?", "input": "OpenMC Python API Settings.material_cell_offsets() method signature", "output": "To call the material_cell_offsets() method, use: @material_cell_offsets.setter def material_cell_offsets(self: Any, value: bool). It takes 2 parameters." }, { "instruction": "How do you call the log_grid_bins() method in the Settings class?", "input": "OpenMC Python API Settings.log_grid_bins() method signature", "output": "To call the log_grid_bins() method, use: @property def log_grid_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the log_grid_bins() method in the Settings class?", "input": "OpenMC Python API Settings.log_grid_bins() method signature", "output": "To call the log_grid_bins() method, use: @log_grid_bins.setter def log_grid_bins(self: Any, log_grid_bins: int). It takes 2 parameters." }, { "instruction": "How do you call the event_based() method in the Settings class?", "input": "OpenMC Python API Settings.event_based() method signature", "output": "To call the event_based() method, use: @property def event_based(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the event_based() method in the Settings class?", "input": "OpenMC Python API Settings.event_based() method signature", "output": "To call the event_based() method, use: @event_based.setter def event_based(self: Any, value: bool). It takes 2 parameters." }, { "instruction": "How do you call the max_particles_in_flight() method in the Settings class?", "input": "OpenMC Python API Settings.max_particles_in_flight() method signature", "output": "To call the max_particles_in_flight() method, use: @property def max_particles_in_flight(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_particles_in_flight() method in the Settings class?", "input": "OpenMC Python API Settings.max_particles_in_flight() method signature", "output": "To call the max_particles_in_flight() method, use: @max_particles_in_flight.setter def max_particles_in_flight(self: Any, value: int). It takes 2 parameters." }, { "instruction": "How do you call the max_particle_events() method in the Settings class?", "input": "OpenMC Python API Settings.max_particle_events() method signature", "output": "To call the max_particle_events() method, use: @property def max_particle_events(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_particle_events() method in the Settings class?", "input": "OpenMC Python API Settings.max_particle_events() method signature", "output": "To call the max_particle_events() method, use: @max_particle_events.setter def max_particle_events(self: Any, value: int). It takes 2 parameters." }, { "instruction": "How do you call the write_initial_source() method in the Settings class?", "input": "OpenMC Python API Settings.write_initial_source() method signature", "output": "To call the write_initial_source() method, use: @property def write_initial_source(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the write_initial_source() method in the Settings class?", "input": "OpenMC Python API Settings.write_initial_source() method signature", "output": "To call the write_initial_source() method, use: @write_initial_source.setter def write_initial_source(self: Any, value: bool). It takes 2 parameters." }, { "instruction": "How do you call the weight_windows() method in the Settings class?", "input": "OpenMC Python API Settings.weight_windows() method signature", "output": "To call the weight_windows() method, use: @property def weight_windows(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the weight_windows() method in the Settings class?", "input": "OpenMC Python API Settings.weight_windows() method signature", "output": "To call the weight_windows() method, use: @weight_windows.setter def weight_windows(self: Any, value: Any). It takes 2 parameters." }, { "instruction": "How do you call the weight_windows_on() method in the Settings class?", "input": "OpenMC Python API Settings.weight_windows_on() method signature", "output": "To call the weight_windows_on() method, use: @property def weight_windows_on(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the weight_windows_on() method in the Settings class?", "input": "OpenMC Python API Settings.weight_windows_on() method signature", "output": "To call the weight_windows_on() method, use: @weight_windows_on.setter def weight_windows_on(self: Any, value: bool). It takes 2 parameters." }, { "instruction": "How do you call the weight_window_checkpoints() method in the Settings class?", "input": "OpenMC Python API Settings.weight_window_checkpoints() method signature", "output": "To call the weight_window_checkpoints() method, use: @property def weight_window_checkpoints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the weight_window_checkpoints() method in the Settings class?", "input": "OpenMC Python API Settings.weight_window_checkpoints() method signature", "output": "To call the weight_window_checkpoints() method, use: @weight_window_checkpoints.setter def weight_window_checkpoints(self: Any, weight_window_checkpoints: dict). It takes 2 parameters." }, { "instruction": "How do you call the max_splits() method in the Settings class?", "input": "OpenMC Python API Settings.max_splits() method signature", "output": "To call the max_splits() method, use: @property def max_splits(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_history_splits() method in the Settings class?", "input": "OpenMC Python API Settings.max_history_splits() method signature", "output": "To call the max_history_splits() method, use: @property def max_history_splits(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_history_splits() method in the Settings class?", "input": "OpenMC Python API Settings.max_history_splits() method signature", "output": "To call the max_history_splits() method, use: @max_history_splits.setter def max_history_splits(self: Any, value: int). It takes 2 parameters." }, { "instruction": "How do you call the max_tracks() method in the Settings class?", "input": "OpenMC Python API Settings.max_tracks() method signature", "output": "To call the max_tracks() method, use: @property def max_tracks(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_tracks() method in the Settings class?", "input": "OpenMC Python API Settings.max_tracks() method signature", "output": "To call the max_tracks() method, use: @max_tracks.setter def max_tracks(self: Any, value: int). It takes 2 parameters." }, { "instruction": "How do you call the weight_windows_file() method in the Settings class?", "input": "OpenMC Python API Settings.weight_windows_file() method signature", "output": "To call the weight_windows_file() method, use: @property def weight_windows_file(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the weight_windows_file() method in the Settings class?", "input": "OpenMC Python API Settings.weight_windows_file() method signature", "output": "To call the weight_windows_file() method, use: @weight_windows_file.setter def weight_windows_file(self: Any, value: PathLike). It takes 2 parameters." }, { "instruction": "How do you call the weight_window_generators() method in the Settings class?", "input": "OpenMC Python API Settings.weight_window_generators() method signature", "output": "To call the weight_window_generators() method, use: @property def weight_window_generators(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the weight_window_generators() method in the Settings class?", "input": "OpenMC Python API Settings.weight_window_generators() method signature", "output": "To call the weight_window_generators() method, use: @weight_window_generators.setter def weight_window_generators(self: Any, wwgs: Any). It takes 2 parameters." }, { "instruction": "How do you call the random_ray() method in the Settings class?", "input": "OpenMC Python API Settings.random_ray() method signature", "output": "To call the random_ray() method, use: @property def random_ray(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the random_ray() method in the Settings class?", "input": "OpenMC Python API Settings.random_ray() method signature", "output": "To call the random_ray() method, use: @random_ray.setter def random_ray(self: Any, random_ray: dict). It takes 2 parameters." }, { "instruction": "How do you call the use_decay_photons() method in the Settings class?", "input": "OpenMC Python API Settings.use_decay_photons() method signature", "output": "To call the use_decay_photons() method, use: @property def use_decay_photons(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the use_decay_photons() method in the Settings class?", "input": "OpenMC Python API Settings.use_decay_photons() method signature", "output": "To call the use_decay_photons() method, use: @use_decay_photons.setter def use_decay_photons(self: Any, value: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_run_mode_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_run_mode_subelement() method signature", "output": "To call the _create_run_mode_subelement() method, use: def _create_run_mode_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_batches_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_batches_subelement() method signature", "output": "To call the _create_batches_subelement() method, use: def _create_batches_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_generations_per_batch_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_generations_per_batch_subelement() method signature", "output": "To call the _create_generations_per_batch_subelement() method, use: def _create_generations_per_batch_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_inactive_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_inactive_subelement() method signature", "output": "To call the _create_inactive_subelement() method, use: def _create_inactive_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_max_lost_particles_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_max_lost_particles_subelement() method signature", "output": "To call the _create_max_lost_particles_subelement() method, use: def _create_max_lost_particles_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_rel_max_lost_particles_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_rel_max_lost_particles_subelement() method signature", "output": "To call the _create_rel_max_lost_particles_subelement() method, use: def _create_rel_max_lost_particles_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_max_write_lost_particles_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_max_write_lost_particles_subelement() method signature", "output": "To call the _create_max_write_lost_particles_subelement() method, use: def _create_max_write_lost_particles_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_particles_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_particles_subelement() method signature", "output": "To call the _create_particles_subelement() method, use: def _create_particles_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_keff_trigger_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_keff_trigger_subelement() method signature", "output": "To call the _create_keff_trigger_subelement() method, use: def _create_keff_trigger_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_energy_mode_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_energy_mode_subelement() method signature", "output": "To call the _create_energy_mode_subelement() method, use: def _create_energy_mode_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_max_order_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_max_order_subelement() method signature", "output": "To call the _create_max_order_subelement() method, use: def _create_max_order_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_source_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_source_subelement() method signature", "output": "To call the _create_source_subelement() method, use: def _create_source_subelement(self: Any, root: Any, mesh_memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the _create_volume_calcs_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_volume_calcs_subelement() method signature", "output": "To call the _create_volume_calcs_subelement() method, use: def _create_volume_calcs_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_output_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_output_subelement() method signature", "output": "To call the _create_output_subelement() method, use: def _create_output_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_verbosity_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_verbosity_subelement() method signature", "output": "To call the _create_verbosity_subelement() method, use: def _create_verbosity_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_statepoint_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_statepoint_subelement() method signature", "output": "To call the _create_statepoint_subelement() method, use: def _create_statepoint_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_uniform_source_sampling_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_uniform_source_sampling_subelement() method signature", "output": "To call the _create_uniform_source_sampling_subelement() method, use: def _create_uniform_source_sampling_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_sourcepoint_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_sourcepoint_subelement() method signature", "output": "To call the _create_sourcepoint_subelement() method, use: def _create_sourcepoint_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_surf_source_read_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_surf_source_read_subelement() method signature", "output": "To call the _create_surf_source_read_subelement() method, use: def _create_surf_source_read_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_surf_source_write_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_surf_source_write_subelement() method signature", "output": "To call the _create_surf_source_write_subelement() method, use: def _create_surf_source_write_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_confidence_intervals() method in the Settings class?", "input": "OpenMC Python API Settings._create_confidence_intervals() method signature", "output": "To call the _create_confidence_intervals() method, use: def _create_confidence_intervals(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_electron_treatment_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_electron_treatment_subelement() method signature", "output": "To call the _create_electron_treatment_subelement() method, use: def _create_electron_treatment_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_photon_transport_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_photon_transport_subelement() method signature", "output": "To call the _create_photon_transport_subelement() method, use: def _create_photon_transport_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_plot_seed_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_plot_seed_subelement() method signature", "output": "To call the _create_plot_seed_subelement() method, use: def _create_plot_seed_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_ptables_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_ptables_subelement() method signature", "output": "To call the _create_ptables_subelement() method, use: def _create_ptables_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_seed_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_seed_subelement() method signature", "output": "To call the _create_seed_subelement() method, use: def _create_seed_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_stride_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_stride_subelement() method signature", "output": "To call the _create_stride_subelement() method, use: def _create_stride_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_survival_biasing_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_survival_biasing_subelement() method signature", "output": "To call the _create_survival_biasing_subelement() method, use: def _create_survival_biasing_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_cutoff_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_cutoff_subelement() method signature", "output": "To call the _create_cutoff_subelement() method, use: def _create_cutoff_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_entropy_mesh_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_entropy_mesh_subelement() method signature", "output": "To call the _create_entropy_mesh_subelement() method, use: def _create_entropy_mesh_subelement(self: Any, root: Any, mesh_memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the _create_trigger_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_trigger_subelement() method signature", "output": "To call the _create_trigger_subelement() method, use: def _create_trigger_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_no_reduce_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_no_reduce_subelement() method signature", "output": "To call the _create_no_reduce_subelement() method, use: def _create_no_reduce_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_ifp_n_generation_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_ifp_n_generation_subelement() method signature", "output": "To call the _create_ifp_n_generation_subelement() method, use: def _create_ifp_n_generation_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_tabular_legendre_subelements() method in the Settings class?", "input": "OpenMC Python API Settings._create_tabular_legendre_subelements() method signature", "output": "To call the _create_tabular_legendre_subelements() method, use: def _create_tabular_legendre_subelements(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_temperature_subelements() method in the Settings class?", "input": "OpenMC Python API Settings._create_temperature_subelements() method signature", "output": "To call the _create_temperature_subelements() method, use: def _create_temperature_subelements(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_trace_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_trace_subelement() method signature", "output": "To call the _create_trace_subelement() method, use: def _create_trace_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_track_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_track_subelement() method signature", "output": "To call the _create_track_subelement() method, use: def _create_track_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_ufs_mesh_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_ufs_mesh_subelement() method signature", "output": "To call the _create_ufs_mesh_subelement() method, use: def _create_ufs_mesh_subelement(self: Any, root: Any, mesh_memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the _create_use_decay_photons_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_use_decay_photons_subelement() method signature", "output": "To call the _create_use_decay_photons_subelement() method, use: def _create_use_decay_photons_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_resonance_scattering_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_resonance_scattering_subelement() method signature", "output": "To call the _create_resonance_scattering_subelement() method, use: def _create_resonance_scattering_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_create_fission_neutrons_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_create_fission_neutrons_subelement() method signature", "output": "To call the _create_create_fission_neutrons_subelement() method, use: def _create_create_fission_neutrons_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_create_delayed_neutrons_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_create_delayed_neutrons_subelement() method signature", "output": "To call the _create_create_delayed_neutrons_subelement() method, use: def _create_create_delayed_neutrons_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_delayed_photon_scaling_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_delayed_photon_scaling_subelement() method signature", "output": "To call the _create_delayed_photon_scaling_subelement() method, use: def _create_delayed_photon_scaling_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_event_based_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_event_based_subelement() method signature", "output": "To call the _create_event_based_subelement() method, use: def _create_event_based_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_max_particles_in_flight_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_max_particles_in_flight_subelement() method signature", "output": "To call the _create_max_particles_in_flight_subelement() method, use: def _create_max_particles_in_flight_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_max_events_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_max_events_subelement() method signature", "output": "To call the _create_max_events_subelement() method, use: def _create_max_events_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_material_cell_offsets_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_material_cell_offsets_subelement() method signature", "output": "To call the _create_material_cell_offsets_subelement() method, use: def _create_material_cell_offsets_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_log_grid_bins_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_log_grid_bins_subelement() method signature", "output": "To call the _create_log_grid_bins_subelement() method, use: def _create_log_grid_bins_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_write_initial_source_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_write_initial_source_subelement() method signature", "output": "To call the _create_write_initial_source_subelement() method, use: def _create_write_initial_source_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_weight_windows_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_weight_windows_subelement() method signature", "output": "To call the _create_weight_windows_subelement() method, use: def _create_weight_windows_subelement(self: Any, root: Any, mesh_memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the _create_weight_window_generators_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_weight_window_generators_subelement() method signature", "output": "To call the _create_weight_window_generators_subelement() method, use: def _create_weight_window_generators_subelement(self: Any, root: Any, mesh_memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the _create_weight_windows_file_element() method in the Settings class?", "input": "OpenMC Python API Settings._create_weight_windows_file_element() method signature", "output": "To call the _create_weight_windows_file_element() method, use: def _create_weight_windows_file_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_weight_window_checkpoints_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_weight_window_checkpoints_subelement() method signature", "output": "To call the _create_weight_window_checkpoints_subelement() method, use: def _create_weight_window_checkpoints_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_max_history_splits_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_max_history_splits_subelement() method signature", "output": "To call the _create_max_history_splits_subelement() method, use: def _create_max_history_splits_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_max_tracks_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_max_tracks_subelement() method signature", "output": "To call the _create_max_tracks_subelement() method, use: def _create_max_tracks_subelement(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_random_ray_subelement() method in the Settings class?", "input": "OpenMC Python API Settings._create_random_ray_subelement() method signature", "output": "To call the _create_random_ray_subelement() method, use: def _create_random_ray_subelement(self: Any, root: Any, mesh_memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the _eigenvalue_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._eigenvalue_from_xml_element() method signature", "output": "To call the _eigenvalue_from_xml_element() method, use: def _eigenvalue_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _run_mode_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._run_mode_from_xml_element() method signature", "output": "To call the _run_mode_from_xml_element() method, use: def _run_mode_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _particles_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._particles_from_xml_element() method signature", "output": "To call the _particles_from_xml_element() method, use: def _particles_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _batches_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._batches_from_xml_element() method signature", "output": "To call the _batches_from_xml_element() method, use: def _batches_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _inactive_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._inactive_from_xml_element() method signature", "output": "To call the _inactive_from_xml_element() method, use: def _inactive_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _max_lost_particles_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._max_lost_particles_from_xml_element() method signature", "output": "To call the _max_lost_particles_from_xml_element() method, use: def _max_lost_particles_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _rel_max_lost_particles_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._rel_max_lost_particles_from_xml_element() method signature", "output": "To call the _rel_max_lost_particles_from_xml_element() method, use: def _rel_max_lost_particles_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _max_write_lost_particles_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._max_write_lost_particles_from_xml_element() method signature", "output": "To call the _max_write_lost_particles_from_xml_element() method, use: def _max_write_lost_particles_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _generations_per_batch_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._generations_per_batch_from_xml_element() method signature", "output": "To call the _generations_per_batch_from_xml_element() method, use: def _generations_per_batch_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _keff_trigger_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._keff_trigger_from_xml_element() method signature", "output": "To call the _keff_trigger_from_xml_element() method, use: def _keff_trigger_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _source_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._source_from_xml_element() method signature", "output": "To call the _source_from_xml_element() method, use: def _source_from_xml_element(self: Any, root: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "How do you call the _volume_calcs_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._volume_calcs_from_xml_element() method signature", "output": "To call the _volume_calcs_from_xml_element() method, use: def _volume_calcs_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _output_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._output_from_xml_element() method signature", "output": "To call the _output_from_xml_element() method, use: def _output_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _statepoint_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._statepoint_from_xml_element() method signature", "output": "To call the _statepoint_from_xml_element() method, use: def _statepoint_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _sourcepoint_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._sourcepoint_from_xml_element() method signature", "output": "To call the _sourcepoint_from_xml_element() method, use: def _sourcepoint_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _surf_source_read_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._surf_source_read_from_xml_element() method signature", "output": "To call the _surf_source_read_from_xml_element() method, use: def _surf_source_read_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _surf_source_write_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._surf_source_write_from_xml_element() method signature", "output": "To call the _surf_source_write_from_xml_element() method, use: def _surf_source_write_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _confidence_intervals_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._confidence_intervals_from_xml_element() method signature", "output": "To call the _confidence_intervals_from_xml_element() method, use: def _confidence_intervals_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _electron_treatment_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._electron_treatment_from_xml_element() method signature", "output": "To call the _electron_treatment_from_xml_element() method, use: def _electron_treatment_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _energy_mode_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._energy_mode_from_xml_element() method signature", "output": "To call the _energy_mode_from_xml_element() method, use: def _energy_mode_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _max_order_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._max_order_from_xml_element() method signature", "output": "To call the _max_order_from_xml_element() method, use: def _max_order_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _photon_transport_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._photon_transport_from_xml_element() method signature", "output": "To call the _photon_transport_from_xml_element() method, use: def _photon_transport_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _uniform_source_sampling_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._uniform_source_sampling_from_xml_element() method signature", "output": "To call the _uniform_source_sampling_from_xml_element() method, use: def _uniform_source_sampling_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _plot_seed_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._plot_seed_from_xml_element() method signature", "output": "To call the _plot_seed_from_xml_element() method, use: def _plot_seed_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _ptables_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._ptables_from_xml_element() method signature", "output": "To call the _ptables_from_xml_element() method, use: def _ptables_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _seed_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._seed_from_xml_element() method signature", "output": "To call the _seed_from_xml_element() method, use: def _seed_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _stride_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._stride_from_xml_element() method signature", "output": "To call the _stride_from_xml_element() method, use: def _stride_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _survival_biasing_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._survival_biasing_from_xml_element() method signature", "output": "To call the _survival_biasing_from_xml_element() method, use: def _survival_biasing_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _cutoff_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._cutoff_from_xml_element() method signature", "output": "To call the _cutoff_from_xml_element() method, use: def _cutoff_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _entropy_mesh_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._entropy_mesh_from_xml_element() method signature", "output": "To call the _entropy_mesh_from_xml_element() method, use: def _entropy_mesh_from_xml_element(self: Any, root: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "How do you call the _trigger_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._trigger_from_xml_element() method signature", "output": "To call the _trigger_from_xml_element() method, use: def _trigger_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _no_reduce_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._no_reduce_from_xml_element() method signature", "output": "To call the _no_reduce_from_xml_element() method, use: def _no_reduce_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _verbosity_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._verbosity_from_xml_element() method signature", "output": "To call the _verbosity_from_xml_element() method, use: def _verbosity_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _ifp_n_generation_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._ifp_n_generation_from_xml_element() method signature", "output": "To call the _ifp_n_generation_from_xml_element() method, use: def _ifp_n_generation_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _tabular_legendre_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._tabular_legendre_from_xml_element() method signature", "output": "To call the _tabular_legendre_from_xml_element() method, use: def _tabular_legendre_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _temperature_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._temperature_from_xml_element() method signature", "output": "To call the _temperature_from_xml_element() method, use: def _temperature_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _trace_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._trace_from_xml_element() method signature", "output": "To call the _trace_from_xml_element() method, use: def _trace_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _track_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._track_from_xml_element() method signature", "output": "To call the _track_from_xml_element() method, use: def _track_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _ufs_mesh_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._ufs_mesh_from_xml_element() method signature", "output": "To call the _ufs_mesh_from_xml_element() method, use: def _ufs_mesh_from_xml_element(self: Any, root: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "How do you call the _resonance_scattering_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._resonance_scattering_from_xml_element() method signature", "output": "To call the _resonance_scattering_from_xml_element() method, use: def _resonance_scattering_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_fission_neutrons_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._create_fission_neutrons_from_xml_element() method signature", "output": "To call the _create_fission_neutrons_from_xml_element() method, use: def _create_fission_neutrons_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_delayed_neutrons_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._create_delayed_neutrons_from_xml_element() method signature", "output": "To call the _create_delayed_neutrons_from_xml_element() method, use: def _create_delayed_neutrons_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _delayed_photon_scaling_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._delayed_photon_scaling_from_xml_element() method signature", "output": "To call the _delayed_photon_scaling_from_xml_element() method, use: def _delayed_photon_scaling_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _event_based_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._event_based_from_xml_element() method signature", "output": "To call the _event_based_from_xml_element() method, use: def _event_based_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _max_particles_in_flight_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._max_particles_in_flight_from_xml_element() method signature", "output": "To call the _max_particles_in_flight_from_xml_element() method, use: def _max_particles_in_flight_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _max_particle_events_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._max_particle_events_from_xml_element() method signature", "output": "To call the _max_particle_events_from_xml_element() method, use: def _max_particle_events_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _material_cell_offsets_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._material_cell_offsets_from_xml_element() method signature", "output": "To call the _material_cell_offsets_from_xml_element() method, use: def _material_cell_offsets_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _log_grid_bins_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._log_grid_bins_from_xml_element() method signature", "output": "To call the _log_grid_bins_from_xml_element() method, use: def _log_grid_bins_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _write_initial_source_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._write_initial_source_from_xml_element() method signature", "output": "To call the _write_initial_source_from_xml_element() method, use: def _write_initial_source_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _weight_window_generators_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._weight_window_generators_from_xml_element() method signature", "output": "To call the _weight_window_generators_from_xml_element() method, use: def _weight_window_generators_from_xml_element(self: Any, root: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "How do you call the _weight_windows_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._weight_windows_from_xml_element() method signature", "output": "To call the _weight_windows_from_xml_element() method, use: def _weight_windows_from_xml_element(self: Any, root: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "How do you call the _weight_window_checkpoints_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._weight_window_checkpoints_from_xml_element() method signature", "output": "To call the _weight_window_checkpoints_from_xml_element() method, use: def _weight_window_checkpoints_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _max_history_splits_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._max_history_splits_from_xml_element() method signature", "output": "To call the _max_history_splits_from_xml_element() method, use: def _max_history_splits_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _max_tracks_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._max_tracks_from_xml_element() method signature", "output": "To call the _max_tracks_from_xml_element() method, use: def _max_tracks_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _random_ray_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._random_ray_from_xml_element() method signature", "output": "To call the _random_ray_from_xml_element() method, use: def _random_ray_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "How do you call the _use_decay_photons_from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings._use_decay_photons_from_xml_element() method signature", "output": "To call the _use_decay_photons_from_xml_element() method, use: def _use_decay_photons_from_xml_element(self: Any, root: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the Settings class?", "input": "OpenMC Python API Settings.to_xml_element() method", "output": "The to_xml_element() method create a 'settings' element to be written to an xml file. It's used for settings operations." }, { "instruction": "How do you call the to_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, mesh_memo: Any). It takes 2 parameters." }, { "instruction": "What does the mesh_memo parameter do in the to_xml_element() method?", "input": "OpenMC Python API Settings.to_xml_element() parameter mesh_memo", "output": "The mesh_memo parameter a set of mesh ids to keep track of whether a mesh has already been written.. It should be a set of ints value." }, { "instruction": "What does the export_to_xml() method do in the Settings class?", "input": "OpenMC Python API Settings.export_to_xml() method", "output": "The export_to_xml() method export simulation settings to an xml file. It's used for settings operations." }, { "instruction": "How do you call the export_to_xml() method in the Settings class?", "input": "OpenMC Python API Settings.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, path: PathLike). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the export_to_xml() method?", "input": "OpenMC Python API Settings.export_to_xml() parameter path", "output": "The path parameter path to file to write. defaults to 'settings.xml'.. It should be a str value." }, { "instruction": "What does the from_xml_element() method do in the Settings class?", "input": "OpenMC Python API Settings.from_xml_element() method", "output": "The from_xml_element() method generate settings from xml element. It's used for settings operations." }, { "instruction": "How do you call the from_xml_element() method in the Settings class?", "input": "OpenMC Python API Settings.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Settings.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API Settings.from_xml_element() parameter meshes", "output": "The meshes parameter a dictionary with mesh ids as keys and mesh instances as values that have already been read from xml. pre-existing meshes are used and new meshes are added to when creating tally objects.. It should be a dict or None value." }, { "instruction": "What does the from_xml() method do in the Settings class?", "input": "OpenMC Python API Settings.from_xml() method", "output": "The from_xml() method generate settings from xml file .. versionadded:: 0.13.0. It's used for settings operations." }, { "instruction": "How do you call the from_xml() method in the Settings class?", "input": "OpenMC Python API Settings.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, path: PathLike). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the from_xml() method?", "input": "OpenMC Python API Settings.from_xml() parameter path", "output": "The path parameter path to settings xml file. It should be a str, optional value." }, { "instruction": "What is the SourceBase class in OpenMC's Python API?", "input": "OpenMC Python API SourceBase class", "output": "The SourceBase class represents base class for external sources. It provides 9 methods and 0 properties for working with sourcebase data in OpenMC." }, { "instruction": "What does the SourceBase class do in OpenMC's Python API?", "input": "OpenMC Python API SourceBase class description", "output": "The SourceBase class base class for external sources. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the strength parameter do when creating a SourceBase?", "input": "OpenMC Python API SourceBase constructor parameter strength", "output": "When creating a SourceBase, the strength parameter specifies strength of the source. It should be a float value." }, { "instruction": "What does the constraints parameter do when creating a SourceBase?", "input": "OpenMC Python API SourceBase constructor parameter constraints", "output": "When creating a SourceBase, the constraints parameter specifies constraints on sampled source particles. valid keys include 'domains', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'. for 'domains', the corresponding value is an iterable of :class:`openmc.cell`, :class:`openmc.material`, or :class:`openmc.universe` for which sampled sites must be within. for 'time_bounds' and 'energy_bounds', the corresponding value is a sequence of floats giving the lower and upper bounds on time in [s] or energy in [ev] that the sampled particle must be within. for 'fissionable', the value is a bool indicating that only sites in fissionable material should be accepted. the 'rejection_strategy' indicates what should happen when a source particle is rejected: either 'resample' (pick a new particle) or 'kill' (accept and terminate).. It should be a dict value." }, { "instruction": "What is the type attribute of a SourceBase?", "input": "OpenMC Python API SourceBase attribute type", "output": "The type attribute of a SourceBase contains indicator of source type.. It's a {'independent', 'file', 'compiled', 'mesh'} value that you can access after creating a SourceBase instance." }, { "instruction": "What is the strength attribute of a SourceBase?", "input": "OpenMC Python API SourceBase attribute strength", "output": "The strength attribute of a SourceBase contains strength of the source. It's a float value that you can access after creating a SourceBase instance." }, { "instruction": "What is the constraints attribute of a SourceBase?", "input": "OpenMC Python API SourceBase attribute constraints", "output": "The constraints attribute of a SourceBase contains constraints on sampled source particles. valid keys include 'domain_type', 'domain_ids', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'.. It's a dict value that you can access after creating a SourceBase instance." }, { "instruction": "How do you call the __init__() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, strength: Any, constraints: Any). It takes 3 parameters." }, { "instruction": "How do you call the strength() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.strength() method signature", "output": "To call the strength() method, use: @property def strength(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the strength() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.strength() method signature", "output": "To call the strength() method, use: @strength.setter def strength(self: Any, strength: Any). It takes 2 parameters." }, { "instruction": "How do you call the constraints() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.constraints() method signature", "output": "To call the constraints() method, use: @property def constraints(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the constraints() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.constraints() method signature", "output": "To call the constraints() method, use: @constraints.setter def constraints(self: Any, constraints: Any). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method do in the SourceBase class?", "input": "OpenMC Python API SourceBase.populate_xml_element() method", "output": "The populate_xml_element() method add necessary source information to an xml element. It's used for sourcebase operations." }, { "instruction": "How do you call the populate_xml_element() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.populate_xml_element() method signature", "output": "To call the populate_xml_element() method, use: @abstractmethod def populate_xml_element(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method return in the SourceBase class?", "input": "OpenMC Python API SourceBase.populate_xml_element() return value", "output": "The populate_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What does the to_xml_element() method do in the SourceBase class?", "input": "OpenMC Python API SourceBase.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the source. It's used for sourcebase operations." }, { "instruction": "How do you call the to_xml_element() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the SourceBase class?", "input": "OpenMC Python API SourceBase.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing source data. The return type is xml.etree.ElementTree.Element." }, { "instruction": "What does the from_xml_element() method do in the SourceBase class?", "input": "OpenMC Python API SourceBase.from_xml_element() method", "output": "The from_xml_element() method generate source from an xml element. It's used for sourcebase operations." }, { "instruction": "How do you call the from_xml_element() method in the SourceBase class?", "input": "OpenMC Python API SourceBase.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API SourceBase.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API SourceBase.from_xml_element() parameter meshes", "output": "The meshes parameter dictionary with mesh ids as keys and openmc.meshbase instances as values. It should be a dict value." }, { "instruction": "How do you call the _get_constraints() method in the SourceBase class?", "input": "OpenMC Python API SourceBase._get_constraints() method signature", "output": "To call the _get_constraints() method, use: @staticmethod def _get_constraints(elem: ET.Element). It takes 1 parameters." }, { "instruction": "What is the IndependentSource class in OpenMC's Python API?", "input": "OpenMC Python API IndependentSource class", "output": "The IndependentSource class represents distribution of phase space coordinates for source sites. .. versionadded:: 0.14.0. It provides 16 methods and 0 properties for working with independentsource data in OpenMC." }, { "instruction": "What does the IndependentSource class do in OpenMC's Python API?", "input": "OpenMC Python API IndependentSource class description", "output": "The IndependentSource class distribution of phase space coordinates for source sites. .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the space parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter space", "output": "When creating a IndependentSource, the space parameter specifies spatial distribution of source sites. It should be a openmc.stats.Spatial value." }, { "instruction": "What does the angle parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter angle", "output": "When creating a IndependentSource, the angle parameter specifies angular distribution of source sites. It should be a openmc.stats.UnitSphere value." }, { "instruction": "What does the energy parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter energy", "output": "When creating a IndependentSource, the energy parameter specifies energy distribution of source sites. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the time parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter time", "output": "When creating a IndependentSource, the time parameter specifies time distribution of source sites. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the strength parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter strength", "output": "When creating a IndependentSource, the strength parameter specifies strength of the source. It should be a float value." }, { "instruction": "What does the particle parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter particle", "output": "When creating a IndependentSource, the particle parameter specifies source particle type. It should be a {'neutron', 'photon'} value." }, { "instruction": "What does the domains parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter domains", "output": "When creating a IndependentSource, the domains parameter specifies domains to reject based on, i.e., if a sampled spatial location is not within one of these domains, it will be rejected. .. deprecated:: 0.15.0 use the `constraints` argument instead.. It should be a iterable of openmc.Cell, openmc.Material, or openmc.Universe value." }, { "instruction": "What does the constraints parameter do when creating a IndependentSource?", "input": "OpenMC Python API IndependentSource constructor parameter constraints", "output": "When creating a IndependentSource, the constraints parameter specifies constraints on sampled source particles. valid keys include 'domains', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'. for 'domains', the corresponding value is an iterable of :class:`openmc.cell`, :class:`openmc.material`, or :class:`openmc.universe` for which sampled sites must be within. for 'time_bounds' and 'energy_bounds', the corresponding value is a sequence of floats giving the lower and upper bounds on time in [s] or energy in [ev] that the sampled particle must be within. for 'fissionable', the value is a bool indicating that only sites in fissionable material should be accepted. the 'rejection_strategy' indicates what should happen when a source particle is rejected: either 'resample' (pick a new particle) or 'kill' (accept and terminate).. It should be a dict value." }, { "instruction": "What is the space attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute space", "output": "The space attribute of a IndependentSource contains spatial distribution of source sites. It's a openmc.stats.Spatial or None value that you can access after creating a IndependentSource instance." }, { "instruction": "What is the angle attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute angle", "output": "The angle attribute of a IndependentSource contains angular distribution of source sites. It's a openmc.stats.UnitSphere or None value that you can access after creating a IndependentSource instance." }, { "instruction": "What is the energy attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute energy", "output": "The energy attribute of a IndependentSource contains energy distribution of source sites. It's a openmc.stats.Univariate or None value that you can access after creating a IndependentSource instance." }, { "instruction": "What is the time attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute time", "output": "The time attribute of a IndependentSource contains time distribution of source sites. It's a openmc.stats.Univariate or None value that you can access after creating a IndependentSource instance." }, { "instruction": "What is the strength attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute strength", "output": "The strength attribute of a IndependentSource contains strength of the source. It's a float value that you can access after creating a IndependentSource instance." }, { "instruction": "What is the type attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute type", "output": "The type attribute of a IndependentSource contains indicator of source type: 'independent' .. versionadded:: 0.14.0. It's a str value that you can access after creating a IndependentSource instance." }, { "instruction": "What is the particle attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute particle", "output": "The particle attribute of a IndependentSource contains source particle type. It's a {'neutron', 'photon'} value that you can access after creating a IndependentSource instance." }, { "instruction": "What is the constraints attribute of a IndependentSource?", "input": "OpenMC Python API IndependentSource attribute constraints", "output": "The constraints attribute of a IndependentSource contains constraints on sampled source particles. valid keys include 'domain_type', 'domain_ids', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'.. It's a dict value that you can access after creating a IndependentSource instance." }, { "instruction": "How do you call the __init__() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, space: Any, angle: Any, energy: Any, time: Any, strength: float, particle: str, domains: Any, constraints: Any). It takes 9 parameters." }, { "instruction": "How do you call the type() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getattr__() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.__getattr__() method signature", "output": "To call the __getattr__() method, use: def __getattr__(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the __setattr__() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.__setattr__() method signature", "output": "To call the __setattr__() method, use: def __setattr__(self: Any, name: Any, value: Any). It takes 3 parameters." }, { "instruction": "How do you call the space() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.space() method signature", "output": "To call the space() method, use: @property def space(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the space() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.space() method signature", "output": "To call the space() method, use: @space.setter def space(self: Any, space: Any). It takes 2 parameters." }, { "instruction": "How do you call the angle() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.angle() method signature", "output": "To call the angle() method, use: @property def angle(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the angle() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.angle() method signature", "output": "To call the angle() method, use: @angle.setter def angle(self: Any, angle: Any). It takes 2 parameters." }, { "instruction": "How do you call the energy() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.energy() method signature", "output": "To call the energy() method, use: @property def energy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.energy() method signature", "output": "To call the energy() method, use: @energy.setter def energy(self: Any, energy: Any). It takes 2 parameters." }, { "instruction": "How do you call the time() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.time() method signature", "output": "To call the time() method, use: @property def time(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the time() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.time() method signature", "output": "To call the time() method, use: @time.setter def time(self: Any, time: Any). It takes 2 parameters." }, { "instruction": "How do you call the particle() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.particle() method signature", "output": "To call the particle() method, use: @property def particle(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the particle() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.particle() method signature", "output": "To call the particle() method, use: @particle.setter def particle(self: Any, particle: Any). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method do in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.populate_xml_element() method", "output": "The populate_xml_element() method add necessary source information to an xml element. It's used for independentsource operations." }, { "instruction": "How do you call the populate_xml_element() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.populate_xml_element() method signature", "output": "To call the populate_xml_element() method, use: def populate_xml_element(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method return in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.populate_xml_element() return value", "output": "The populate_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.from_xml_element() method", "output": "The from_xml_element() method generate source from an xml element. It's used for independentsource operations." }, { "instruction": "How do you call the from_xml_element() method in the IndependentSource class?", "input": "OpenMC Python API IndependentSource.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API IndependentSource.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API IndependentSource.from_xml_element() parameter meshes", "output": "The meshes parameter dictionary with mesh ids as keys and openmc.meshbase instaces as values. It should be a dict value." }, { "instruction": "What is the MeshSource class in OpenMC's Python API?", "input": "OpenMC Python API MeshSource class", "output": "The MeshSource class represents a source with a spatial distribution over mesh elements this class represents a mesh-based source in which random positions are uniformly sampled within mesh elements and each element can have independent angle, energy, and time distributions. the element sampled is chosen based on the relative strengths of the sources applied to the elements. the strength of the mesh source as a whole is the sum of all source strengths applied to the elements. .. versionadded:: 0.15.0. It provides 12 methods and 0 properties for working with meshsource data in OpenMC." }, { "instruction": "What does the MeshSource class do in OpenMC's Python API?", "input": "OpenMC Python API MeshSource class description", "output": "The MeshSource class a source with a spatial distribution over mesh elements this class represents a mesh-based source in which random positions are uniformly sampled within mesh elements and each element can have independent angle, energy, and time distributions. the element sampled is chosen based on the relative strengths of the sources applied to the elements. the strength of the mesh source as a whole is the sum of all source strengths applied to the elements. .. versionadded:: 0.15.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshSource?", "input": "OpenMC Python API MeshSource constructor parameter mesh", "output": "When creating a MeshSource, the mesh parameter specifies the mesh over which source sites will be generated.. It should be a openmc.MeshBase value." }, { "instruction": "What does the sources parameter do when creating a MeshSource?", "input": "OpenMC Python API MeshSource constructor parameter sources", "output": "When creating a MeshSource, the sources parameter specifies sources for each element in the mesh. sources must be specified as either a 1-d array in the order of the mesh indices or a multidimensional array whose shape matches the mesh shape. if spatial distributions are set on any of the source objects, they will be ignored during source site sampling.. It should be a sequence of openmc.SourceBase value." }, { "instruction": "What does the constraints parameter do when creating a MeshSource?", "input": "OpenMC Python API MeshSource constructor parameter constraints", "output": "When creating a MeshSource, the constraints parameter specifies constraints on sampled source particles. valid keys include 'domains', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'. for 'domains', the corresponding value is an iterable of :class:`openmc.cell`, :class:`openmc.material`, or :class:`openmc.universe` for which sampled sites must be within. for 'time_bounds' and 'energy_bounds', the corresponding value is a sequence of floats giving the lower and upper bounds on time in [s] or energy in [ev] that the sampled particle must be within. for 'fissionable', the value is a bool indicating that only sites in fissionable material should be accepted. the 'rejection_strategy' indicates what should happen when a source particle is rejected: either 'resample' (pick a new particle) or 'kill' (accept and terminate).. It should be a dict value." }, { "instruction": "What is the mesh attribute of a MeshSource?", "input": "OpenMC Python API MeshSource attribute mesh", "output": "The mesh attribute of a MeshSource contains the mesh over which source sites will be generated.. It's a openmc.MeshBase value that you can access after creating a MeshSource instance." }, { "instruction": "What is the sources attribute of a MeshSource?", "input": "OpenMC Python API MeshSource attribute sources", "output": "The sources attribute of a MeshSource contains sources to apply to each element. It's a numpy.ndarray of openmc.SourceBase value that you can access after creating a MeshSource instance." }, { "instruction": "What is the strength attribute of a MeshSource?", "input": "OpenMC Python API MeshSource attribute strength", "output": "The strength attribute of a MeshSource contains strength of the source. It's a float value that you can access after creating a MeshSource instance." }, { "instruction": "What is the type attribute of a MeshSource?", "input": "OpenMC Python API MeshSource attribute type", "output": "The type attribute of a MeshSource contains indicator of source type: 'mesh'. It's a str value that you can access after creating a MeshSource instance." }, { "instruction": "What is the constraints attribute of a MeshSource?", "input": "OpenMC Python API MeshSource attribute constraints", "output": "The constraints attribute of a MeshSource contains constraints on sampled source particles. valid keys include 'domain_type', 'domain_ids', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'.. It's a dict value that you can access after creating a MeshSource instance." }, { "instruction": "How do you call the __init__() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: MeshBase, sources: Any, constraints: Any). It takes 4 parameters." }, { "instruction": "How do you call the type() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the strength() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.strength() method signature", "output": "To call the strength() method, use: @property def strength(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sources() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.sources() method signature", "output": "To call the sources() method, use: @property def sources(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, m: Any). It takes 2 parameters." }, { "instruction": "How do you call the sources() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.sources() method signature", "output": "To call the sources() method, use: @sources.setter def sources(self: Any, s: Any). It takes 2 parameters." }, { "instruction": "How do you call the strength() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.strength() method signature", "output": "To call the strength() method, use: @strength.setter def strength(self: Any, val: Any). It takes 2 parameters." }, { "instruction": "What does the set_total_strength() method do in the MeshSource class?", "input": "OpenMC Python API MeshSource.set_total_strength() method", "output": "The set_total_strength() method scales the element source strengths based on a desired total strength. It's used for meshsource operations." }, { "instruction": "How do you call the set_total_strength() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.set_total_strength() method signature", "output": "To call the set_total_strength() method, use: def set_total_strength(self: Any, strength: float). It takes 2 parameters." }, { "instruction": "What does the strength parameter do in the set_total_strength() method?", "input": "OpenMC Python API MeshSource.set_total_strength() parameter strength", "output": "The strength parameter total source strength. It should be a float value." }, { "instruction": "What does the normalize_source_strengths() method do in the MeshSource class?", "input": "OpenMC Python API MeshSource.normalize_source_strengths() method", "output": "The normalize_source_strengths() method update all element source strengths such that they sum to 1.0.. It's used for meshsource operations." }, { "instruction": "How do you call the normalize_source_strengths() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.normalize_source_strengths() method signature", "output": "To call the normalize_source_strengths() method, use: def normalize_source_strengths(self: Any). It takes 1 parameters." }, { "instruction": "What does the populate_xml_element() method do in the MeshSource class?", "input": "OpenMC Python API MeshSource.populate_xml_element() method", "output": "The populate_xml_element() method add necessary source information to an xml element. It's used for meshsource operations." }, { "instruction": "How do you call the populate_xml_element() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.populate_xml_element() method signature", "output": "To call the populate_xml_element() method, use: def populate_xml_element(self: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method return in the MeshSource class?", "input": "OpenMC Python API MeshSource.populate_xml_element() return value", "output": "The populate_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the MeshSource class?", "input": "OpenMC Python API MeshSource.from_xml_element() method", "output": "The from_xml_element() method generate meshsource from an xml element. It's used for meshsource operations." }, { "instruction": "How do you call the from_xml_element() method in the MeshSource class?", "input": "OpenMC Python API MeshSource.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API MeshSource.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API MeshSource.from_xml_element() parameter meshes", "output": "The meshes parameter a dictionary with mesh ids as keys and openmc.meshbase instances as values. It should be a dict value." }, { "instruction": "What is the CompiledSource class in OpenMC's Python API?", "input": "OpenMC Python API CompiledSource class", "output": "The CompiledSource class represents a source based on a compiled shared library .. versionadded:: 0.14.0. It provides 8 methods and 0 properties for working with compiledsource data in OpenMC." }, { "instruction": "What does the CompiledSource class do in OpenMC's Python API?", "input": "OpenMC Python API CompiledSource class description", "output": "The CompiledSource class a source based on a compiled shared library .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the library parameter do when creating a CompiledSource?", "input": "OpenMC Python API CompiledSource constructor parameter library", "output": "When creating a CompiledSource, the library parameter specifies path to a compiled shared library. It should be a path-like value." }, { "instruction": "What does the parameters parameter do when creating a CompiledSource?", "input": "OpenMC Python API CompiledSource constructor parameter parameters", "output": "When creating a CompiledSource, the parameters parameter specifies parameters to be provided to the compiled shared library function. It should be a str value." }, { "instruction": "What does the strength parameter do when creating a CompiledSource?", "input": "OpenMC Python API CompiledSource constructor parameter strength", "output": "When creating a CompiledSource, the strength parameter specifies strength of the source. It should be a float value." }, { "instruction": "What does the constraints parameter do when creating a CompiledSource?", "input": "OpenMC Python API CompiledSource constructor parameter constraints", "output": "When creating a CompiledSource, the constraints parameter specifies constraints on sampled source particles. valid keys include 'domains', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'. for 'domains', the corresponding value is an iterable of :class:`openmc.cell`, :class:`openmc.material`, or :class:`openmc.universe` for which sampled sites must be within. for 'time_bounds' and 'energy_bounds', the corresponding value is a sequence of floats giving the lower and upper bounds on time in [s] or energy in [ev] that the sampled particle must be within. for 'fissionable', the value is a bool indicating that only sites in fissionable material should be accepted. the 'rejection_strategy' indicates what should happen when a source particle is rejected: either 'resample' (pick a new particle) or 'kill' (accept and terminate).. It should be a dict value." }, { "instruction": "What is the library attribute of a CompiledSource?", "input": "OpenMC Python API CompiledSource attribute library", "output": "The library attribute of a CompiledSource contains path to a compiled shared library. It's a pathlib.Path value that you can access after creating a CompiledSource instance." }, { "instruction": "What is the parameters attribute of a CompiledSource?", "input": "OpenMC Python API CompiledSource attribute parameters", "output": "The parameters attribute of a CompiledSource contains parameters to be provided to the compiled shared library function. It's a str value that you can access after creating a CompiledSource instance." }, { "instruction": "What is the strength attribute of a CompiledSource?", "input": "OpenMC Python API CompiledSource attribute strength", "output": "The strength attribute of a CompiledSource contains strength of the source. It's a float value that you can access after creating a CompiledSource instance." }, { "instruction": "What is the type attribute of a CompiledSource?", "input": "OpenMC Python API CompiledSource attribute type", "output": "The type attribute of a CompiledSource contains indicator of source type: 'compiled'. It's a str value that you can access after creating a CompiledSource instance." }, { "instruction": "What is the constraints attribute of a CompiledSource?", "input": "OpenMC Python API CompiledSource attribute constraints", "output": "The constraints attribute of a CompiledSource contains constraints on sampled source particles. valid keys include 'domain_type', 'domain_ids', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'.. It's a dict value that you can access after creating a CompiledSource instance." }, { "instruction": "How do you call the __init__() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, library: PathLike, parameters: Any, strength: float, constraints: Any). It takes 5 parameters." }, { "instruction": "How do you call the type() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the library() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.library() method signature", "output": "To call the library() method, use: @property def library(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the library() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.library() method signature", "output": "To call the library() method, use: @library.setter def library(self: Any, library_name: PathLike). It takes 2 parameters." }, { "instruction": "How do you call the parameters() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.parameters() method signature", "output": "To call the parameters() method, use: @property def parameters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the parameters() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.parameters() method signature", "output": "To call the parameters() method, use: @parameters.setter def parameters(self: Any, parameters_path: Any). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method do in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.populate_xml_element() method", "output": "The populate_xml_element() method add necessary compiled source information to an xml element. It's used for compiledsource operations." }, { "instruction": "How do you call the populate_xml_element() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.populate_xml_element() method signature", "output": "To call the populate_xml_element() method, use: def populate_xml_element(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method return in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.populate_xml_element() return value", "output": "The populate_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.from_xml_element() method", "output": "The from_xml_element() method generate a compiled source from an xml element. It's used for compiledsource operations." }, { "instruction": "How do you call the from_xml_element() method in the CompiledSource class?", "input": "OpenMC Python API CompiledSource.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API CompiledSource.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API CompiledSource.from_xml_element() parameter meshes", "output": "The meshes parameter dictionary with mesh ids as keys and openmc.meshbase instances as values. It should be a dict value." }, { "instruction": "What is the FileSource class in OpenMC's Python API?", "input": "OpenMC Python API FileSource class", "output": "The FileSource class represents a source based on particles stored in a file .. versionadded:: 0.14.0. It provides 6 methods and 0 properties for working with filesource data in OpenMC." }, { "instruction": "What does the FileSource class do in OpenMC's Python API?", "input": "OpenMC Python API FileSource class description", "output": "The FileSource class a source based on particles stored in a file .. versionadded:: 0.14.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the path parameter do when creating a FileSource?", "input": "OpenMC Python API FileSource constructor parameter path", "output": "When creating a FileSource, the path parameter specifies path to the source file from which sites should be sampled. It should be a path-like value." }, { "instruction": "What does the strength parameter do when creating a FileSource?", "input": "OpenMC Python API FileSource constructor parameter strength", "output": "When creating a FileSource, the strength parameter specifies strength of the source (default is 1.0). It should be a float value." }, { "instruction": "What does the constraints parameter do when creating a FileSource?", "input": "OpenMC Python API FileSource constructor parameter constraints", "output": "When creating a FileSource, the constraints parameter specifies constraints on sampled source particles. valid keys include 'domains', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'. for 'domains', the corresponding value is an iterable of :class:`openmc.cell`, :class:`openmc.material`, or :class:`openmc.universe` for which sampled sites must be within. for 'time_bounds' and 'energy_bounds', the corresponding value is a sequence of floats giving the lower and upper bounds on time in [s] or energy in [ev] that the sampled particle must be within. for 'fissionable', the value is a bool indicating that only sites in fissionable material should be accepted. the 'rejection_strategy' indicates what should happen when a source particle is rejected: either 'resample' (pick a new particle) or 'kill' (accept and terminate).. It should be a dict value." }, { "instruction": "What is the path attribute of a FileSource?", "input": "OpenMC Python API FileSource attribute path", "output": "The path attribute of a FileSource contains source file from which sites should be sampled. It's a Pathlike value that you can access after creating a FileSource instance." }, { "instruction": "What is the strength attribute of a FileSource?", "input": "OpenMC Python API FileSource attribute strength", "output": "The strength attribute of a FileSource contains strength of the source. It's a float value that you can access after creating a FileSource instance." }, { "instruction": "What is the type attribute of a FileSource?", "input": "OpenMC Python API FileSource attribute type", "output": "The type attribute of a FileSource contains indicator of source type: 'file'. It's a str value that you can access after creating a FileSource instance." }, { "instruction": "What is the constraints attribute of a FileSource?", "input": "OpenMC Python API FileSource attribute constraints", "output": "The constraints attribute of a FileSource contains constraints on sampled source particles. valid keys include 'domain_type', 'domain_ids', 'time_bounds', 'energy_bounds', 'fissionable', and 'rejection_strategy'.. It's a dict value that you can access after creating a FileSource instance." }, { "instruction": "How do you call the __init__() method in the FileSource class?", "input": "OpenMC Python API FileSource.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, path: PathLike, strength: float, constraints: Any). It takes 4 parameters." }, { "instruction": "How do you call the type() method in the FileSource class?", "input": "OpenMC Python API FileSource.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the path() method in the FileSource class?", "input": "OpenMC Python API FileSource.path() method signature", "output": "To call the path() method, use: @property def path(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the path() method in the FileSource class?", "input": "OpenMC Python API FileSource.path() method signature", "output": "To call the path() method, use: @path.setter def path(self: Any, p: PathLike). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method do in the FileSource class?", "input": "OpenMC Python API FileSource.populate_xml_element() method", "output": "The populate_xml_element() method add necessary file source information to an xml element. It's used for filesource operations." }, { "instruction": "How do you call the populate_xml_element() method in the FileSource class?", "input": "OpenMC Python API FileSource.populate_xml_element() method signature", "output": "To call the populate_xml_element() method, use: def populate_xml_element(self: Any, element: Any). It takes 2 parameters." }, { "instruction": "What does the populate_xml_element() method return in the FileSource class?", "input": "OpenMC Python API FileSource.populate_xml_element() return value", "output": "The populate_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the FileSource class?", "input": "OpenMC Python API FileSource.from_xml_element() method", "output": "The from_xml_element() method generate file source from an xml element. It's used for filesource operations." }, { "instruction": "How do you call the from_xml_element() method in the FileSource class?", "input": "OpenMC Python API FileSource.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API FileSource.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API FileSource.from_xml_element() parameter meshes", "output": "The meshes parameter dictionary with mesh ids as keys and openmc.meshbase instances as values. It should be a dict value." }, { "instruction": "What is the ParticleType class in OpenMC's Python API?", "input": "OpenMC Python API ParticleType class", "output": "The ParticleType class represents intenum class representing a particle type. type\n values mirror those found in the c++ class.. It provides 4 methods and 0 properties for working with particletype data in OpenMC." }, { "instruction": "What does the ParticleType class do in OpenMC's Python API?", "input": "OpenMC Python API ParticleType class description", "output": "The ParticleType class intenum class representing a particle type. type\n values mirror those found in the c++ class.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the from_string() method do in the ParticleType class?", "input": "OpenMC Python API ParticleType.from_string() method", "output": "The from_string() method constructs a particletype instance from a string. It's used for particletype operations." }, { "instruction": "How do you call the from_string() method in the ParticleType class?", "input": "OpenMC Python API ParticleType.from_string() method signature", "output": "To call the from_string() method, use: @classmethod def from_string(cls: Any, value: str). It takes 2 parameters." }, { "instruction": "What does the value parameter do in the from_string() method?", "input": "OpenMC Python API ParticleType.from_string() parameter value", "output": "The value parameter the string representation of the particle type.. It should be a str value." }, { "instruction": "What does the from_pdg_number() method do in the ParticleType class?", "input": "OpenMC Python API ParticleType.from_pdg_number() method", "output": "The from_pdg_number() method constructs a particletype instance from a pdg number. the particle data group at lbnl publishes a monte carlo particle numbering scheme as part of the `review of particle physics <10.1103/physrevd.110.030001>`_. this method maps pdg numbers to the corresponding :class:`particletype`. It's used for particletype operations." }, { "instruction": "How do you call the from_pdg_number() method in the ParticleType class?", "input": "OpenMC Python API ParticleType.from_pdg_number() method signature", "output": "To call the from_pdg_number() method, use: @classmethod def from_pdg_number(cls: Any, pdg_number: int). It takes 2 parameters." }, { "instruction": "What does the pdg_number parameter do in the from_pdg_number() method?", "input": "OpenMC Python API ParticleType.from_pdg_number() parameter pdg_number", "output": "The pdg_number parameter the pdg number of the particle type.. It should be a int value." }, { "instruction": "What does the __repr__() method do in the ParticleType class?", "input": "OpenMC Python API ParticleType.__repr__() method", "output": "The __repr__() method returns a string representation of the particletype instance.\n\n returns:\n str: the lowercase name of the particletype instance.. It's used for particletype operations." }, { "instruction": "How do you call the __repr__() method in the ParticleType class?", "input": "OpenMC Python API ParticleType.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __str__() method in the ParticleType class?", "input": "OpenMC Python API ParticleType.__str__() method signature", "output": "To call the __str__() method, use: def __str__(self: Any). It takes 1 parameters." }, { "instruction": "What is the SourceParticle class in OpenMC's Python API?", "input": "OpenMC Python API SourceParticle class", "output": "The SourceParticle class represents source particle this class can be used to create source particles that can be written to a file and used by openmc. It provides 3 methods and 0 properties for working with sourceparticle data in OpenMC." }, { "instruction": "What does the SourceParticle class do in OpenMC's Python API?", "input": "OpenMC Python API SourceParticle class description", "output": "The SourceParticle class source particle this class can be used to create source particles that can be written to a file and used by openmc. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the r parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter r", "output": "When creating a SourceParticle, the r parameter specifies position of particle in cartesian coordinates. It should be a iterable of float value." }, { "instruction": "What does the u parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter u", "output": "When creating a SourceParticle, the u parameter specifies directional cosines. It should be a iterable of float value." }, { "instruction": "What does the E parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter E", "output": "When creating a SourceParticle, the E parameter specifies energy of particle in [ev]. It should be a float value." }, { "instruction": "What does the time parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter time", "output": "When creating a SourceParticle, the time parameter specifies time of particle in [s]. It should be a float value." }, { "instruction": "What does the wgt parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter wgt", "output": "When creating a SourceParticle, the wgt parameter specifies weight of the particle. It should be a float value." }, { "instruction": "What does the delayed_group parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter delayed_group", "output": "When creating a SourceParticle, the delayed_group parameter specifies delayed group particle was created in (neutrons only). It should be a int value." }, { "instruction": "What does the surf_id parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter surf_id", "output": "When creating a SourceParticle, the surf_id parameter specifies surface id where particle is at, if any.. It should be a int value." }, { "instruction": "What does the particle parameter do when creating a SourceParticle?", "input": "OpenMC Python API SourceParticle constructor parameter particle", "output": "When creating a SourceParticle, the particle parameter specifies type of the particle. It should be a ParticleType value." }, { "instruction": "How do you call the __init__() method in the SourceParticle class?", "input": "OpenMC Python API SourceParticle.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, r: Any, u: Any, E: float, time: float, wgt: float, delayed_group: int, surf_id: int, particle: ParticleType). It takes 9 parameters." }, { "instruction": "How do you call the __repr__() method in the SourceParticle class?", "input": "OpenMC Python API SourceParticle.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_tuple() method do in the SourceParticle class?", "input": "OpenMC Python API SourceParticle.to_tuple() method", "output": "The to_tuple() method return source particle attributes as a tuple. It's used for sourceparticle operations." }, { "instruction": "How do you call the to_tuple() method in the SourceParticle class?", "input": "OpenMC Python API SourceParticle.to_tuple() method signature", "output": "To call the to_tuple() method, use: def to_tuple(self: Any). It takes 1 parameters." }, { "instruction": "What is the ParticleList class in OpenMC's Python API?", "input": "OpenMC Python API ParticleList class", "output": "The ParticleList class represents a collection of sourceparticle objects. It provides 5 methods and 0 properties for working with particlelist data in OpenMC." }, { "instruction": "What does the ParticleList class do in OpenMC's Python API?", "input": "OpenMC Python API ParticleList class description", "output": "The ParticleList class a collection of sourceparticle objects. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the particles parameter do when creating a ParticleList?", "input": "OpenMC Python API ParticleList constructor parameter particles", "output": "When creating a ParticleList, the particles parameter specifies particles to collect into the list. It should be a list of SourceParticle value." }, { "instruction": "What does the from_hdf5() method do in the ParticleList class?", "input": "OpenMC Python API ParticleList.from_hdf5() method", "output": "The from_hdf5() method create particle list from an hdf5 file. It's used for particlelist operations." }, { "instruction": "How do you call the from_hdf5() method in the ParticleList class?", "input": "OpenMC Python API ParticleList.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, filename: PathLike). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the from_hdf5() method?", "input": "OpenMC Python API ParticleList.from_hdf5() parameter filename", "output": "The filename parameter path to source file to read.. It should be a path-like value." }, { "instruction": "What does the from_mcpl() method do in the ParticleList class?", "input": "OpenMC Python API ParticleList.from_mcpl() method", "output": "The from_mcpl() method create particle list from an mcpl file. It's used for particlelist operations." }, { "instruction": "How do you call the from_mcpl() method in the ParticleList class?", "input": "OpenMC Python API ParticleList.from_mcpl() method signature", "output": "To call the from_mcpl() method, use: @classmethod def from_mcpl(cls: Any, filename: PathLike). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the from_mcpl() method?", "input": "OpenMC Python API ParticleList.from_mcpl() parameter filename", "output": "The filename parameter path to mcpl file to read.. It should be a path-like value." }, { "instruction": "What does the __getitem__() method do in the ParticleList class?", "input": "OpenMC Python API ParticleList.__getitem__() method", "output": "The __getitem__() method return a new particlelist object containing the particle(s) at the specified index or slice. It's used for particlelist operations." }, { "instruction": "How do you call the __getitem__() method in the ParticleList class?", "input": "OpenMC Python API ParticleList.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, index: Any). It takes 2 parameters." }, { "instruction": "What does the index parameter do in the __getitem__() method?", "input": "OpenMC Python API ParticleList.__getitem__() parameter index", "output": "The index parameter the index, slice or list to select from the list of particles. It should be a int, slice or list value." }, { "instruction": "What does the to_dataframe() method do in the ParticleList class?", "input": "OpenMC Python API ParticleList.to_dataframe() method", "output": "The to_dataframe() method a dataframe representing the source particles. It's used for particlelist operations." }, { "instruction": "How do you call the to_dataframe() method in the ParticleList class?", "input": "OpenMC Python API ParticleList.to_dataframe() method signature", "output": "To call the to_dataframe() method, use: def to_dataframe(self: Any). It takes 1 parameters." }, { "instruction": "What does the export_to_hdf5() method do in the ParticleList class?", "input": "OpenMC Python API ParticleList.export_to_hdf5() method", "output": "The export_to_hdf5() method export particle list to an hdf5 file. this method write out an .h5 file that can be used as a source file in conjunction with the :class:`openmc.filesource` class. It's used for particlelist operations." }, { "instruction": "How do you call the export_to_hdf5() method in the ParticleList class?", "input": "OpenMC Python API ParticleList.export_to_hdf5() method signature", "output": "To call the export_to_hdf5() method, use: def export_to_hdf5(self: Any, filename: PathLike). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the export_to_hdf5() method?", "input": "OpenMC Python API ParticleList.export_to_hdf5() parameter filename", "output": "The filename parameter path to source file to write **kwargs keyword arguments to pass to :class:`h5py.file` see also -------- openmc.filesource. It should be a path-like value." }, { "instruction": "What does the Source() function do in OpenMC's Python API?", "input": "OpenMC Python API Source() function", "output": "The Source() function a function for backward compatibility of sources. will be removed in the\n future. please update to independentsource.. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the Source() function in OpenMC's Python API?", "input": "OpenMC Python API Source() function purpose", "output": "The Source() function a function for backward compatibility of sources. will be removed in the\n future. please update to independentsource.. It's part of OpenMC's Python API." }, { "instruction": "How do you call the Source() function in OpenMC's Python API?", "input": "OpenMC Python API Source() function signature", "output": "To call the Source() function, use: def Source(). It takes 0 parameters." }, { "instruction": "What does the write_source_file() function do in OpenMC's Python API?", "input": "OpenMC Python API write_source_file() function", "output": "The write_source_file() function write a source file using a collection of source particles. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the write_source_file() function in OpenMC's Python API?", "input": "OpenMC Python API write_source_file() function purpose", "output": "The write_source_file() function write a source file using a collection of source particles. It's part of OpenMC's Python API." }, { "instruction": "How do you call the write_source_file() function in OpenMC's Python API?", "input": "OpenMC Python API write_source_file() function signature", "output": "To call the write_source_file() function, use: def write_source_file(source_particles: Any, filename: PathLike). It takes 2 parameters." }, { "instruction": "What does the source_particles parameter do in the write_source_file() function?", "input": "OpenMC Python API write_source_file() parameter source_particles", "output": "The source_particles parameter source particles to write to file. It should be a iterable of SourceParticle value." }, { "instruction": "What does the filename parameter do in the write_source_file() function?", "input": "OpenMC Python API write_source_file() parameter filename", "output": "The filename parameter path to source file to write **kwargs keyword arguments to pass to :class:`h5py.file` see also -------- openmc.sourceparticle. It should be a str or path-like value." }, { "instruction": "What does the read_source_file() function do in OpenMC's Python API?", "input": "OpenMC Python API read_source_file() function", "output": "The read_source_file() function read a source file and return a list of source particles. .. versionadded:: 0.15.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the read_source_file() function in OpenMC's Python API?", "input": "OpenMC Python API read_source_file() function purpose", "output": "The read_source_file() function read a source file and return a list of source particles. .. versionadded:: 0.15.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the read_source_file() function in OpenMC's Python API?", "input": "OpenMC Python API read_source_file() function signature", "output": "To call the read_source_file() function, use: def read_source_file(filename: PathLike). It takes 1 parameters." }, { "instruction": "What does the filename parameter do in the read_source_file() function?", "input": "OpenMC Python API read_source_file() parameter filename", "output": "The filename parameter path to source file to read. It should be a str or path-like value." }, { "instruction": "What is the StatePoint class in OpenMC's Python API?", "input": "OpenMC Python API StatePoint class", "output": "The StatePoint class represents state information on a simulation at a certain point in time (at the end of a given batch). statepoints can be used to analyze tally results as well as restart a simulation. It provides 47 methods and 0 properties for working with statepoint data in OpenMC." }, { "instruction": "What does the StatePoint class do in OpenMC's Python API?", "input": "OpenMC Python API StatePoint class description", "output": "The StatePoint class state information on a simulation at a certain point in time (at the end of a given batch). statepoints can be used to analyze tally results as well as restart a simulation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filepath parameter do when creating a StatePoint?", "input": "OpenMC Python API StatePoint constructor parameter filepath", "output": "When creating a StatePoint, the filepath parameter specifies path to file to load. It should be a str or Path value." }, { "instruction": "What does the autolink parameter do when creating a StatePoint?", "input": "OpenMC Python API StatePoint constructor parameter autolink", "output": "When creating a StatePoint, the autolink parameter specifies whether to automatically link in metadata from a summary.h5 file and stochastic volume calculation results from volume_*.h5 files. defaults to true.. It should be a bool, optional value." }, { "instruction": "What is the cmfd_on attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute cmfd_on", "output": "The cmfd_on attribute of a StatePoint contains indicate whether cmfd is active. It's a bool value that you can access after creating a StatePoint instance." }, { "instruction": "What is the cmfd_balance attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute cmfd_balance", "output": "The cmfd_balance attribute of a StatePoint contains residual neutron balance for each batch cmfd_dominance dominance ratio for each batch. It's a numpy.ndarray value that you can access after creating a StatePoint instance." }, { "instruction": "What is the cmfd_entropy attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute cmfd_entropy", "output": "The cmfd_entropy attribute of a StatePoint contains shannon entropy of cmfd fission source for each batch. It's a numpy.ndarray value that you can access after creating a StatePoint instance." }, { "instruction": "What is the cmfd_indices attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute cmfd_indices", "output": "The cmfd_indices attribute of a StatePoint contains number of cmfd mesh cells and energy groups. the first three indices correspond to the x-, y-, and z- spatial directions and the fourth index is the number of energy groups.. It's a numpy.ndarray value that you can access after creating a StatePoint instance." }, { "instruction": "What is the cmfd_srccmp attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute cmfd_srccmp", "output": "The cmfd_srccmp attribute of a StatePoint contains root-mean-square difference between openmc and cmfd fission source for each batch. It's a numpy.ndarray value that you can access after creating a StatePoint instance." }, { "instruction": "What is the cmfd_src attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute cmfd_src", "output": "The cmfd_src attribute of a StatePoint contains cmfd fission source distribution over all mesh cells and energy groups.. It's a numpy.ndarray value that you can access after creating a StatePoint instance." }, { "instruction": "What is the current_batch attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute current_batch", "output": "The current_batch attribute of a StatePoint contains number of batches simulated. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the date_and_time attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute date_and_time", "output": "The date_and_time attribute of a StatePoint contains date and time at which statepoint was written. It's a datetime.datetime value that you can access after creating a StatePoint instance." }, { "instruction": "What is the entropy attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute entropy", "output": "The entropy attribute of a StatePoint contains shannon entropy of fission source at each batch. It's a numpy.ndarray value that you can access after creating a StatePoint instance." }, { "instruction": "What is the filters attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute filters", "output": "The filters attribute of a StatePoint contains dictionary whose keys are filter ids and whose values are filter objects. It's a dict value that you can access after creating a StatePoint instance." }, { "instruction": "What is the generations_per_batch attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute generations_per_batch", "output": "The generations_per_batch attribute of a StatePoint contains number of fission generations per batch. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the global_tallies attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute global_tallies", "output": "The global_tallies attribute of a StatePoint contains global tallies for k-effective estimates and leakage. the compound datatype has fields 'name', 'sum', 'sum_sq', 'mean', and 'std_dev'.. It's a numpy.ndarray of compound datatype value that you can access after creating a StatePoint instance." }, { "instruction": "What is the k_combined attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute k_combined", "output": "The k_combined attribute of a StatePoint contains combined estimator for k-effective .. deprecated:: 0.13.1. It's a uncertainties.UFloat value that you can access after creating a StatePoint instance." }, { "instruction": "What is the k_col_abs attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute k_col_abs", "output": "The k_col_abs attribute of a StatePoint contains cross-product of collision and absorption estimates of k-effective. It's a float value that you can access after creating a StatePoint instance." }, { "instruction": "What is the k_col_tra attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute k_col_tra", "output": "The k_col_tra attribute of a StatePoint contains cross-product of collision and tracklength estimates of k-effective. It's a float value that you can access after creating a StatePoint instance." }, { "instruction": "What is the k_abs_tra attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute k_abs_tra", "output": "The k_abs_tra attribute of a StatePoint contains cross-product of absorption and tracklength estimates of k-effective. It's a float value that you can access after creating a StatePoint instance." }, { "instruction": "What is the k_generation attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute k_generation", "output": "The k_generation attribute of a StatePoint contains estimate of k-effective for each batch/generation. It's a numpy.ndarray value that you can access after creating a StatePoint instance." }, { "instruction": "What is the keff attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute keff", "output": "The keff attribute of a StatePoint contains combined estimator for k-effective .. versionadded:: 0.13.1. It's a uncertainties.UFloat value that you can access after creating a StatePoint instance." }, { "instruction": "What is the meshes attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute meshes", "output": "The meshes attribute of a StatePoint contains dictionary whose keys are mesh ids and whose values are meshbase objects. It's a dict value that you can access after creating a StatePoint instance." }, { "instruction": "What is the n_batches attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute n_batches", "output": "The n_batches attribute of a StatePoint contains number of batches. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the n_inactive attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute n_inactive", "output": "The n_inactive attribute of a StatePoint contains number of inactive batches. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the n_particles attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute n_particles", "output": "The n_particles attribute of a StatePoint contains number of particles per generation. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the n_realizations attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute n_realizations", "output": "The n_realizations attribute of a StatePoint contains number of tally realizations. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the path attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute path", "output": "The path attribute of a StatePoint contains working directory for simulation. It's a str value that you can access after creating a StatePoint instance." }, { "instruction": "What is the photon_transport attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute photon_transport", "output": "The photon_transport attribute of a StatePoint contains indicate whether photon transport is active. It's a bool value that you can access after creating a StatePoint instance." }, { "instruction": "What is the run_mode attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute run_mode", "output": "The run_mode attribute of a StatePoint contains simulation run mode, e.g. 'eigenvalue'. It's a str value that you can access after creating a StatePoint instance." }, { "instruction": "What is the runtime attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute runtime", "output": "The runtime attribute of a StatePoint contains dictionary whose keys are strings describing various runtime metrics and whose values are time values in seconds.. It's a dict value that you can access after creating a StatePoint instance." }, { "instruction": "What is the seed attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute seed", "output": "The seed attribute of a StatePoint contains pseudorandom number generator seed. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the stride attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute stride", "output": "The stride attribute of a StatePoint contains number of random numbers allocated for each particle history. It's a int value that you can access after creating a StatePoint instance." }, { "instruction": "What is the source attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute source", "output": "The source attribute of a StatePoint contains array of source sites. the compound datatype has fields 'r', 'u', 'e', 'wgt', 'delayed_group', 'surf_id', and 'particle', corresponding to the position, direction, energy, weight, delayed group, surface id and particle type of the source site, respectively.. It's a numpy.ndarray of compound datatype value that you can access after creating a StatePoint instance." }, { "instruction": "What is the source_present attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute source_present", "output": "The source_present attribute of a StatePoint contains indicate whether source sites are present. It's a bool value that you can access after creating a StatePoint instance." }, { "instruction": "What is the sparse attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute sparse", "output": "The sparse attribute of a StatePoint contains whether or not the tallies uses scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a StatePoint instance." }, { "instruction": "What is the tallies attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute tallies", "output": "The tallies attribute of a StatePoint contains dictionary whose keys are tally ids and whose values are tally objects. It's a dict value that you can access after creating a StatePoint instance." }, { "instruction": "What is the tallies_present attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute tallies_present", "output": "The tallies_present attribute of a StatePoint contains indicate whether user-defined tallies are present. It's a bool value that you can access after creating a StatePoint instance." }, { "instruction": "What is the tally_derivatives attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute tally_derivatives", "output": "The tally_derivatives attribute of a StatePoint contains dictionary whose keys are tally derivative ids and whose values are tallyderivative objects. It's a dict value that you can access after creating a StatePoint instance." }, { "instruction": "What is the version attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute version", "output": "The version attribute of a StatePoint contains version of openmc. It's a tuple of Integral value that you can access after creating a StatePoint instance." }, { "instruction": "What is the summary attribute of a StatePoint?", "input": "OpenMC Python API StatePoint attribute summary", "output": "The summary attribute of a StatePoint contains a summary object if the statepoint has been linked with a summary file. It's a None or openmc.Summary value that you can access after creating a StatePoint instance." }, { "instruction": "How do you call the __init__() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filepath: Any, autolink: Any). It takes 3 parameters." }, { "instruction": "How do you call the __enter__() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.__enter__() method signature", "output": "To call the __enter__() method, use: def __enter__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __exit__() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.__exit__() method signature", "output": "To call the __exit__() method, use: def __exit__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_on() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.cmfd_on() method signature", "output": "To call the cmfd_on() method, use: @property def cmfd_on(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_balance() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.cmfd_balance() method signature", "output": "To call the cmfd_balance() method, use: @property def cmfd_balance(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_dominance() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.cmfd_dominance() method signature", "output": "To call the cmfd_dominance() method, use: @property def cmfd_dominance(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_entropy() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.cmfd_entropy() method signature", "output": "To call the cmfd_entropy() method, use: @property def cmfd_entropy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_indices() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.cmfd_indices() method signature", "output": "To call the cmfd_indices() method, use: @property def cmfd_indices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_src() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.cmfd_src() method signature", "output": "To call the cmfd_src() method, use: @property def cmfd_src(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cmfd_srccmp() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.cmfd_srccmp() method signature", "output": "To call the cmfd_srccmp() method, use: @property def cmfd_srccmp(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the current_batch() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.current_batch() method signature", "output": "To call the current_batch() method, use: @property def current_batch(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the date_and_time() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.date_and_time() method signature", "output": "To call the date_and_time() method, use: @property def date_and_time(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the entropy() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.entropy() method signature", "output": "To call the entropy() method, use: @property def entropy(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the generations_per_batch() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.generations_per_batch() method signature", "output": "To call the generations_per_batch() method, use: @property def generations_per_batch(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the global_tallies() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.global_tallies() method signature", "output": "To call the global_tallies() method, use: @property def global_tallies(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the k_cmfd() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.k_cmfd() method signature", "output": "To call the k_cmfd() method, use: @property def k_cmfd(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the k_generation() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.k_generation() method signature", "output": "To call the k_generation() method, use: @property def k_generation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the keff() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.keff() method signature", "output": "To call the keff() method, use: @property def keff(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the k_combined() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.k_combined() method signature", "output": "To call the k_combined() method, use: @property def k_combined(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the k_col_abs() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.k_col_abs() method signature", "output": "To call the k_col_abs() method, use: @property def k_col_abs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the k_col_tra() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.k_col_tra() method signature", "output": "To call the k_col_tra() method, use: @property def k_col_tra(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the k_abs_tra() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.k_abs_tra() method signature", "output": "To call the k_abs_tra() method, use: @property def k_abs_tra(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the meshes() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.meshes() method signature", "output": "To call the meshes() method, use: @property def meshes(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_batches() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.n_batches() method signature", "output": "To call the n_batches() method, use: @property def n_batches(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_inactive() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.n_inactive() method signature", "output": "To call the n_inactive() method, use: @property def n_inactive(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_particles() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.n_particles() method signature", "output": "To call the n_particles() method, use: @property def n_particles(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n_realizations() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.n_realizations() method signature", "output": "To call the n_realizations() method, use: @property def n_realizations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the path() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.path() method signature", "output": "To call the path() method, use: @property def path(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the photon_transport() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.photon_transport() method signature", "output": "To call the photon_transport() method, use: @property def photon_transport(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the run_mode() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.run_mode() method signature", "output": "To call the run_mode() method, use: @property def run_mode(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the runtime() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.runtime() method signature", "output": "To call the runtime() method, use: @property def runtime(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the seed() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.seed() method signature", "output": "To call the seed() method, use: @property def seed(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the stride() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.stride() method signature", "output": "To call the stride() method, use: @property def stride(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the source() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.source() method signature", "output": "To call the source() method, use: @property def source(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the source_present() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.source_present() method signature", "output": "To call the source_present() method, use: @property def source_present(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sparse() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.sparse() method signature", "output": "To call the sparse() method, use: @property def sparse(self: Any). It takes 1 parameters." }, { "instruction": "What does the sparse() method do in the StatePoint class?", "input": "OpenMC Python API StatePoint.sparse() method", "output": "The sparse() method convert tally data from numpy arrays to scipy list of lists (lil)\n sparse matrices, and vice versa.\n\n this property may be used to reduce the amount of data in memory during\n tally data processing. the tally data will be stored as scipy lil\n matrices internally within each tally object. all tally data access\n properties and methods will return data as a dense numpy array.. It's used for statepoint operations." }, { "instruction": "How do you call the sparse() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.sparse() method signature", "output": "To call the sparse() method, use: @sparse.setter def sparse(self: Any, sparse: Any). It takes 2 parameters." }, { "instruction": "How do you call the tallies() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.tallies() method signature", "output": "To call the tallies() method, use: @property def tallies(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tallies_present() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.tallies_present() method signature", "output": "To call the tallies_present() method, use: @property def tallies_present(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the tally_derivatives() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.tally_derivatives() method signature", "output": "To call the tally_derivatives() method, use: @property def tally_derivatives(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the version() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.version() method signature", "output": "To call the version() method, use: @property def version(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the summary() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.summary() method signature", "output": "To call the summary() method, use: @property def summary(self: Any). It takes 1 parameters." }, { "instruction": "What does the close() method do in the StatePoint class?", "input": "OpenMC Python API StatePoint.close() method", "output": "The close() method close the statepoint hdf5 file and the corresponding\n summary hdf5 file if present.. It's used for statepoint operations." }, { "instruction": "How do you call the close() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.close() method signature", "output": "To call the close() method, use: def close(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_volume_information() method do in the StatePoint class?", "input": "OpenMC Python API StatePoint.add_volume_information() method", "output": "The add_volume_information() method add volume information to the geometry within the file. It's used for statepoint operations." }, { "instruction": "How do you call the add_volume_information() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.add_volume_information() method signature", "output": "To call the add_volume_information() method, use: def add_volume_information(self: Any, volume_calc: Any). It takes 2 parameters." }, { "instruction": "What does the volume_calc parameter do in the add_volume_information() method?", "input": "OpenMC Python API StatePoint.add_volume_information() parameter volume_calc", "output": "The volume_calc parameter results from a stochastic volume calculation. It should be a openmc.VolumeCalculation value." }, { "instruction": "What does the get_tally() method do in the StatePoint class?", "input": "OpenMC Python API StatePoint.get_tally() method", "output": "The get_tally() method finds and returns a tally object with certain properties. this routine searches the list of tallies and returns the first tally found which satisfies all of the input parameters. note: if any of the \"exact\" parameters are false (default), the input parameters do not need to match the complete tally specification and may only represent a subset of the tally's properties. if an \"exact\" parameter is true then number of scores, filters, or nuclides in the parameters must precisely match those of any matching tally. It's used for statepoint operations." }, { "instruction": "How do you call the get_tally() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.get_tally() method signature", "output": "To call the get_tally() method, use: def get_tally(self: Any, scores: Any, filters: Any, nuclides: Any, name: Any, id: Any, estimator: Any, exact_filters: Any, exact_nuclides: Any, exact_scores: Any, multiply_density: Any, derivative: Any). It takes 12 parameters." }, { "instruction": "What does the scores parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter scores", "output": "The scores parameter a list of one or more score strings (default is []).. It should be a list, optional value." }, { "instruction": "What does the filters parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter filters", "output": "The filters parameter a list of filter objects (default is []).. It should be a list, optional value." }, { "instruction": "What does the nuclides parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter nuclides", "output": "The nuclides parameter a list of nuclide objects (default is []).. It should be a list, optional value." }, { "instruction": "What does the name parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter name", "output": "The name parameter the name specified for the tally (default is none).. It should be a str, optional value." }, { "instruction": "What does the id parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter id", "output": "The id parameter the id specified for the tally (default is none).. It should be a Integral, optional value." }, { "instruction": "What does the estimator parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter estimator", "output": "The estimator parameter the type of estimator ('tracklength', 'analog'; default is none).. It should be a str, optional value." }, { "instruction": "What does the exact_filters parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter exact_filters", "output": "The exact_filters parameter if true, the number of filters in the parameters must be identical to those in the matching tally. if false (default), the filters in the parameters may be a subset of those in the matching tally.. It should be a bool value." }, { "instruction": "What does the exact_nuclides parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter exact_nuclides", "output": "The exact_nuclides parameter if true, the number of nuclides in the parameters must be identical to those in the matching tally. if false (default), the nuclides in the parameters may be a subset of those in the matching tally.. It should be a bool value." }, { "instruction": "What does the exact_scores parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter exact_scores", "output": "The exact_scores parameter if true, the number of scores in the parameters must be identical to those in the matching tally. if false (default), the scores in the parameters may be a subset of those in the matching tally. default is none (no check).. It should be a bool value." }, { "instruction": "What does the multiply_density parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter multiply_density", "output": "The multiply_density parameter if not none, the tally must have the multiply_density attribute set to the same value as this parameter.. It should be a bool, optional value." }, { "instruction": "What does the derivative parameter do in the get_tally() method?", "input": "OpenMC Python API StatePoint.get_tally() parameter derivative", "output": "The derivative parameter tallyderivative object to match.. It should be a openmc.TallyDerivative, optional value." }, { "instruction": "What does the get_tally() method return in the StatePoint class?", "input": "OpenMC Python API StatePoint.get_tally() return value", "output": "The get_tally() method returns a tally matching the specified criteria. The return type is openmc.Tally." }, { "instruction": "What does the link_with_summary() method do in the StatePoint class?", "input": "OpenMC Python API StatePoint.link_with_summary() method", "output": "The link_with_summary() method links tallies and filters with summary model information. this routine retrieves model information (materials, geometry) from a summary object populated with an hdf5 'summary.h5' file and inserts it into the tally objects. this can be helpful when viewing and manipulating large scale tally data. note that it is necessary to link against a summary to populate the tallies with any user-specified \"name\" xml tags. It's used for statepoint operations." }, { "instruction": "How do you call the link_with_summary() method in the StatePoint class?", "input": "OpenMC Python API StatePoint.link_with_summary() method signature", "output": "To call the link_with_summary() method, use: def link_with_summary(self: Any, summary: Any). It takes 2 parameters." }, { "instruction": "What does the summary parameter do in the link_with_summary() method?", "input": "OpenMC Python API StatePoint.link_with_summary() parameter summary", "output": "The summary parameter a summary object.. It should be a openmc.Summary value." }, { "instruction": "What is the UnitSphere class in OpenMC's Python API?", "input": "OpenMC Python API UnitSphere class", "output": "The UnitSphere class represents distribution of points on the unit sphere. this abstract class is used for angular distributions, since a direction is represented as a unit vector (i.e., vector on the unit sphere). It provides 5 methods and 0 properties for working with unitsphere data in OpenMC." }, { "instruction": "What does the UnitSphere class do in OpenMC's Python API?", "input": "OpenMC Python API UnitSphere class description", "output": "The UnitSphere class distribution of points on the unit sphere. this abstract class is used for angular distributions, since a direction is represented as a unit vector (i.e., vector on the unit sphere). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the reference_uvw parameter do when creating a UnitSphere?", "input": "OpenMC Python API UnitSphere constructor parameter reference_uvw", "output": "When creating a UnitSphere, the reference_uvw parameter specifies direction from which polar angle is measured. It should be a Iterable of float value." }, { "instruction": "What is the reference_uvw attribute of a UnitSphere?", "input": "OpenMC Python API UnitSphere attribute reference_uvw", "output": "The reference_uvw attribute of a UnitSphere contains direction from which polar angle is measured. It's a Iterable of float value that you can access after creating a UnitSphere instance." }, { "instruction": "How do you call the __init__() method in the UnitSphere class?", "input": "OpenMC Python API UnitSphere.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, reference_uvw: Any). It takes 2 parameters." }, { "instruction": "How do you call the reference_uvw() method in the UnitSphere class?", "input": "OpenMC Python API UnitSphere.reference_uvw() method signature", "output": "To call the reference_uvw() method, use: @property def reference_uvw(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the reference_uvw() method in the UnitSphere class?", "input": "OpenMC Python API UnitSphere.reference_uvw() method signature", "output": "To call the reference_uvw() method, use: @reference_uvw.setter def reference_uvw(self: Any, uvw: Any). It takes 2 parameters." }, { "instruction": "How do you call the to_xml_element() method in the UnitSphere class?", "input": "OpenMC Python API UnitSphere.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: @abstractmethod def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_xml_element() method in the UnitSphere class?", "input": "OpenMC Python API UnitSphere.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod, @abstractmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the PolarAzimuthal class in OpenMC's Python API?", "input": "OpenMC Python API PolarAzimuthal class", "output": "The PolarAzimuthal class represents angular distribution represented by polar and azimuthal angles this distribution allows one to specify the distribution of the cosine of the polar angle and the azimuthal angle independently of one another. the polar angle is measured relative to the reference angle. It provides 7 methods and 0 properties for working with polarazimuthal data in OpenMC." }, { "instruction": "What does the PolarAzimuthal class do in OpenMC's Python API?", "input": "OpenMC Python API PolarAzimuthal class description", "output": "The PolarAzimuthal class angular distribution represented by polar and azimuthal angles this distribution allows one to specify the distribution of the cosine of the polar angle and the azimuthal angle independently of one another. the polar angle is measured relative to the reference angle. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mu parameter do when creating a PolarAzimuthal?", "input": "OpenMC Python API PolarAzimuthal constructor parameter mu", "output": "When creating a PolarAzimuthal, the mu parameter specifies distribution of the cosine of the polar angle. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the phi parameter do when creating a PolarAzimuthal?", "input": "OpenMC Python API PolarAzimuthal constructor parameter phi", "output": "When creating a PolarAzimuthal, the phi parameter specifies distribution of the azimuthal angle in radians. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the reference_uvw parameter do when creating a PolarAzimuthal?", "input": "OpenMC Python API PolarAzimuthal constructor parameter reference_uvw", "output": "When creating a PolarAzimuthal, the reference_uvw parameter specifies direction from which polar angle is measured. defaults to the positive z-direction.. It should be a Iterable of float value." }, { "instruction": "What is the mu attribute of a PolarAzimuthal?", "input": "OpenMC Python API PolarAzimuthal attribute mu", "output": "The mu attribute of a PolarAzimuthal contains distribution of the cosine of the polar angle. It's a openmc.stats.Univariate value that you can access after creating a PolarAzimuthal instance." }, { "instruction": "What is the phi attribute of a PolarAzimuthal?", "input": "OpenMC Python API PolarAzimuthal attribute phi", "output": "The phi attribute of a PolarAzimuthal contains distribution of the azimuthal angle in radians. It's a openmc.stats.Univariate value that you can access after creating a PolarAzimuthal instance." }, { "instruction": "How do you call the __init__() method in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mu: Any, phi: Any, reference_uvw: Any). It takes 4 parameters." }, { "instruction": "How do you call the mu() method in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.mu() method signature", "output": "To call the mu() method, use: @property def mu(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mu() method in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.mu() method signature", "output": "To call the mu() method, use: @mu.setter def mu(self: Any, mu: Any). It takes 2 parameters." }, { "instruction": "How do you call the phi() method in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.phi() method signature", "output": "To call the phi() method, use: @property def phi(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the phi() method in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.phi() method signature", "output": "To call the phi() method, use: @phi.setter def phi(self: Any, phi: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the angular distribution. It's used for polarazimuthal operations." }, { "instruction": "How do you call the to_xml_element() method in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing angular distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.from_xml_element() method", "output": "The from_xml_element() method generate angular distribution from an xml element. It's used for polarazimuthal operations." }, { "instruction": "How do you call the from_xml_element() method in the PolarAzimuthal class?", "input": "OpenMC Python API PolarAzimuthal.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API PolarAzimuthal.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Isotropic class in OpenMC's Python API?", "input": "OpenMC Python API Isotropic class", "output": "The Isotropic class represents isotropic angular distribution.. It provides 3 methods and 0 properties for working with isotropic data in OpenMC." }, { "instruction": "What does the Isotropic class do in OpenMC's Python API?", "input": "OpenMC Python API Isotropic class description", "output": "The Isotropic class isotropic angular distribution.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the Isotropic class?", "input": "OpenMC Python API Isotropic.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the Isotropic class?", "input": "OpenMC Python API Isotropic.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the isotropic distribution. It's used for isotropic operations." }, { "instruction": "How do you call the to_xml_element() method in the Isotropic class?", "input": "OpenMC Python API Isotropic.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Isotropic class?", "input": "OpenMC Python API Isotropic.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing isotropic distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Isotropic class?", "input": "OpenMC Python API Isotropic.from_xml_element() method", "output": "The from_xml_element() method generate isotropic distribution from an xml element. It's used for isotropic operations." }, { "instruction": "How do you call the from_xml_element() method in the Isotropic class?", "input": "OpenMC Python API Isotropic.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Isotropic.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Monodirectional class in OpenMC's Python API?", "input": "OpenMC Python API Monodirectional class", "output": "The Monodirectional class represents monodirectional angular distribution. a monodirectional angular distribution is one for which the polar and azimuthal angles are always the same. it is completely specified by the reference direction vector. It provides 3 methods and 0 properties for working with monodirectional data in OpenMC." }, { "instruction": "What does the Monodirectional class do in OpenMC's Python API?", "input": "OpenMC Python API Monodirectional class description", "output": "The Monodirectional class monodirectional angular distribution. a monodirectional angular distribution is one for which the polar and azimuthal angles are always the same. it is completely specified by the reference direction vector. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the reference_uvw parameter do when creating a Monodirectional?", "input": "OpenMC Python API Monodirectional constructor parameter reference_uvw", "output": "When creating a Monodirectional, the reference_uvw parameter specifies direction from which polar angle is measured. defaults to the positive x-direction.. It should be a Iterable of float value." }, { "instruction": "How do you call the __init__() method in the Monodirectional class?", "input": "OpenMC Python API Monodirectional.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, reference_uvw: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the Monodirectional class?", "input": "OpenMC Python API Monodirectional.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the monodirectional distribution. It's used for monodirectional operations." }, { "instruction": "How do you call the to_xml_element() method in the Monodirectional class?", "input": "OpenMC Python API Monodirectional.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Monodirectional class?", "input": "OpenMC Python API Monodirectional.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing monodirectional distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Monodirectional class?", "input": "OpenMC Python API Monodirectional.from_xml_element() method", "output": "The from_xml_element() method generate monodirectional distribution from an xml element. It's used for monodirectional operations." }, { "instruction": "How do you call the from_xml_element() method in the Monodirectional class?", "input": "OpenMC Python API Monodirectional.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Monodirectional.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Spatial class in OpenMC's Python API?", "input": "OpenMC Python API Spatial class", "output": "The Spatial class represents distribution of locations in three-dimensional euclidean space.\n\n classes derived from this abstract class can be used for spatial\n distributions of source sites.. It provides 2 methods and 0 properties for working with spatial data in OpenMC." }, { "instruction": "What does the Spatial class do in OpenMC's Python API?", "input": "OpenMC Python API Spatial class description", "output": "The Spatial class distribution of locations in three-dimensional euclidean space.\n\n classes derived from this abstract class can be used for spatial\n distributions of source sites.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the to_xml_element() method in the Spatial class?", "input": "OpenMC Python API Spatial.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: @abstractmethod def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_xml_element() method in the Spatial class?", "input": "OpenMC Python API Spatial.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod, @abstractmethod def from_xml_element(cls: Any, elem: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "What is the CartesianIndependent class in OpenMC's Python API?", "input": "OpenMC Python API CartesianIndependent class", "output": "The CartesianIndependent class represents spatial distribution with independent x, y, and z distributions. this distribution allows one to specify coordinates whose x-, y-, and z- components are sampled independently from one another. It provides 9 methods and 0 properties for working with cartesianindependent data in OpenMC." }, { "instruction": "What does the CartesianIndependent class do in OpenMC's Python API?", "input": "OpenMC Python API CartesianIndependent class description", "output": "The CartesianIndependent class spatial distribution with independent x, y, and z distributions. this distribution allows one to specify coordinates whose x-, y-, and z- components are sampled independently from one another. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x parameter do when creating a CartesianIndependent?", "input": "OpenMC Python API CartesianIndependent constructor parameter x", "output": "When creating a CartesianIndependent, the x parameter specifies distribution of x-coordinates. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the y parameter do when creating a CartesianIndependent?", "input": "OpenMC Python API CartesianIndependent constructor parameter y", "output": "When creating a CartesianIndependent, the y parameter specifies distribution of y-coordinates. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the z parameter do when creating a CartesianIndependent?", "input": "OpenMC Python API CartesianIndependent constructor parameter z", "output": "When creating a CartesianIndependent, the z parameter specifies distribution of z-coordinates. It should be a openmc.stats.Univariate value." }, { "instruction": "What is the x attribute of a CartesianIndependent?", "input": "OpenMC Python API CartesianIndependent attribute x", "output": "The x attribute of a CartesianIndependent contains distribution of x-coordinates. It's a openmc.stats.Univariate value that you can access after creating a CartesianIndependent instance." }, { "instruction": "What is the y attribute of a CartesianIndependent?", "input": "OpenMC Python API CartesianIndependent attribute y", "output": "The y attribute of a CartesianIndependent contains distribution of y-coordinates. It's a openmc.stats.Univariate value that you can access after creating a CartesianIndependent instance." }, { "instruction": "What is the z attribute of a CartesianIndependent?", "input": "OpenMC Python API CartesianIndependent attribute z", "output": "The z attribute of a CartesianIndependent contains distribution of z-coordinates. It's a openmc.stats.Univariate value that you can access after creating a CartesianIndependent instance." }, { "instruction": "How do you call the __init__() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x: .Univariate, y: .Univariate, z: .Univariate). It takes 4 parameters." }, { "instruction": "How do you call the x() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.x() method signature", "output": "To call the x() method, use: @property def x(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.x() method signature", "output": "To call the x() method, use: @x.setter def x(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the y() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.y() method signature", "output": "To call the y() method, use: @property def y(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the y() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.y() method signature", "output": "To call the y() method, use: @y.setter def y(self: Any, y: Any). It takes 2 parameters." }, { "instruction": "How do you call the z() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.z() method signature", "output": "To call the z() method, use: @property def z(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the z() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.z() method signature", "output": "To call the z() method, use: @z.setter def z(self: Any, z: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the spatial distribution. It's used for cartesianindependent operations." }, { "instruction": "How do you call the to_xml_element() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing spatial distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.from_xml_element() method", "output": "The from_xml_element() method generate spatial distribution from an xml element. It's used for cartesianindependent operations." }, { "instruction": "How do you call the from_xml_element() method in the CartesianIndependent class?", "input": "OpenMC Python API CartesianIndependent.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API CartesianIndependent.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the SphericalIndependent class in OpenMC's Python API?", "input": "OpenMC Python API SphericalIndependent class", "output": "The SphericalIndependent class represents spatial distribution represented in spherical coordinates. this distribution allows one to specify coordinates whose :math:`r`, :math:`\\theta`, and :math:`\\phi` components are sampled independently from one another and centered on the coordinates (x0, y0, z0). .. versionadded:: 0.12 .. versionchanged:: 0.13.1 accepts ``cos_theta`` instead of ``theta``. It provides 11 methods and 0 properties for working with sphericalindependent data in OpenMC." }, { "instruction": "What does the SphericalIndependent class do in OpenMC's Python API?", "input": "OpenMC Python API SphericalIndependent class description", "output": "The SphericalIndependent class spatial distribution represented in spherical coordinates. this distribution allows one to specify coordinates whose :math:`r`, :math:`\\theta`, and :math:`\\phi` components are sampled independently from one another and centered on the coordinates (x0, y0, z0). .. versionadded:: 0.12 .. versionchanged:: 0.13.1 accepts ``cos_theta`` instead of ``theta``. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the r parameter do when creating a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent constructor parameter r", "output": "When creating a SphericalIndependent, the r parameter specifies distribution of r-coordinates in a reference frame specified by the origin parameter. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the cos_theta parameter do when creating a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent constructor parameter cos_theta", "output": "When creating a SphericalIndependent, the cos_theta parameter specifies distribution of the cosine of the theta-coordinates (angle relative to the z-axis) in a reference frame specified by the origin parameter. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the phi parameter do when creating a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent constructor parameter phi", "output": "When creating a SphericalIndependent, the phi parameter specifies distribution of phi-coordinates (azimuthal angle) in a reference frame specified by the origin parameter. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the origin parameter do when creating a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent constructor parameter origin", "output": "When creating a SphericalIndependent, the origin parameter specifies coordinates (x0, y0, z0) of the center of the spherical reference frame for the source. defaults to (0.0, 0.0, 0.0). It should be a Iterable of float, optional value." }, { "instruction": "What is the r attribute of a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent attribute r", "output": "The r attribute of a SphericalIndependent contains distribution of r-coordinates in the local reference frame. It's a openmc.stats.Univariate value that you can access after creating a SphericalIndependent instance." }, { "instruction": "What is the cos_theta attribute of a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent attribute cos_theta", "output": "The cos_theta attribute of a SphericalIndependent contains distribution of the cosine of the theta-coordinates (angle relative to the z-axis) in the local reference frame. It's a openmc.stats.Univariate value that you can access after creating a SphericalIndependent instance." }, { "instruction": "What is the phi attribute of a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent attribute phi", "output": "The phi attribute of a SphericalIndependent contains distribution of phi-coordinates (azimuthal angle) in the local reference frame. It's a openmc.stats.Univariate value that you can access after creating a SphericalIndependent instance." }, { "instruction": "What is the origin attribute of a SphericalIndependent?", "input": "OpenMC Python API SphericalIndependent attribute origin", "output": "The origin attribute of a SphericalIndependent contains coordinates (x0, y0, z0) of the center of the spherical reference frame. defaults to (0.0, 0.0, 0.0). It's a Iterable of float, optional value that you can access after creating a SphericalIndependent instance." }, { "instruction": "How do you call the __init__() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, r: Any, cos_theta: Any, phi: Any, origin: Any). It takes 5 parameters." }, { "instruction": "How do you call the r() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.r() method signature", "output": "To call the r() method, use: @property def r(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the r() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.r() method signature", "output": "To call the r() method, use: @r.setter def r(self: Any, r: Any). It takes 2 parameters." }, { "instruction": "How do you call the cos_theta() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.cos_theta() method signature", "output": "To call the cos_theta() method, use: @property def cos_theta(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cos_theta() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.cos_theta() method signature", "output": "To call the cos_theta() method, use: @cos_theta.setter def cos_theta(self: Any, cos_theta: Any). It takes 2 parameters." }, { "instruction": "How do you call the phi() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.phi() method signature", "output": "To call the phi() method, use: @property def phi(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the phi() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.phi() method signature", "output": "To call the phi() method, use: @phi.setter def phi(self: Any, phi: Any). It takes 2 parameters." }, { "instruction": "How do you call the origin() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.origin() method signature", "output": "To call the origin() method, use: @property def origin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.origin() method signature", "output": "To call the origin() method, use: @origin.setter def origin(self: Any, origin: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the spatial distribution. It's used for sphericalindependent operations." }, { "instruction": "How do you call the to_xml_element() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing spatial distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.from_xml_element() method", "output": "The from_xml_element() method generate spatial distribution from an xml element. It's used for sphericalindependent operations." }, { "instruction": "How do you call the from_xml_element() method in the SphericalIndependent class?", "input": "OpenMC Python API SphericalIndependent.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API SphericalIndependent.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the CylindricalIndependent class in OpenMC's Python API?", "input": "OpenMC Python API CylindricalIndependent class", "output": "The CylindricalIndependent class represents spatial distribution represented in cylindrical coordinates. this distribution allows one to specify coordinates whose :math:`r`, :math:`\\phi`, and :math:`z` components are sampled independently from one another and in a reference frame whose origin is specified by the coordinates (x0, y0, z0). .. versionadded:: 0.12. It provides 11 methods and 0 properties for working with cylindricalindependent data in OpenMC." }, { "instruction": "What does the CylindricalIndependent class do in OpenMC's Python API?", "input": "OpenMC Python API CylindricalIndependent class description", "output": "The CylindricalIndependent class spatial distribution represented in cylindrical coordinates. this distribution allows one to specify coordinates whose :math:`r`, :math:`\\phi`, and :math:`z` components are sampled independently from one another and in a reference frame whose origin is specified by the coordinates (x0, y0, z0). .. versionadded:: 0.12. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the r parameter do when creating a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent constructor parameter r", "output": "When creating a CylindricalIndependent, the r parameter specifies distribution of r-coordinates in a reference frame specified by the origin parameter. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the phi parameter do when creating a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent constructor parameter phi", "output": "When creating a CylindricalIndependent, the phi parameter specifies distribution of phi-coordinates (azimuthal angle) in a reference frame specified by the origin parameter. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the z parameter do when creating a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent constructor parameter z", "output": "When creating a CylindricalIndependent, the z parameter specifies distribution of z-coordinates in a reference frame specified by the origin parameter. It should be a openmc.stats.Univariate value." }, { "instruction": "What does the origin parameter do when creating a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent constructor parameter origin", "output": "When creating a CylindricalIndependent, the origin parameter specifies coordinates (x0, y0, z0) of the center of the cylindrical reference frame. defaults to (0.0, 0.0, 0.0). It should be a Iterable of float, optional value." }, { "instruction": "What is the r attribute of a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent attribute r", "output": "The r attribute of a CylindricalIndependent contains distribution of r-coordinates in the local reference frame. It's a openmc.stats.Univariate value that you can access after creating a CylindricalIndependent instance." }, { "instruction": "What is the phi attribute of a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent attribute phi", "output": "The phi attribute of a CylindricalIndependent contains distribution of phi-coordinates (azimuthal angle) in the local reference frame. It's a openmc.stats.Univariate value that you can access after creating a CylindricalIndependent instance." }, { "instruction": "What is the z attribute of a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent attribute z", "output": "The z attribute of a CylindricalIndependent contains distribution of z-coordinates in the local reference frame. It's a openmc.stats.Univariate value that you can access after creating a CylindricalIndependent instance." }, { "instruction": "What is the origin attribute of a CylindricalIndependent?", "input": "OpenMC Python API CylindricalIndependent attribute origin", "output": "The origin attribute of a CylindricalIndependent contains coordinates (x0, y0, z0) of the center of the cylindrical reference frame. defaults to (0.0, 0.0, 0.0). It's a Iterable of float, optional value that you can access after creating a CylindricalIndependent instance." }, { "instruction": "How do you call the __init__() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, r: Any, phi: Any, z: Any, origin: Any). It takes 5 parameters." }, { "instruction": "How do you call the r() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.r() method signature", "output": "To call the r() method, use: @property def r(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the r() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.r() method signature", "output": "To call the r() method, use: @r.setter def r(self: Any, r: Any). It takes 2 parameters." }, { "instruction": "How do you call the phi() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.phi() method signature", "output": "To call the phi() method, use: @property def phi(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the phi() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.phi() method signature", "output": "To call the phi() method, use: @phi.setter def phi(self: Any, phi: Any). It takes 2 parameters." }, { "instruction": "How do you call the z() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.z() method signature", "output": "To call the z() method, use: @property def z(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the z() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.z() method signature", "output": "To call the z() method, use: @z.setter def z(self: Any, z: Any). It takes 2 parameters." }, { "instruction": "How do you call the origin() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.origin() method signature", "output": "To call the origin() method, use: @property def origin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the origin() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.origin() method signature", "output": "To call the origin() method, use: @origin.setter def origin(self: Any, origin: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the spatial distribution. It's used for cylindricalindependent operations." }, { "instruction": "How do you call the to_xml_element() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing spatial distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.from_xml_element() method", "output": "The from_xml_element() method generate spatial distribution from an xml element. It's used for cylindricalindependent operations." }, { "instruction": "How do you call the from_xml_element() method in the CylindricalIndependent class?", "input": "OpenMC Python API CylindricalIndependent.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API CylindricalIndependent.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the MeshSpatial class in OpenMC's Python API?", "input": "OpenMC Python API MeshSpatial class", "output": "The MeshSpatial class represents spatial distribution for a mesh. this distribution specifies a mesh to sample over with source strengths specified for each mesh element. .. versionadded:: 0.13.3. It provides 10 methods and 0 properties for working with meshspatial data in OpenMC." }, { "instruction": "What does the MeshSpatial class do in OpenMC's Python API?", "input": "OpenMC Python API MeshSpatial class description", "output": "The MeshSpatial class spatial distribution for a mesh. this distribution specifies a mesh to sample over with source strengths specified for each mesh element. .. versionadded:: 0.13.3. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a MeshSpatial?", "input": "OpenMC Python API MeshSpatial constructor parameter mesh", "output": "When creating a MeshSpatial, the mesh parameter specifies the mesh instance used for sampling. It should be a openmc.MeshBase value." }, { "instruction": "What does the strengths parameter do when creating a MeshSpatial?", "input": "OpenMC Python API MeshSpatial constructor parameter strengths", "output": "When creating a MeshSpatial, the strengths parameter specifies an iterable of values that represents the weights of each element. if no source strengths are specified, they will be equal for all mesh elements.. It should be a iterable of float, optional value." }, { "instruction": "What does the volume_normalized parameter do when creating a MeshSpatial?", "input": "OpenMC Python API MeshSpatial constructor parameter volume_normalized", "output": "When creating a MeshSpatial, the volume_normalized parameter specifies whether or not the strengths will be multiplied by element volumes at runtime. default is true.. It should be a bool, optional value." }, { "instruction": "What is the mesh attribute of a MeshSpatial?", "input": "OpenMC Python API MeshSpatial attribute mesh", "output": "The mesh attribute of a MeshSpatial contains the mesh instance used for sampling. It's a openmc.MeshBase value that you can access after creating a MeshSpatial instance." }, { "instruction": "What is the strengths attribute of a MeshSpatial?", "input": "OpenMC Python API MeshSpatial attribute strengths", "output": "The strengths attribute of a MeshSpatial contains an array of source strengths for each mesh element. It's a numpy.ndarray or None value that you can access after creating a MeshSpatial instance." }, { "instruction": "What is the volume_normalized attribute of a MeshSpatial?", "input": "OpenMC Python API MeshSpatial attribute volume_normalized", "output": "The volume_normalized attribute of a MeshSpatial contains whether or not the strengths will be multiplied by element volumes at runtime.. It's a bool value that you can access after creating a MeshSpatial instance." }, { "instruction": "How do you call the __init__() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: Any, strengths: Any, volume_normalized: Any). It takes 4 parameters." }, { "instruction": "How do you call the mesh() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, mesh: Any). It takes 2 parameters." }, { "instruction": "How do you call the volume_normalized() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.volume_normalized() method signature", "output": "To call the volume_normalized() method, use: @property def volume_normalized(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume_normalized() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.volume_normalized() method signature", "output": "To call the volume_normalized() method, use: @volume_normalized.setter def volume_normalized(self: Any, volume_normalized: Any). It takes 2 parameters." }, { "instruction": "How do you call the strengths() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.strengths() method signature", "output": "To call the strengths() method, use: @property def strengths(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the strengths() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.strengths() method signature", "output": "To call the strengths() method, use: @strengths.setter def strengths(self: Any, given_strengths: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_strength_bins() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.num_strength_bins() method signature", "output": "To call the num_strength_bins() method, use: @property def num_strength_bins(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the spatial distribution. It's used for meshspatial operations." }, { "instruction": "How do you call the to_xml_element() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing spatial distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.from_xml_element() method", "output": "The from_xml_element() method generate spatial distribution from an xml element. It's used for meshspatial operations." }, { "instruction": "How do you call the from_xml_element() method in the MeshSpatial class?", "input": "OpenMC Python API MeshSpatial.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API MeshSpatial.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API MeshSpatial.from_xml_element() parameter meshes", "output": "The meshes parameter a dictionary with mesh ids as keys and openmc.meshbase instances as values. It should be a dict value." }, { "instruction": "What is the PointCloud class in OpenMC's Python API?", "input": "OpenMC Python API PointCloud class", "output": "The PointCloud class represents spatial distribution from a point cloud. this distribution specifies a discrete list of points, with corresponding relative probabilities. .. versionadded:: 0.15.1. It provides 8 methods and 0 properties for working with pointcloud data in OpenMC." }, { "instruction": "What does the PointCloud class do in OpenMC's Python API?", "input": "OpenMC Python API PointCloud class description", "output": "The PointCloud class spatial distribution from a point cloud. this distribution specifies a discrete list of points, with corresponding relative probabilities. .. versionadded:: 0.15.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the positions parameter do when creating a PointCloud?", "input": "OpenMC Python API PointCloud constructor parameter positions", "output": "When creating a PointCloud, the positions parameter specifies the points in space to be sampled. It should be a iterable of 3-tuples value." }, { "instruction": "What does the strengths parameter do when creating a PointCloud?", "input": "OpenMC Python API PointCloud constructor parameter strengths", "output": "When creating a PointCloud, the strengths parameter specifies an iterable of values that represents the relative probabilty of each point.. It should be a iterable of float, optional value." }, { "instruction": "What is the positions attribute of a PointCloud?", "input": "OpenMC Python API PointCloud attribute positions", "output": "The positions attribute of a PointCloud contains the points in space to be sampled with shape (n, 3). It's a numpy.ndarray value that you can access after creating a PointCloud instance." }, { "instruction": "What is the strengths attribute of a PointCloud?", "input": "OpenMC Python API PointCloud attribute strengths", "output": "The strengths attribute of a PointCloud contains an array of relative probabilities for each mesh point. It's a numpy.ndarray or None value that you can access after creating a PointCloud instance." }, { "instruction": "How do you call the __init__() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, positions: Any, strengths: Any). It takes 3 parameters." }, { "instruction": "How do you call the positions() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.positions() method signature", "output": "To call the positions() method, use: @property def positions(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the positions() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.positions() method signature", "output": "To call the positions() method, use: @positions.setter def positions(self: Any, positions: Any). It takes 2 parameters." }, { "instruction": "How do you call the strengths() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.strengths() method signature", "output": "To call the strengths() method, use: @property def strengths(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the strengths() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.strengths() method signature", "output": "To call the strengths() method, use: @strengths.setter def strengths(self: Any, strengths: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_strength_bins() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.num_strength_bins() method signature", "output": "To call the num_strength_bins() method, use: @property def num_strength_bins(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the PointCloud class?", "input": "OpenMC Python API PointCloud.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the spatial distribution. It's used for pointcloud operations." }, { "instruction": "How do you call the to_xml_element() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the PointCloud class?", "input": "OpenMC Python API PointCloud.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing spatial distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the PointCloud class?", "input": "OpenMC Python API PointCloud.from_xml_element() method", "output": "The from_xml_element() method generate spatial distribution from an xml element. It's used for pointcloud operations." }, { "instruction": "How do you call the from_xml_element() method in the PointCloud class?", "input": "OpenMC Python API PointCloud.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API PointCloud.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Box class in OpenMC's Python API?", "input": "OpenMC Python API Box class", "output": "The Box class represents uniform distribution of coordinates in a rectangular cuboid. It provides 9 methods and 0 properties for working with box data in OpenMC." }, { "instruction": "What does the Box class do in OpenMC's Python API?", "input": "OpenMC Python API Box class description", "output": "The Box class uniform distribution of coordinates in a rectangular cuboid. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the lower_left parameter do when creating a Box?", "input": "OpenMC Python API Box constructor parameter lower_left", "output": "When creating a Box, the lower_left parameter specifies lower-left coordinates of cuboid. It should be a Iterable of float value." }, { "instruction": "What does the upper_right parameter do when creating a Box?", "input": "OpenMC Python API Box constructor parameter upper_right", "output": "When creating a Box, the upper_right parameter specifies upper-right coordinates of cuboid. It should be a Iterable of float value." }, { "instruction": "What does the only_fissionable parameter do when creating a Box?", "input": "OpenMC Python API Box constructor parameter only_fissionable", "output": "When creating a Box, the only_fissionable parameter specifies whether spatial sites should only be accepted if they occur in fissionable materials .. deprecated:: 0.15.0 use the `constraints` argument when defining a source object instead.. It should be a bool, optional value." }, { "instruction": "What is the lower_left attribute of a Box?", "input": "OpenMC Python API Box attribute lower_left", "output": "The lower_left attribute of a Box contains lower-left coordinates of cuboid. It's a Iterable of float value that you can access after creating a Box instance." }, { "instruction": "What is the upper_right attribute of a Box?", "input": "OpenMC Python API Box attribute upper_right", "output": "The upper_right attribute of a Box contains upper-right coordinates of cuboid. It's a Iterable of float value that you can access after creating a Box instance." }, { "instruction": "What is the only_fissionable attribute of a Box?", "input": "OpenMC Python API Box attribute only_fissionable", "output": "The only_fissionable attribute of a Box contains whether spatial sites should only be accepted if they occur in fissionable materials .. deprecated:: 0.15.0 use the `constraints` argument when defining a source object instead.. It's a bool, optional value that you can access after creating a Box instance." }, { "instruction": "How do you call the __init__() method in the Box class?", "input": "OpenMC Python API Box.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, lower_left: Any, upper_right: Any, only_fissionable: bool). It takes 4 parameters." }, { "instruction": "How do you call the lower_left() method in the Box class?", "input": "OpenMC Python API Box.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the Box class?", "input": "OpenMC Python API Box.lower_left() method signature", "output": "To call the lower_left() method, use: @lower_left.setter def lower_left(self: Any, lower_left: Any). It takes 2 parameters." }, { "instruction": "How do you call the upper_right() method in the Box class?", "input": "OpenMC Python API Box.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the Box class?", "input": "OpenMC Python API Box.upper_right() method signature", "output": "To call the upper_right() method, use: @upper_right.setter def upper_right(self: Any, upper_right: Any). It takes 2 parameters." }, { "instruction": "How do you call the only_fissionable() method in the Box class?", "input": "OpenMC Python API Box.only_fissionable() method signature", "output": "To call the only_fissionable() method, use: @property def only_fissionable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the only_fissionable() method in the Box class?", "input": "OpenMC Python API Box.only_fissionable() method signature", "output": "To call the only_fissionable() method, use: @only_fissionable.setter def only_fissionable(self: Any, only_fissionable: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the Box class?", "input": "OpenMC Python API Box.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the box distribution. It's used for box operations." }, { "instruction": "How do you call the to_xml_element() method in the Box class?", "input": "OpenMC Python API Box.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Box class?", "input": "OpenMC Python API Box.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing box distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Box class?", "input": "OpenMC Python API Box.from_xml_element() method", "output": "The from_xml_element() method generate box distribution from an xml element. It's used for box operations." }, { "instruction": "How do you call the from_xml_element() method in the Box class?", "input": "OpenMC Python API Box.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Box.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Point class in OpenMC's Python API?", "input": "OpenMC Python API Point class", "output": "The Point class represents delta function in three dimensions. this spatial distribution can be used for a point source where sites are emitted at a specific location given by its cartesian coordinates. It provides 5 methods and 0 properties for working with point data in OpenMC." }, { "instruction": "What does the Point class do in OpenMC's Python API?", "input": "OpenMC Python API Point class description", "output": "The Point class delta function in three dimensions. this spatial distribution can be used for a point source where sites are emitted at a specific location given by its cartesian coordinates. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the xyz parameter do when creating a Point?", "input": "OpenMC Python API Point constructor parameter xyz", "output": "When creating a Point, the xyz parameter specifies cartesian coordinates of location. defaults to (0., 0., 0.).. It should be a Iterable of float, optional value." }, { "instruction": "What is the xyz attribute of a Point?", "input": "OpenMC Python API Point attribute xyz", "output": "The xyz attribute of a Point contains cartesian coordinates of location. It's a Iterable of float value that you can access after creating a Point instance." }, { "instruction": "How do you call the __init__() method in the Point class?", "input": "OpenMC Python API Point.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, xyz: Any). It takes 2 parameters." }, { "instruction": "How do you call the xyz() method in the Point class?", "input": "OpenMC Python API Point.xyz() method signature", "output": "To call the xyz() method, use: @property def xyz(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the xyz() method in the Point class?", "input": "OpenMC Python API Point.xyz() method signature", "output": "To call the xyz() method, use: @xyz.setter def xyz(self: Any, xyz: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the Point class?", "input": "OpenMC Python API Point.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the point distribution. It's used for point operations." }, { "instruction": "How do you call the to_xml_element() method in the Point class?", "input": "OpenMC Python API Point.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Point class?", "input": "OpenMC Python API Point.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing point distribution location. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Point class?", "input": "OpenMC Python API Point.from_xml_element() method", "output": "The from_xml_element() method generate point distribution from an xml element. It's used for point operations." }, { "instruction": "How do you call the from_xml_element() method in the Point class?", "input": "OpenMC Python API Point.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Point.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the spherical_uniform() function do in OpenMC's Python API?", "input": "OpenMC Python API spherical_uniform() function", "output": "The spherical_uniform() function return a uniform spatial distribution over a spherical shell. this function provides a uniform spatial distribution over a spherical shell between `r_inner` and `r_outer`. optionally, the range of angles can be restricted by the `thetas` and `phis` arguments. .. versionadded:: 0.13.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the spherical_uniform() function in OpenMC's Python API?", "input": "OpenMC Python API spherical_uniform() function purpose", "output": "The spherical_uniform() function return a uniform spatial distribution over a spherical shell. this function provides a uniform spatial distribution over a spherical shell between `r_inner` and `r_outer`. optionally, the range of angles can be restricted by the `thetas` and `phis` arguments. .. versionadded:: 0.13.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the spherical_uniform() function in OpenMC's Python API?", "input": "OpenMC Python API spherical_uniform() function signature", "output": "To call the spherical_uniform() function, use: def spherical_uniform(r_outer: float, r_inner: float, thetas: Any, phis: Any, origin: Any). It takes 5 parameters." }, { "instruction": "What does the r_outer parameter do in the spherical_uniform() function?", "input": "OpenMC Python API spherical_uniform() parameter r_outer", "output": "The r_outer parameter outer radius of the spherical shell in [cm]. It should be a float value." }, { "instruction": "What does the r_inner parameter do in the spherical_uniform() function?", "input": "OpenMC Python API spherical_uniform() parameter r_inner", "output": "The r_inner parameter inner radius of the spherical shell in [cm]. It should be a float value." }, { "instruction": "What does the thetas parameter do in the spherical_uniform() function?", "input": "OpenMC Python API spherical_uniform() parameter thetas", "output": "The thetas parameter starting and ending theta coordinates (angle relative to the z-axis) in radius in a reference frame centered at `origin`. It should be a iterable of float value." }, { "instruction": "What does the phis parameter do in the spherical_uniform() function?", "input": "OpenMC Python API spherical_uniform() parameter phis", "output": "The phis parameter starting and ending phi coordinates (azimuthal angle) in radians in a reference frame centered at `origin`. It should be a iterable of float value." }, { "instruction": "What does the origin parameter do in the spherical_uniform() function?", "input": "OpenMC Python API spherical_uniform() parameter origin", "output": "The origin parameter coordinates (x0, y0, z0) of the center of the spherical reference frame for the distribution.. It should be a iterable of float value." }, { "instruction": "What is the Univariate class in OpenMC's Python API?", "input": "OpenMC Python API Univariate class", "output": "The Univariate class represents probability distribution of a single random variable.\n\n the univariate class is an abstract class that can be derived to implement a\n specific probability distribution.. It provides 5 methods and 0 properties for working with univariate data in OpenMC." }, { "instruction": "What does the Univariate class do in OpenMC's Python API?", "input": "OpenMC Python API Univariate class description", "output": "The Univariate class probability distribution of a single random variable.\n\n the univariate class is an abstract class that can be derived to implement a\n specific probability distribution.. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the to_xml_element() method in the Univariate class?", "input": "OpenMC Python API Univariate.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: @abstractmethod def to_xml_element(self: Any, element_name: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the Univariate class?", "input": "OpenMC Python API Univariate.__len__() method signature", "output": "To call the __len__() method, use: @abstractmethod def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the from_xml_element() method in the Univariate class?", "input": "OpenMC Python API Univariate.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod, @abstractmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the sample() method do in the Univariate class?", "input": "OpenMC Python API Univariate.sample() method", "output": "The sample() method sample the univariate distribution. It's used for univariate operations." }, { "instruction": "How do you call the sample() method in the Univariate class?", "input": "OpenMC Python API Univariate.sample() method signature", "output": "To call the sample() method, use: @abstractmethod def sample(n_samples: int, seed: Any). It takes 2 parameters." }, { "instruction": "What does the n_samples parameter do in the sample() method?", "input": "OpenMC Python API Univariate.sample() parameter n_samples", "output": "The n_samples parameter number of sampled values to generate. It should be a int value." }, { "instruction": "What does the seed parameter do in the sample() method?", "input": "OpenMC Python API Univariate.sample() parameter seed", "output": "The seed parameter initial random number seed.. It should be a int or None value." }, { "instruction": "What does the integral() method do in the Univariate class?", "input": "OpenMC Python API Univariate.integral() method", "output": "The integral() method return integral of distribution .. versionadded:: 0.13.1. It's used for univariate operations." }, { "instruction": "How do you call the integral() method in the Univariate class?", "input": "OpenMC Python API Univariate.integral() method signature", "output": "To call the integral() method, use: def integral(self: Any). It takes 1 parameters." }, { "instruction": "What is the Discrete class in OpenMC's Python API?", "input": "OpenMC Python API Discrete class", "output": "The Discrete class represents distribution characterized by a probability mass function. the discrete distribution assigns probability values to discrete values of a random variable, rather than expressing the distribution as a continuous random variable. It provides 14 methods and 0 properties for working with discrete data in OpenMC." }, { "instruction": "What does the Discrete class do in OpenMC's Python API?", "input": "OpenMC Python API Discrete class description", "output": "The Discrete class distribution characterized by a probability mass function. the discrete distribution assigns probability values to discrete values of a random variable, rather than expressing the distribution as a continuous random variable. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x parameter do when creating a Discrete?", "input": "OpenMC Python API Discrete constructor parameter x", "output": "When creating a Discrete, the x parameter specifies values of the random variable. It should be a Iterable of float value." }, { "instruction": "What does the p parameter do when creating a Discrete?", "input": "OpenMC Python API Discrete constructor parameter p", "output": "When creating a Discrete, the p parameter specifies discrete probability for each value. It should be a Iterable of float value." }, { "instruction": "What is the x attribute of a Discrete?", "input": "OpenMC Python API Discrete attribute x", "output": "The x attribute of a Discrete contains values of the random variable. It's a numpy.ndarray value that you can access after creating a Discrete instance." }, { "instruction": "What is the p attribute of a Discrete?", "input": "OpenMC Python API Discrete attribute p", "output": "The p attribute of a Discrete contains discrete probability for each value. It's a numpy.ndarray value that you can access after creating a Discrete instance." }, { "instruction": "How do you call the __init__() method in the Discrete class?", "input": "OpenMC Python API Discrete.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x: Any, p: Any). It takes 3 parameters." }, { "instruction": "How do you call the __len__() method in the Discrete class?", "input": "OpenMC Python API Discrete.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x() method in the Discrete class?", "input": "OpenMC Python API Discrete.x() method signature", "output": "To call the x() method, use: @property def x(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x() method in the Discrete class?", "input": "OpenMC Python API Discrete.x() method signature", "output": "To call the x() method, use: @x.setter def x(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the p() method in the Discrete class?", "input": "OpenMC Python API Discrete.p() method signature", "output": "To call the p() method, use: @property def p(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the p() method in the Discrete class?", "input": "OpenMC Python API Discrete.p() method signature", "output": "To call the p() method, use: @p.setter def p(self: Any, p: Any). It takes 2 parameters." }, { "instruction": "How do you call the cdf() method in the Discrete class?", "input": "OpenMC Python API Discrete.cdf() method signature", "output": "To call the cdf() method, use: def cdf(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sample() method in the Discrete class?", "input": "OpenMC Python API Discrete.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the normalize() method do in the Discrete class?", "input": "OpenMC Python API Discrete.normalize() method", "output": "The normalize() method normalize the probabilities stored on the distribution. It's used for discrete operations." }, { "instruction": "How do you call the normalize() method in the Discrete class?", "input": "OpenMC Python API Discrete.normalize() method signature", "output": "To call the normalize() method, use: def normalize(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the Discrete class?", "input": "OpenMC Python API Discrete.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the discrete distribution. It's used for discrete operations." }, { "instruction": "How do you call the to_xml_element() method in the Discrete class?", "input": "OpenMC Python API Discrete.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: Any). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API Discrete.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the Discrete class?", "input": "OpenMC Python API Discrete.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing discrete distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Discrete class?", "input": "OpenMC Python API Discrete.from_xml_element() method", "output": "The from_xml_element() method generate discrete distribution from an xml element. It's used for discrete operations." }, { "instruction": "How do you call the from_xml_element() method in the Discrete class?", "input": "OpenMC Python API Discrete.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Discrete.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the merge() method do in the Discrete class?", "input": "OpenMC Python API Discrete.merge() method", "output": "The merge() method merge multiple discrete distributions into a single distribution .. versionadded:: 0.13.1. It's used for discrete operations." }, { "instruction": "How do you call the merge() method in the Discrete class?", "input": "OpenMC Python API Discrete.merge() method signature", "output": "To call the merge() method, use: @classmethod def merge(cls: Any, dists: Any, probs: Any). It takes 3 parameters." }, { "instruction": "What does the dists parameter do in the merge() method?", "input": "OpenMC Python API Discrete.merge() parameter dists", "output": "The dists parameter discrete distributions to combine. It should be a iterable of openmc.stats.Discrete value." }, { "instruction": "What does the probs parameter do in the merge() method?", "input": "OpenMC Python API Discrete.merge() parameter probs", "output": "The probs parameter probability of each distribution. It should be a iterable of float value." }, { "instruction": "What does the integral() method do in the Discrete class?", "input": "OpenMC Python API Discrete.integral() method", "output": "The integral() method return integral of distribution .. versionadded:: 0.13.1. It's used for discrete operations." }, { "instruction": "How do you call the integral() method in the Discrete class?", "input": "OpenMC Python API Discrete.integral() method signature", "output": "To call the integral() method, use: def integral(self: Any). It takes 1 parameters." }, { "instruction": "What does the clip() method do in the Discrete class?", "input": "OpenMC Python API Discrete.clip() method", "output": "The clip() method remove low-importance points from discrete distribution. given a probability mass function :math:`p(x)` with :math:`\\{x_1, x_2, x_3, \\dots\\}` the possible values of the random variable with corresponding probabilities :math:`\\{p_1, p_2, p_3, \\dots\\}`, this function will remove any low-importance points such that :math:`\\sum_i x_i p_i` is preserved to within some threshold. .. versionadded:: 0.14.0. It's used for discrete operations." }, { "instruction": "How do you call the clip() method in the Discrete class?", "input": "OpenMC Python API Discrete.clip() method signature", "output": "To call the clip() method, use: def clip(self: Any, tolerance: float, inplace: bool). It takes 3 parameters." }, { "instruction": "What does the tolerance parameter do in the clip() method?", "input": "OpenMC Python API Discrete.clip() parameter tolerance", "output": "The tolerance parameter maximum fraction of :math:`\\sum_i x_i p_i` that will be discarded.. It should be a float value." }, { "instruction": "What does the inplace parameter do in the clip() method?", "input": "OpenMC Python API Discrete.clip() parameter inplace", "output": "The inplace parameter whether to modify the current object in-place or return a new one.. It should be a bool value." }, { "instruction": "What is the Uniform class in OpenMC's Python API?", "input": "OpenMC Python API Uniform class", "output": "The Uniform class represents distribution with constant probability over a finite interval [a,b]. It provides 10 methods and 0 properties for working with uniform data in OpenMC." }, { "instruction": "What does the Uniform class do in OpenMC's Python API?", "input": "OpenMC Python API Uniform class description", "output": "The Uniform class distribution with constant probability over a finite interval [a,b]. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the a parameter do when creating a Uniform?", "input": "OpenMC Python API Uniform constructor parameter a", "output": "When creating a Uniform, the a parameter specifies lower bound of the sampling interval. defaults to zero.. It should be a float, optional value." }, { "instruction": "What does the b parameter do when creating a Uniform?", "input": "OpenMC Python API Uniform constructor parameter b", "output": "When creating a Uniform, the b parameter specifies upper bound of the sampling interval. defaults to unity.. It should be a float, optional value." }, { "instruction": "What is the a attribute of a Uniform?", "input": "OpenMC Python API Uniform attribute a", "output": "The a attribute of a Uniform contains lower bound of the sampling interval. It's a float value that you can access after creating a Uniform instance." }, { "instruction": "What is the b attribute of a Uniform?", "input": "OpenMC Python API Uniform attribute b", "output": "The b attribute of a Uniform contains upper bound of the sampling interval. It's a float value that you can access after creating a Uniform instance." }, { "instruction": "How do you call the __init__() method in the Uniform class?", "input": "OpenMC Python API Uniform.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, a: float, b: float). It takes 3 parameters." }, { "instruction": "How do you call the __len__() method in the Uniform class?", "input": "OpenMC Python API Uniform.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the a() method in the Uniform class?", "input": "OpenMC Python API Uniform.a() method signature", "output": "To call the a() method, use: @property def a(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the a() method in the Uniform class?", "input": "OpenMC Python API Uniform.a() method signature", "output": "To call the a() method, use: @a.setter def a(self: Any, a: Any). It takes 2 parameters." }, { "instruction": "How do you call the b() method in the Uniform class?", "input": "OpenMC Python API Uniform.b() method signature", "output": "To call the b() method, use: @property def b(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the b() method in the Uniform class?", "input": "OpenMC Python API Uniform.b() method signature", "output": "To call the b() method, use: @b.setter def b(self: Any, b: Any). It takes 2 parameters." }, { "instruction": "How do you call the to_tabular() method in the Uniform class?", "input": "OpenMC Python API Uniform.to_tabular() method signature", "output": "To call the to_tabular() method, use: def to_tabular(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sample() method in the Uniform class?", "input": "OpenMC Python API Uniform.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the to_xml_element() method do in the Uniform class?", "input": "OpenMC Python API Uniform.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the uniform distribution. It's used for uniform operations." }, { "instruction": "How do you call the to_xml_element() method in the Uniform class?", "input": "OpenMC Python API Uniform.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: str). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API Uniform.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the Uniform class?", "input": "OpenMC Python API Uniform.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing uniform distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Uniform class?", "input": "OpenMC Python API Uniform.from_xml_element() method", "output": "The from_xml_element() method generate uniform distribution from an xml element. It's used for uniform operations." }, { "instruction": "How do you call the from_xml_element() method in the Uniform class?", "input": "OpenMC Python API Uniform.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Uniform.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the PowerLaw class in OpenMC's Python API?", "input": "OpenMC Python API PowerLaw class", "output": "The PowerLaw class represents distribution with power law probability over a finite interval [a,b] the power law distribution has density function :math:`p(x) dx = c x^n dx`. .. versionadded:: 0.13.0. It provides 11 methods and 0 properties for working with powerlaw data in OpenMC." }, { "instruction": "What does the PowerLaw class do in OpenMC's Python API?", "input": "OpenMC Python API PowerLaw class description", "output": "The PowerLaw class distribution with power law probability over a finite interval [a,b] the power law distribution has density function :math:`p(x) dx = c x^n dx`. .. versionadded:: 0.13.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the a parameter do when creating a PowerLaw?", "input": "OpenMC Python API PowerLaw constructor parameter a", "output": "When creating a PowerLaw, the a parameter specifies lower bound of the sampling interval. defaults to zero.. It should be a float, optional value." }, { "instruction": "What does the b parameter do when creating a PowerLaw?", "input": "OpenMC Python API PowerLaw constructor parameter b", "output": "When creating a PowerLaw, the b parameter specifies upper bound of the sampling interval. defaults to unity.. It should be a float, optional value." }, { "instruction": "What does the n parameter do when creating a PowerLaw?", "input": "OpenMC Python API PowerLaw constructor parameter n", "output": "When creating a PowerLaw, the n parameter specifies power law exponent. defaults to zero, which is equivalent to a uniform distribution.. It should be a float, optional value." }, { "instruction": "What is the a attribute of a PowerLaw?", "input": "OpenMC Python API PowerLaw attribute a", "output": "The a attribute of a PowerLaw contains lower bound of the sampling interval. It's a float value that you can access after creating a PowerLaw instance." }, { "instruction": "What is the b attribute of a PowerLaw?", "input": "OpenMC Python API PowerLaw attribute b", "output": "The b attribute of a PowerLaw contains upper bound of the sampling interval. It's a float value that you can access after creating a PowerLaw instance." }, { "instruction": "What is the n attribute of a PowerLaw?", "input": "OpenMC Python API PowerLaw attribute n", "output": "The n attribute of a PowerLaw contains power law exponent. It's a float value that you can access after creating a PowerLaw instance." }, { "instruction": "How do you call the __init__() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, a: float, b: float, n: float). It takes 4 parameters." }, { "instruction": "How do you call the __len__() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the a() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.a() method signature", "output": "To call the a() method, use: @property def a(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the a() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.a() method signature", "output": "To call the a() method, use: @a.setter def a(self: Any, a: Any). It takes 2 parameters." }, { "instruction": "How do you call the b() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.b() method signature", "output": "To call the b() method, use: @property def b(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the b() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.b() method signature", "output": "To call the b() method, use: @b.setter def b(self: Any, b: Any). It takes 2 parameters." }, { "instruction": "How do you call the n() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.n() method signature", "output": "To call the n() method, use: @property def n(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the n() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.n() method signature", "output": "To call the n() method, use: @n.setter def n(self: Any, n: Any). It takes 2 parameters." }, { "instruction": "How do you call the sample() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the to_xml_element() method do in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the power law distribution. It's used for powerlaw operations." }, { "instruction": "How do you call the to_xml_element() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: str). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API PowerLaw.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.from_xml_element() method", "output": "The from_xml_element() method generate power law distribution from an xml element. It's used for powerlaw operations." }, { "instruction": "How do you call the from_xml_element() method in the PowerLaw class?", "input": "OpenMC Python API PowerLaw.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API PowerLaw.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Maxwell class in OpenMC's Python API?", "input": "OpenMC Python API Maxwell class", "output": "The Maxwell class represents maxwellian distribution in energy. the maxwellian distribution in energy is characterized by a single parameter :math:`\\theta` and has a density function :math:`p(e) de = c \\sqrt{e} e^{-e/\\theta} de`. It provides 8 methods and 0 properties for working with maxwell data in OpenMC." }, { "instruction": "What does the Maxwell class do in OpenMC's Python API?", "input": "OpenMC Python API Maxwell class description", "output": "The Maxwell class maxwellian distribution in energy. the maxwellian distribution in energy is characterized by a single parameter :math:`\\theta` and has a density function :math:`p(e) de = c \\sqrt{e} e^{-e/\\theta} de`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the theta parameter do when creating a Maxwell?", "input": "OpenMC Python API Maxwell constructor parameter theta", "output": "When creating a Maxwell, the theta parameter specifies effective temperature for distribution in ev. It should be a float value." }, { "instruction": "What is the theta attribute of a Maxwell?", "input": "OpenMC Python API Maxwell attribute theta", "output": "The theta attribute of a Maxwell contains effective temperature for distribution in ev. It's a float value that you can access after creating a Maxwell instance." }, { "instruction": "How do you call the __init__() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, theta: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the theta() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.theta() method signature", "output": "To call the theta() method, use: @property def theta(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the theta() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.theta() method signature", "output": "To call the theta() method, use: @theta.setter def theta(self: Any, theta: Any). It takes 2 parameters." }, { "instruction": "How do you call the sample() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "How do you call the sample_maxwell() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.sample_maxwell() method signature", "output": "To call the sample_maxwell() method, use: @staticmethod def sample_maxwell(t: Any, n_samples: int, rng: Any). It takes 3 parameters." }, { "instruction": "What does the to_xml_element() method do in the Maxwell class?", "input": "OpenMC Python API Maxwell.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the maxwellian distribution. It's used for maxwell operations." }, { "instruction": "How do you call the to_xml_element() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: str). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API Maxwell.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the Maxwell class?", "input": "OpenMC Python API Maxwell.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing maxwellian distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Maxwell class?", "input": "OpenMC Python API Maxwell.from_xml_element() method", "output": "The from_xml_element() method generate maxwellian distribution from an xml element. It's used for maxwell operations." }, { "instruction": "How do you call the from_xml_element() method in the Maxwell class?", "input": "OpenMC Python API Maxwell.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Maxwell.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Watt class in OpenMC's Python API?", "input": "OpenMC Python API Watt class", "output": "The Watt class represents watt fission energy spectrum. the watt fission energy spectrum is characterized by two parameters :math:`a` and :math:`b` and has density function :math:`p(e) de = c e^{-e/a} \\sinh \\sqrt{b \\, e} de`. It provides 9 methods and 0 properties for working with watt data in OpenMC." }, { "instruction": "What does the Watt class do in OpenMC's Python API?", "input": "OpenMC Python API Watt class description", "output": "The Watt class watt fission energy spectrum. the watt fission energy spectrum is characterized by two parameters :math:`a` and :math:`b` and has density function :math:`p(e) de = c e^{-e/a} \\sinh \\sqrt{b \\, e} de`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the a parameter do when creating a Watt?", "input": "OpenMC Python API Watt constructor parameter a", "output": "When creating a Watt, the a parameter specifies first parameter of distribution in units of ev. It should be a float value." }, { "instruction": "What does the b parameter do when creating a Watt?", "input": "OpenMC Python API Watt constructor parameter b", "output": "When creating a Watt, the b parameter specifies second parameter of distribution in units of 1/ev. It should be a float value." }, { "instruction": "What is the a attribute of a Watt?", "input": "OpenMC Python API Watt attribute a", "output": "The a attribute of a Watt contains first parameter of distribution in units of ev. It's a float value that you can access after creating a Watt instance." }, { "instruction": "What is the b attribute of a Watt?", "input": "OpenMC Python API Watt attribute b", "output": "The b attribute of a Watt contains second parameter of distribution in units of 1/ev. It's a float value that you can access after creating a Watt instance." }, { "instruction": "How do you call the __init__() method in the Watt class?", "input": "OpenMC Python API Watt.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, a: Any, b: Any). It takes 3 parameters." }, { "instruction": "How do you call the __len__() method in the Watt class?", "input": "OpenMC Python API Watt.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the a() method in the Watt class?", "input": "OpenMC Python API Watt.a() method signature", "output": "To call the a() method, use: @property def a(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the a() method in the Watt class?", "input": "OpenMC Python API Watt.a() method signature", "output": "To call the a() method, use: @a.setter def a(self: Any, a: Any). It takes 2 parameters." }, { "instruction": "How do you call the b() method in the Watt class?", "input": "OpenMC Python API Watt.b() method signature", "output": "To call the b() method, use: @property def b(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the b() method in the Watt class?", "input": "OpenMC Python API Watt.b() method signature", "output": "To call the b() method, use: @b.setter def b(self: Any, b: Any). It takes 2 parameters." }, { "instruction": "How do you call the sample() method in the Watt class?", "input": "OpenMC Python API Watt.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the to_xml_element() method do in the Watt class?", "input": "OpenMC Python API Watt.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the watt distribution. It's used for watt operations." }, { "instruction": "How do you call the to_xml_element() method in the Watt class?", "input": "OpenMC Python API Watt.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: str). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API Watt.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the Watt class?", "input": "OpenMC Python API Watt.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing watt distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Watt class?", "input": "OpenMC Python API Watt.from_xml_element() method", "output": "The from_xml_element() method generate watt distribution from an xml element. It's used for watt operations." }, { "instruction": "How do you call the from_xml_element() method in the Watt class?", "input": "OpenMC Python API Watt.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Watt.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Normal class in OpenMC's Python API?", "input": "OpenMC Python API Normal class", "output": "The Normal class represents normally distributed sampling. the normal distribution is characterized by two parameters :math:`\\mu` and :math:`\\sigma` and has density function :math:`p(x) dx = 1/(\\sqrt{2\\pi}\\sigma) e^{-(x-\\mu)^2/(2\\sigma^2)}`. It provides 9 methods and 0 properties for working with normal data in OpenMC." }, { "instruction": "What does the Normal class do in OpenMC's Python API?", "input": "OpenMC Python API Normal class description", "output": "The Normal class normally distributed sampling. the normal distribution is characterized by two parameters :math:`\\mu` and :math:`\\sigma` and has density function :math:`p(x) dx = 1/(\\sqrt{2\\pi}\\sigma) e^{-(x-\\mu)^2/(2\\sigma^2)}`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mean_value parameter do when creating a Normal?", "input": "OpenMC Python API Normal constructor parameter mean_value", "output": "When creating a Normal, the mean_value parameter specifies mean value of the distribution. It should be a float value." }, { "instruction": "What does the std_dev parameter do when creating a Normal?", "input": "OpenMC Python API Normal constructor parameter std_dev", "output": "When creating a Normal, the std_dev parameter specifies standard deviation of the normal distribution. It should be a float value." }, { "instruction": "What is the mean_value attribute of a Normal?", "input": "OpenMC Python API Normal attribute mean_value", "output": "The mean_value attribute of a Normal contains mean of the normal distribution. It's a float value that you can access after creating a Normal instance." }, { "instruction": "What is the std_dev attribute of a Normal?", "input": "OpenMC Python API Normal attribute std_dev", "output": "The std_dev attribute of a Normal contains standard deviation of the normal distribution. It's a float value that you can access after creating a Normal instance." }, { "instruction": "How do you call the __init__() method in the Normal class?", "input": "OpenMC Python API Normal.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mean_value: Any, std_dev: Any). It takes 3 parameters." }, { "instruction": "How do you call the __len__() method in the Normal class?", "input": "OpenMC Python API Normal.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mean_value() method in the Normal class?", "input": "OpenMC Python API Normal.mean_value() method signature", "output": "To call the mean_value() method, use: @property def mean_value(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mean_value() method in the Normal class?", "input": "OpenMC Python API Normal.mean_value() method signature", "output": "To call the mean_value() method, use: @mean_value.setter def mean_value(self: Any, mean_value: Any). It takes 2 parameters." }, { "instruction": "How do you call the std_dev() method in the Normal class?", "input": "OpenMC Python API Normal.std_dev() method signature", "output": "To call the std_dev() method, use: @property def std_dev(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the std_dev() method in the Normal class?", "input": "OpenMC Python API Normal.std_dev() method signature", "output": "To call the std_dev() method, use: @std_dev.setter def std_dev(self: Any, std_dev: Any). It takes 2 parameters." }, { "instruction": "How do you call the sample() method in the Normal class?", "input": "OpenMC Python API Normal.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the to_xml_element() method do in the Normal class?", "input": "OpenMC Python API Normal.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the normal distribution. It's used for normal operations." }, { "instruction": "How do you call the to_xml_element() method in the Normal class?", "input": "OpenMC Python API Normal.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: str). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API Normal.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the Normal class?", "input": "OpenMC Python API Normal.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing watt distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Normal class?", "input": "OpenMC Python API Normal.from_xml_element() method", "output": "The from_xml_element() method generate normal distribution from an xml element. It's used for normal operations." }, { "instruction": "How do you call the from_xml_element() method in the Normal class?", "input": "OpenMC Python API Normal.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Normal.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Tabular class in OpenMC's Python API?", "input": "OpenMC Python API Tabular class", "output": "The Tabular class represents piecewise continuous probability distribution. this class is used to represent a probability distribution whose density function is tabulated at specific values with a specified interpolation scheme. It provides 13 methods and 0 properties for working with tabular data in OpenMC." }, { "instruction": "What does the Tabular class do in OpenMC's Python API?", "input": "OpenMC Python API Tabular class description", "output": "The Tabular class piecewise continuous probability distribution. this class is used to represent a probability distribution whose density function is tabulated at specific values with a specified interpolation scheme. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x parameter do when creating a Tabular?", "input": "OpenMC Python API Tabular constructor parameter x", "output": "When creating a Tabular, the x parameter specifies tabulated values of the random variable. It should be a Iterable of float value." }, { "instruction": "What does the p parameter do when creating a Tabular?", "input": "OpenMC Python API Tabular constructor parameter p", "output": "When creating a Tabular, the p parameter specifies tabulated probabilities. for histogram interpolation, if the length of `p` is the same as `x`, the last value is ignored. probabilities `p` are given per unit of `x`.. It should be a Iterable of float value." }, { "instruction": "What does the interpolation parameter do when creating a Tabular?", "input": "OpenMC Python API Tabular constructor parameter interpolation", "output": "When creating a Tabular, the interpolation parameter specifies indicates how the density function is interpolated between tabulated points. defaults to 'linear-linear'.. It should be a {'histogram', 'linear-linear', 'linear-log', 'log-linear', 'log-log'}, optional value." }, { "instruction": "What does the ignore_negative parameter do when creating a Tabular?", "input": "OpenMC Python API Tabular constructor parameter ignore_negative", "output": "When creating a Tabular, the ignore_negative parameter specifies ignore negative probabilities. It should be a bool value." }, { "instruction": "What is the x attribute of a Tabular?", "input": "OpenMC Python API Tabular attribute x", "output": "The x attribute of a Tabular contains tabulated values of the random variable. It's a numpy.ndarray value that you can access after creating a Tabular instance." }, { "instruction": "What is the p attribute of a Tabular?", "input": "OpenMC Python API Tabular attribute p", "output": "The p attribute of a Tabular contains tabulated probabilities. It's a numpy.ndarray value that you can access after creating a Tabular instance." }, { "instruction": "What is the interpolation attribute of a Tabular?", "input": "OpenMC Python API Tabular attribute interpolation", "output": "The interpolation attribute of a Tabular contains indicates how the density function is interpolated between tabulated points. defaults to 'linear-linear'.. It's a {'histogram', 'linear-linear', 'linear-log', 'log-linear', 'log-log'} value that you can access after creating a Tabular instance." }, { "instruction": "How do you call the __init__() method in the Tabular class?", "input": "OpenMC Python API Tabular.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x: Any, p: Any, interpolation: str, ignore_negative: bool). It takes 5 parameters." }, { "instruction": "How do you call the __len__() method in the Tabular class?", "input": "OpenMC Python API Tabular.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the x() method in the Tabular class?", "input": "OpenMC Python API Tabular.x() method signature", "output": "To call the x() method, use: @property def x(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the p() method in the Tabular class?", "input": "OpenMC Python API Tabular.p() method signature", "output": "To call the p() method, use: @property def p(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the Tabular class?", "input": "OpenMC Python API Tabular.interpolation() method signature", "output": "To call the interpolation() method, use: @property def interpolation(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the interpolation() method in the Tabular class?", "input": "OpenMC Python API Tabular.interpolation() method signature", "output": "To call the interpolation() method, use: @interpolation.setter def interpolation(self: Any, interpolation: Any). It takes 2 parameters." }, { "instruction": "How do you call the cdf() method in the Tabular class?", "input": "OpenMC Python API Tabular.cdf() method signature", "output": "To call the cdf() method, use: def cdf(self: Any). It takes 1 parameters." }, { "instruction": "What does the mean() method do in the Tabular class?", "input": "OpenMC Python API Tabular.mean() method", "output": "The mean() method compute the mean of the tabular distribution. It's used for tabular operations." }, { "instruction": "How do you call the mean() method in the Tabular class?", "input": "OpenMC Python API Tabular.mean() method signature", "output": "To call the mean() method, use: def mean(self: Any). It takes 1 parameters." }, { "instruction": "What does the normalize() method do in the Tabular class?", "input": "OpenMC Python API Tabular.normalize() method", "output": "The normalize() method normalize the probabilities stored on the distribution. It's used for tabular operations." }, { "instruction": "How do you call the normalize() method in the Tabular class?", "input": "OpenMC Python API Tabular.normalize() method signature", "output": "To call the normalize() method, use: def normalize(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sample() method in the Tabular class?", "input": "OpenMC Python API Tabular.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: int, seed: Any). It takes 3 parameters." }, { "instruction": "What does the to_xml_element() method do in the Tabular class?", "input": "OpenMC Python API Tabular.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the tabular distribution. It's used for tabular operations." }, { "instruction": "How do you call the to_xml_element() method in the Tabular class?", "input": "OpenMC Python API Tabular.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: str). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API Tabular.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the Tabular class?", "input": "OpenMC Python API Tabular.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing tabular distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Tabular class?", "input": "OpenMC Python API Tabular.from_xml_element() method", "output": "The from_xml_element() method generate tabular distribution from an xml element. It's used for tabular operations." }, { "instruction": "How do you call the from_xml_element() method in the Tabular class?", "input": "OpenMC Python API Tabular.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Tabular.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the integral() method do in the Tabular class?", "input": "OpenMC Python API Tabular.integral() method", "output": "The integral() method return integral of distribution .. versionadded:: 0.13.1. It's used for tabular operations." }, { "instruction": "How do you call the integral() method in the Tabular class?", "input": "OpenMC Python API Tabular.integral() method signature", "output": "To call the integral() method, use: def integral(self: Any). It takes 1 parameters." }, { "instruction": "What is the Legendre class in OpenMC's Python API?", "input": "OpenMC Python API Legendre class", "output": "The Legendre class represents probability density given by a legendre polynomial expansion :math:`\\sum\\limits_{\\ell=0}^n \\frac{2\\ell + 1}{2} a_\\ell p_\\ell(\\mu)`. It provides 8 methods and 0 properties for working with legendre data in OpenMC." }, { "instruction": "What does the Legendre class do in OpenMC's Python API?", "input": "OpenMC Python API Legendre class description", "output": "The Legendre class probability density given by a legendre polynomial expansion :math:`\\sum\\limits_{\\ell=0}^n \\frac{2\\ell + 1}{2} a_\\ell p_\\ell(\\mu)`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the coefficients parameter do when creating a Legendre?", "input": "OpenMC Python API Legendre constructor parameter coefficients", "output": "When creating a Legendre, the coefficients parameter specifies expansion coefficients :math:`a_\\ell`. note that the :math:`(2\\ell + 1)/2` factor should not be included.. It should be a Iterable of Real value." }, { "instruction": "What is the coefficients attribute of a Legendre?", "input": "OpenMC Python API Legendre attribute coefficients", "output": "The coefficients attribute of a Legendre contains expansion coefficients :math:`a_\\ell`. note that the :math:`(2\\ell + 1)/2` factor should not be included.. It's a Iterable of Real value that you can access after creating a Legendre instance." }, { "instruction": "How do you call the __init__() method in the Legendre class?", "input": "OpenMC Python API Legendre.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, coefficients: Any). It takes 2 parameters." }, { "instruction": "How do you call the __call__() method in the Legendre class?", "input": "OpenMC Python API Legendre.__call__() method signature", "output": "To call the __call__() method, use: def __call__(self: Any, x: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the Legendre class?", "input": "OpenMC Python API Legendre.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the coefficients() method in the Legendre class?", "input": "OpenMC Python API Legendre.coefficients() method signature", "output": "To call the coefficients() method, use: @property def coefficients(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the coefficients() method in the Legendre class?", "input": "OpenMC Python API Legendre.coefficients() method signature", "output": "To call the coefficients() method, use: @coefficients.setter def coefficients(self: Any, coefficients: Any). It takes 2 parameters." }, { "instruction": "How do you call the sample() method in the Legendre class?", "input": "OpenMC Python API Legendre.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "How do you call the to_xml_element() method in the Legendre class?", "input": "OpenMC Python API Legendre.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: Any). It takes 2 parameters." }, { "instruction": "How do you call the from_xml_element() method in the Legendre class?", "input": "OpenMC Python API Legendre.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What is the Mixture class in OpenMC's Python API?", "input": "OpenMC Python API Mixture class", "output": "The Mixture class represents probability distribution characterized by a mixture of random variables. It provides 13 methods and 0 properties for working with mixture data in OpenMC." }, { "instruction": "What does the Mixture class do in OpenMC's Python API?", "input": "OpenMC Python API Mixture class description", "output": "The Mixture class probability distribution characterized by a mixture of random variables. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the probability parameter do when creating a Mixture?", "input": "OpenMC Python API Mixture constructor parameter probability", "output": "When creating a Mixture, the probability parameter specifies probability of selecting a particular distribution. It should be a Iterable of Real value." }, { "instruction": "What does the distribution parameter do when creating a Mixture?", "input": "OpenMC Python API Mixture constructor parameter distribution", "output": "When creating a Mixture, the distribution parameter specifies list of distributions with corresponding probabilities. It should be a Iterable of Univariate value." }, { "instruction": "What is the probability attribute of a Mixture?", "input": "OpenMC Python API Mixture attribute probability", "output": "The probability attribute of a Mixture contains probability of selecting a particular distribution. It's a Iterable of Real value that you can access after creating a Mixture instance." }, { "instruction": "What is the distribution attribute of a Mixture?", "input": "OpenMC Python API Mixture attribute distribution", "output": "The distribution attribute of a Mixture contains list of distributions with corresponding probabilities. It's a Iterable of Univariate value that you can access after creating a Mixture instance." }, { "instruction": "How do you call the __init__() method in the Mixture class?", "input": "OpenMC Python API Mixture.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, probability: Any, distribution: Any). It takes 3 parameters." }, { "instruction": "How do you call the __len__() method in the Mixture class?", "input": "OpenMC Python API Mixture.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the probability() method in the Mixture class?", "input": "OpenMC Python API Mixture.probability() method signature", "output": "To call the probability() method, use: @property def probability(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the probability() method in the Mixture class?", "input": "OpenMC Python API Mixture.probability() method signature", "output": "To call the probability() method, use: @probability.setter def probability(self: Any, probability: Any). It takes 2 parameters." }, { "instruction": "How do you call the distribution() method in the Mixture class?", "input": "OpenMC Python API Mixture.distribution() method signature", "output": "To call the distribution() method, use: @property def distribution(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the distribution() method in the Mixture class?", "input": "OpenMC Python API Mixture.distribution() method signature", "output": "To call the distribution() method, use: @distribution.setter def distribution(self: Any, distribution: Any). It takes 2 parameters." }, { "instruction": "How do you call the cdf() method in the Mixture class?", "input": "OpenMC Python API Mixture.cdf() method signature", "output": "To call the cdf() method, use: def cdf(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sample() method in the Mixture class?", "input": "OpenMC Python API Mixture.sample() method signature", "output": "To call the sample() method, use: def sample(self: Any, n_samples: Any, seed: Any). It takes 3 parameters." }, { "instruction": "What does the normalize() method do in the Mixture class?", "input": "OpenMC Python API Mixture.normalize() method", "output": "The normalize() method normalize the probabilities stored on the distribution. It's used for mixture operations." }, { "instruction": "How do you call the normalize() method in the Mixture class?", "input": "OpenMC Python API Mixture.normalize() method signature", "output": "To call the normalize() method, use: def normalize(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the Mixture class?", "input": "OpenMC Python API Mixture.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the mixture distribution .. versionadded:: 0.13.0. It's used for mixture operations." }, { "instruction": "How do you call the to_xml_element() method in the Mixture class?", "input": "OpenMC Python API Mixture.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, element_name: str). It takes 2 parameters." }, { "instruction": "What does the element_name parameter do in the to_xml_element() method?", "input": "OpenMC Python API Mixture.to_xml_element() parameter element_name", "output": "The element_name parameter xml element name. It should be a str value." }, { "instruction": "What does the to_xml_element() method return in the Mixture class?", "input": "OpenMC Python API Mixture.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing mixture distribution data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Mixture class?", "input": "OpenMC Python API Mixture.from_xml_element() method", "output": "The from_xml_element() method generate mixture distribution from an xml element .. versionadded:: 0.13.0. It's used for mixture operations." }, { "instruction": "How do you call the from_xml_element() method in the Mixture class?", "input": "OpenMC Python API Mixture.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Mixture.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the integral() method do in the Mixture class?", "input": "OpenMC Python API Mixture.integral() method", "output": "The integral() method return integral of the distribution .. versionadded:: 0.13.1. It's used for mixture operations." }, { "instruction": "How do you call the integral() method in the Mixture class?", "input": "OpenMC Python API Mixture.integral() method signature", "output": "To call the integral() method, use: def integral(self: Any). It takes 1 parameters." }, { "instruction": "What does the clip() method do in the Mixture class?", "input": "OpenMC Python API Mixture.clip() method", "output": "The clip() method remove low-importance points / distributions like :meth:`discrete.clip`, this method will remove low-importance points from discrete distributions contained within the mixture but it will also clip any distributions that have negligible contributions to the overall intensity. .. versionadded:: 0.14.0. It's used for mixture operations." }, { "instruction": "How do you call the clip() method in the Mixture class?", "input": "OpenMC Python API Mixture.clip() method signature", "output": "To call the clip() method, use: def clip(self: Any, tolerance: float, inplace: bool). It takes 3 parameters." }, { "instruction": "What does the tolerance parameter do in the clip() method?", "input": "OpenMC Python API Mixture.clip() parameter tolerance", "output": "The tolerance parameter maximum fraction of intensities that will be discarded.. It should be a float value." }, { "instruction": "What does the inplace parameter do in the clip() method?", "input": "OpenMC Python API Mixture.clip() parameter inplace", "output": "The inplace parameter whether to modify the current object in-place or return a new one.. It should be a bool value." }, { "instruction": "What does the _intensity_clip() function do in OpenMC's Python API?", "input": "OpenMC Python API _intensity_clip() function", "output": "The _intensity_clip() function clip low-importance points from an array of intensities. given an array of intensities, this function returns an array of indices for points that contribute non-negligibly to the total sum of intensities. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _intensity_clip() function in OpenMC's Python API?", "input": "OpenMC Python API _intensity_clip() function purpose", "output": "The _intensity_clip() function clip low-importance points from an array of intensities. given an array of intensities, this function returns an array of indices for points that contribute non-negligibly to the total sum of intensities. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _intensity_clip() function in OpenMC's Python API?", "input": "OpenMC Python API _intensity_clip() function signature", "output": "To call the _intensity_clip() function, use: def _intensity_clip(intensity: Any, tolerance: float). It takes 2 parameters." }, { "instruction": "What does the intensity parameter do in the _intensity_clip() function?", "input": "OpenMC Python API _intensity_clip() parameter intensity", "output": "The intensity parameter intensities in arbitrary units.. It should be a sequence of float value." }, { "instruction": "What does the tolerance parameter do in the _intensity_clip() function?", "input": "OpenMC Python API _intensity_clip() parameter tolerance", "output": "The tolerance parameter maximum fraction of intensities that will be discarded.. It should be a float value." }, { "instruction": "What does the delta_function() function do in OpenMC's Python API?", "input": "OpenMC Python API delta_function() function", "output": "The delta_function() function return a discrete distribution with a single point. .. versionadded:: 0.15.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the delta_function() function in OpenMC's Python API?", "input": "OpenMC Python API delta_function() function purpose", "output": "The delta_function() function return a discrete distribution with a single point. .. versionadded:: 0.15.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the delta_function() function in OpenMC's Python API?", "input": "OpenMC Python API delta_function() function signature", "output": "To call the delta_function() function, use: def delta_function(value: float, intensity: float). It takes 2 parameters." }, { "instruction": "What does the value parameter do in the delta_function() function?", "input": "OpenMC Python API delta_function() parameter value", "output": "The value parameter value of the random variable.. It should be a float value." }, { "instruction": "What does the intensity parameter do in the delta_function() function?", "input": "OpenMC Python API delta_function() parameter intensity", "output": "The intensity parameter when used for an energy distribution, this can be used to assign an intensity.. It should be a float, optional value." }, { "instruction": "What does the muir() function do in OpenMC's Python API?", "input": "OpenMC Python API muir() function", "output": "The muir() function generate a muir energy spectrum the muir energy spectrum is a normal distribution, but for convenience reasons allows the user to specify three parameters to define the distribution: the mean energy of particles ``e0``, the mass of reactants ``m_rat``, and the ion temperature ``kt``. .. versionadded:: 0.13.2. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the muir() function in OpenMC's Python API?", "input": "OpenMC Python API muir() function purpose", "output": "The muir() function generate a muir energy spectrum the muir energy spectrum is a normal distribution, but for convenience reasons allows the user to specify three parameters to define the distribution: the mean energy of particles ``e0``, the mass of reactants ``m_rat``, and the ion temperature ``kt``. .. versionadded:: 0.13.2. It's part of OpenMC's Python API." }, { "instruction": "How do you call the muir() function in OpenMC's Python API?", "input": "OpenMC Python API muir() function signature", "output": "To call the muir() function, use: def muir(e0: float, m_rat: float, kt: float). It takes 3 parameters." }, { "instruction": "What does the e0 parameter do in the muir() function?", "input": "OpenMC Python API muir() parameter e0", "output": "The e0 parameter mean of the muir distribution in [ev]. It should be a float value." }, { "instruction": "What does the m_rat parameter do in the muir() function?", "input": "OpenMC Python API muir() parameter m_rat", "output": "The m_rat parameter ratio of the sum of the masses of the reaction inputs to 1 amu. It should be a float value." }, { "instruction": "What does the kt parameter do in the muir() function?", "input": "OpenMC Python API muir() parameter kt", "output": "The kt parameter ion temperature for the muir distribution in [ev]. It should be a float value." }, { "instruction": "How do you call the Muir() function in OpenMC's Python API?", "input": "OpenMC Python API Muir() function signature", "output": "To call the Muir() function, use: def Muir(). It takes 0 parameters." }, { "instruction": "What does the combine_distributions() function do in OpenMC's Python API?", "input": "OpenMC Python API combine_distributions() function", "output": "The combine_distributions() function combine distributions with specified probabilities this function can be used to combine multiple instances of :class:`~openmc.stats.discrete` and `~openmc.stats.tabular`. multiple discrete distributions are merged into a single distribution and the remainder of the distributions are put into a :class:`~openmc.stats.mixture` distribution. .. versionadded:: 0.13.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the combine_distributions() function in OpenMC's Python API?", "input": "OpenMC Python API combine_distributions() function purpose", "output": "The combine_distributions() function combine distributions with specified probabilities this function can be used to combine multiple instances of :class:`~openmc.stats.discrete` and `~openmc.stats.tabular`. multiple discrete distributions are merged into a single distribution and the remainder of the distributions are put into a :class:`~openmc.stats.mixture` distribution. .. versionadded:: 0.13.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the combine_distributions() function in OpenMC's Python API?", "input": "OpenMC Python API combine_distributions() function signature", "output": "To call the combine_distributions() function, use: def combine_distributions(dists: Any, probs: Any). It takes 2 parameters." }, { "instruction": "What does the dists parameter do in the combine_distributions() function?", "input": "OpenMC Python API combine_distributions() parameter dists", "output": "The dists parameter distributions to combine. It should be a iterable of openmc.stats.Univariate value." }, { "instruction": "What does the probs parameter do in the combine_distributions() function?", "input": "OpenMC Python API combine_distributions() parameter probs", "output": "The probs parameter probability (or intensity) of each distribution. It should be a iterable of float value." }, { "instruction": "What is the Summary class in OpenMC's Python API?", "input": "OpenMC Python API Summary class", "output": "The Summary class represents summary of model used in a simulation. It provides 17 methods and 0 properties for working with summary data in OpenMC." }, { "instruction": "What does the Summary class do in OpenMC's Python API?", "input": "OpenMC Python API Summary class description", "output": "The Summary class summary of model used in a simulation. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filename parameter do when creating a Summary?", "input": "OpenMC Python API Summary constructor parameter filename", "output": "When creating a Summary, the filename parameter specifies path to file to load. It should be a str or path-like value." }, { "instruction": "What is the date_and_time attribute of a Summary?", "input": "OpenMC Python API Summary attribute date_and_time", "output": "The date_and_time attribute of a Summary contains date and time when simulation began. It's a str value that you can access after creating a Summary instance." }, { "instruction": "What is the geometry attribute of a Summary?", "input": "OpenMC Python API Summary attribute geometry", "output": "The geometry attribute of a Summary contains the geometry reconstructed from the summary file. It's a openmc.Geometry value that you can access after creating a Summary instance." }, { "instruction": "What is the materials attribute of a Summary?", "input": "OpenMC Python API Summary attribute materials", "output": "The materials attribute of a Summary contains the materials reconstructed from the summary file. It's a openmc.Materials value that you can access after creating a Summary instance." }, { "instruction": "What is the nuclides attribute of a Summary?", "input": "OpenMC Python API Summary attribute nuclides", "output": "The nuclides attribute of a Summary contains dictionary whose keys are nuclide names and values are atomic weight ratios.. It's a dict value that you can access after creating a Summary instance." }, { "instruction": "What is the macroscopics attribute of a Summary?", "input": "OpenMC Python API Summary attribute macroscopics", "output": "The macroscopics attribute of a Summary contains names of macroscopic data sets. It's a list value that you can access after creating a Summary instance." }, { "instruction": "What is the version attribute of a Summary?", "input": "OpenMC Python API Summary attribute version", "output": "The version attribute of a Summary contains version of openmc. It's a tuple of int value that you can access after creating a Summary instance." }, { "instruction": "How do you call the __init__() method in the Summary class?", "input": "OpenMC Python API Summary.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "How do you call the date_and_time() method in the Summary class?", "input": "OpenMC Python API Summary.date_and_time() method signature", "output": "To call the date_and_time() method, use: @property def date_and_time(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the geometry() method in the Summary class?", "input": "OpenMC Python API Summary.geometry() method signature", "output": "To call the geometry() method, use: @property def geometry(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the materials() method in the Summary class?", "input": "OpenMC Python API Summary.materials() method signature", "output": "To call the materials() method, use: @property def materials(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the Summary class?", "input": "OpenMC Python API Summary.nuclides() method signature", "output": "To call the nuclides() method, use: @property def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the macroscopics() method in the Summary class?", "input": "OpenMC Python API Summary.macroscopics() method signature", "output": "To call the macroscopics() method, use: @property def macroscopics(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the version() method in the Summary class?", "input": "OpenMC Python API Summary.version() method signature", "output": "To call the version() method, use: @property def version(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_nuclides() method in the Summary class?", "input": "OpenMC Python API Summary._read_nuclides() method signature", "output": "To call the _read_nuclides() method, use: def _read_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_macroscopics() method in the Summary class?", "input": "OpenMC Python API Summary._read_macroscopics() method signature", "output": "To call the _read_macroscopics() method, use: def _read_macroscopics(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_geometry() method in the Summary class?", "input": "OpenMC Python API Summary._read_geometry() method signature", "output": "To call the _read_geometry() method, use: def _read_geometry(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_materials() method in the Summary class?", "input": "OpenMC Python API Summary._read_materials() method signature", "output": "To call the _read_materials() method, use: def _read_materials(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_surfaces() method in the Summary class?", "input": "OpenMC Python API Summary._read_surfaces() method signature", "output": "To call the _read_surfaces() method, use: def _read_surfaces(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_cells() method in the Summary class?", "input": "OpenMC Python API Summary._read_cells() method signature", "output": "To call the _read_cells() method, use: def _read_cells(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_universes() method in the Summary class?", "input": "OpenMC Python API Summary._read_universes() method signature", "output": "To call the _read_universes() method, use: def _read_universes(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _read_lattices() method in the Summary class?", "input": "OpenMC Python API Summary._read_lattices() method signature", "output": "To call the _read_lattices() method, use: def _read_lattices(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _finalize_geometry() method in the Summary class?", "input": "OpenMC Python API Summary._finalize_geometry() method signature", "output": "To call the _finalize_geometry() method, use: def _finalize_geometry(self: Any, cell_fills: Any). It takes 2 parameters." }, { "instruction": "What does the add_volume_information() method do in the Summary class?", "input": "OpenMC Python API Summary.add_volume_information() method", "output": "The add_volume_information() method add volume information to the geometry within the summary file. It's used for summary operations." }, { "instruction": "How do you call the add_volume_information() method in the Summary class?", "input": "OpenMC Python API Summary.add_volume_information() method signature", "output": "To call the add_volume_information() method, use: def add_volume_information(self: Any, volume_calc: Any). It takes 2 parameters." }, { "instruction": "What does the volume_calc parameter do in the add_volume_information() method?", "input": "OpenMC Python API Summary.add_volume_information() parameter volume_calc", "output": "The volume_calc parameter results from a stochastic volume calculation. It should be a openmc.VolumeCalculation value." }, { "instruction": "What is the SurfaceCoefficient class in OpenMC's Python API?", "input": "OpenMC Python API SurfaceCoefficient class", "output": "The SurfaceCoefficient class represents descriptor class for surface coefficients. It provides 3 methods and 0 properties for working with surfacecoefficient data in OpenMC." }, { "instruction": "What does the SurfaceCoefficient class do in OpenMC's Python API?", "input": "OpenMC Python API SurfaceCoefficient class description", "output": "The SurfaceCoefficient class descriptor class for surface coefficients. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the value parameter do when creating a SurfaceCoefficient?", "input": "OpenMC Python API SurfaceCoefficient constructor parameter value", "output": "When creating a SurfaceCoefficient, the value parameter specifies value of the coefficient (float) or the name of the coefficient that it is equivalent to (str).. It should be a float or str value." }, { "instruction": "How do you call the __init__() method in the SurfaceCoefficient class?", "input": "OpenMC Python API SurfaceCoefficient.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, value: Any). It takes 2 parameters." }, { "instruction": "How do you call the __get__() method in the SurfaceCoefficient class?", "input": "OpenMC Python API SurfaceCoefficient.__get__() method signature", "output": "To call the __get__() method, use: def __get__(self: Any, instance: Any, owner: Any). It takes 3 parameters." }, { "instruction": "How do you call the __set__() method in the SurfaceCoefficient class?", "input": "OpenMC Python API SurfaceCoefficient.__set__() method signature", "output": "To call the __set__() method, use: def __set__(self: Any, instance: Any, value: Any). It takes 3 parameters." }, { "instruction": "What is the Surface class in OpenMC's Python API?", "input": "OpenMC Python API Surface class", "output": "The Surface class represents an implicit surface with an associated boundary condition. an implicit surface is defined as the set of zeros of a function of the three cartesian coordinates. surfaces in openmc are limited to a set of algebraic surfaces, i.e., surfaces that are polynomial in x, y, and z. It provides 23 methods and 0 properties for working with surface data in OpenMC." }, { "instruction": "What does the Surface class do in OpenMC's Python API?", "input": "OpenMC Python API Surface class description", "output": "The Surface class an implicit surface with an associated boundary condition. an implicit surface is defined as the set of zeros of a function of the three cartesian coordinates. surfaces in openmc are limited to a set of algebraic surfaces, i.e., surfaces that are polynomial in x, y, and z. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the surface_id parameter do when creating a Surface?", "input": "OpenMC Python API Surface constructor parameter surface_id", "output": "When creating a Surface, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a Surface?", "input": "OpenMC Python API Surface constructor parameter boundary_type", "output": "When creating a Surface, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface. note that periodic boundary conditions can only be applied to x-, y-, and z-planes, and only axis-aligned periodicity is supported.. It should be a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a Surface?", "input": "OpenMC Python API Surface constructor parameter albedo", "output": "When creating a Surface, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a Surface?", "input": "OpenMC Python API Surface constructor parameter name", "output": "When creating a Surface, the name parameter specifies name of the surface. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What is the boundary_type attribute of a Surface?", "input": "OpenMC Python API Surface attribute boundary_type", "output": "The boundary_type attribute of a Surface contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'} value that you can access after creating a Surface instance." }, { "instruction": "What is the albedo attribute of a Surface?", "input": "OpenMC Python API Surface attribute albedo", "output": "The albedo attribute of a Surface contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a Surface instance." }, { "instruction": "What is the coefficients attribute of a Surface?", "input": "OpenMC Python API Surface attribute coefficients", "output": "The coefficients attribute of a Surface contains dictionary of surface coefficients. It's a dict value that you can access after creating a Surface instance." }, { "instruction": "What is the id attribute of a Surface?", "input": "OpenMC Python API Surface attribute id", "output": "The id attribute of a Surface contains unique identifier for the surface. It's a int value that you can access after creating a Surface instance." }, { "instruction": "What is the name attribute of a Surface?", "input": "OpenMC Python API Surface attribute name", "output": "The name attribute of a Surface contains name of the surface. It's a str value that you can access after creating a Surface instance." }, { "instruction": "What is the type attribute of a Surface?", "input": "OpenMC Python API Surface attribute type", "output": "The type attribute of a Surface contains type of the surface. It's a str value that you can access after creating a Surface instance." }, { "instruction": "How do you call the __init__() method in the Surface class?", "input": "OpenMC Python API Surface.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, surface_id: Any, boundary_type: Any, albedo: Any, name: Any). It takes 5 parameters." }, { "instruction": "How do you call the __neg__() method in the Surface class?", "input": "OpenMC Python API Surface.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __pos__() method in the Surface class?", "input": "OpenMC Python API Surface.__pos__() method signature", "output": "To call the __pos__() method, use: def __pos__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __repr__() method in the Surface class?", "input": "OpenMC Python API Surface.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Surface class?", "input": "OpenMC Python API Surface.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Surface class?", "input": "OpenMC Python API Surface.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the type() method in the Surface class?", "input": "OpenMC Python API Surface.type() method signature", "output": "To call the type() method, use: @property def type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the boundary_type() method in the Surface class?", "input": "OpenMC Python API Surface.boundary_type() method signature", "output": "To call the boundary_type() method, use: @property def boundary_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the boundary_type() method in the Surface class?", "input": "OpenMC Python API Surface.boundary_type() method signature", "output": "To call the boundary_type() method, use: @boundary_type.setter def boundary_type(self: Any, boundary_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the albedo() method in the Surface class?", "input": "OpenMC Python API Surface.albedo() method signature", "output": "To call the albedo() method, use: @property def albedo(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the albedo() method in the Surface class?", "input": "OpenMC Python API Surface.albedo() method signature", "output": "To call the albedo() method, use: @albedo.setter def albedo(self: Any, albedo: Any). It takes 2 parameters." }, { "instruction": "How do you call the coefficients() method in the Surface class?", "input": "OpenMC Python API Surface.coefficients() method signature", "output": "To call the coefficients() method, use: @property def coefficients(self: Any). It takes 1 parameters." }, { "instruction": "What does the bounding_box() method do in the Surface class?", "input": "OpenMC Python API Surface.bounding_box() method", "output": "The bounding_box() method determine an axis-aligned bounding box. an axis-aligned bounding box for surface half-spaces is represented by its lower-left and upper-right coordinates. if the half-space is unbounded in a particular direction, numpy.inf is used to represent infinity. It's used for surface operations." }, { "instruction": "How do you call the bounding_box() method in the Surface class?", "input": "OpenMC Python API Surface.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "What does the side parameter do in the bounding_box() method?", "input": "OpenMC Python API Surface.bounding_box() parameter side", "output": "The side parameter indicates the negative or positive half-space. It should be a {'+', '-'} value." }, { "instruction": "What does the clone() method do in the Surface class?", "input": "OpenMC Python API Surface.clone() method", "output": "The clone() method create a copy of this surface with a new unique id. It's used for surface operations." }, { "instruction": "How do you call the clone() method in the Surface class?", "input": "OpenMC Python API Surface.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the memo parameter do in the clone() method?", "input": "OpenMC Python API Surface.clone() parameter memo", "output": "The memo parameter a nested dictionary of previously cloned objects. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the clone() method return in the Surface class?", "input": "OpenMC Python API Surface.clone() return value", "output": "The clone() method returns the clone of this surface. The return type is openmc.Surface." }, { "instruction": "What does the normalize() method do in the Surface class?", "input": "OpenMC Python API Surface.normalize() method", "output": "The normalize() method normalize coefficients by first nonzero value .. versionadded:: 0.12. It's used for surface operations." }, { "instruction": "How do you call the normalize() method in the Surface class?", "input": "OpenMC Python API Surface.normalize() method signature", "output": "To call the normalize() method, use: def normalize(self: Any, coeffs: Any). It takes 2 parameters." }, { "instruction": "What does the coeffs parameter do in the normalize() method?", "input": "OpenMC Python API Surface.normalize() parameter coeffs", "output": "The coeffs parameter tuple of surface coefficients to normalize. defaults to none. if no coefficients are supplied then the coefficients will be taken from the current surface.. It should be a tuple, optional value." }, { "instruction": "What does the is_equal() method do in the Surface class?", "input": "OpenMC Python API Surface.is_equal() method", "output": "The is_equal() method determine if this surface is equivalent to another. It's used for surface operations." }, { "instruction": "How do you call the is_equal() method in the Surface class?", "input": "OpenMC Python API Surface.is_equal() method signature", "output": "To call the is_equal() method, use: def is_equal(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the is_equal() method?", "input": "OpenMC Python API Surface.is_equal() parameter other", "output": "The other parameter instance of openmc.surface that should be compared to the current surface. It should be a instance of openmc.Surface value." }, { "instruction": "What does the _get_base_coeffs() method do in the Surface class?", "input": "OpenMC Python API Surface._get_base_coeffs() method", "output": "The _get_base_coeffs() method return polynomial coefficients representing the implicit surface\n equation.. It's used for surface operations." }, { "instruction": "How do you call the _get_base_coeffs() method in the Surface class?", "input": "OpenMC Python API Surface._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: @abstractmethod def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "What does the evaluate() method do in the Surface class?", "input": "OpenMC Python API Surface.evaluate() method", "output": "The evaluate() method evaluate the surface equation at a given point. It's used for surface operations." }, { "instruction": "How do you call the evaluate() method in the Surface class?", "input": "OpenMC Python API Surface.evaluate() method signature", "output": "To call the evaluate() method, use: @abstractmethod def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the evaluate() method?", "input": "OpenMC Python API Surface.evaluate() parameter point", "output": "The point parameter the cartesian coordinates, :math:`(x',y',z')`, at which the surface equation should be evaluated.. It should be a 3-tuple of float value." }, { "instruction": "What does the translate() method do in the Surface class?", "input": "OpenMC Python API Surface.translate() method", "output": "The translate() method translate surface in given direction. It's used for surface operations." }, { "instruction": "How do you call the translate() method in the Surface class?", "input": "OpenMC Python API Surface.translate() method signature", "output": "To call the translate() method, use: @abstractmethod def translate(self: Any, vector: Any, inplace: Any). It takes 3 parameters." }, { "instruction": "What does the vector parameter do in the translate() method?", "input": "OpenMC Python API Surface.translate() parameter vector", "output": "The vector parameter direction in which surface should be translated. It should be a iterable of float value." }, { "instruction": "What does the inplace parameter do in the translate() method?", "input": "OpenMC Python API Surface.translate() parameter inplace", "output": "The inplace parameter whether or not to return a new instance of this surface or to modify the coefficients of this surface.. It should be a bool value." }, { "instruction": "What does the rotate() method do in the Surface class?", "input": "OpenMC Python API Surface.rotate() method", "output": "The rotate() method rotate surface by angles provided or by applying matrix directly. .. versionadded:: 0.12. It's used for surface operations." }, { "instruction": "How do you call the rotate() method in the Surface class?", "input": "OpenMC Python API Surface.rotate() method signature", "output": "To call the rotate() method, use: @abstractmethod def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any). It takes 5 parameters." }, { "instruction": "What does the rotation parameter do in the rotate() method?", "input": "OpenMC Python API Surface.rotate() parameter rotation", "output": "The rotation parameter a 3-tuple of angles :math:`(\\phi, \\theta, \\psi)` in degrees where the first element is the rotation about the x-axis in the fixed laboratory frame, the second element is the rotation about the y-axis in the fixed laboratory frame, and the third element is the rotation about the z-axis in the fixed laboratory frame. the rotations are active rotations. additionally a 3x3 rotation matrix can be specified directly either as a nested iterable or array.. It should be a 3-tuple of float, or 3x3 iterable value." }, { "instruction": "What does the pivot parameter do in the rotate() method?", "input": "OpenMC Python API Surface.rotate() parameter pivot", "output": "The pivot parameter (x, y, z) coordinates for the point to rotate about. defaults to (0., 0., 0.). It should be a iterable of float, optional value." }, { "instruction": "What does the order parameter do in the rotate() method?", "input": "OpenMC Python API Surface.rotate() parameter order", "output": "The order parameter a string of 'x', 'y', and 'z' in some order specifying which rotation to perform first, second, and third. defaults to 'xyz' which means, the rotation by angle :math:`\\phi` about x will be applied first, followed by :math:`\\theta` about y and then :math:`\\psi` about z. this corresponds to an x-y-z extrinsic rotation as well as a z-y'-x'' intrinsic rotation using tait-bryan. It should be a str, optional value." }, { "instruction": "What does the angles parameter do in the rotate() method?", "input": "OpenMC Python API Surface.rotate() parameter angles", "output": "The angles parameter . It should be a math:`(\\phi, \\theta, \\psi)`. value." }, { "instruction": "What does the inplace parameter do in the rotate() method?", "input": "OpenMC Python API Surface.rotate() parameter inplace", "output": "The inplace parameter whether or not to return a new instance of surface or to modify the coefficients of this surface in place. defaults to false.. It should be a bool value." }, { "instruction": "What does the to_xml_element() method do in the Surface class?", "input": "OpenMC Python API Surface.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the surface. It's used for surface operations." }, { "instruction": "How do you call the to_xml_element() method in the Surface class?", "input": "OpenMC Python API Surface.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Surface class?", "input": "OpenMC Python API Surface.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Surface class?", "input": "OpenMC Python API Surface.from_xml_element() method", "output": "The from_xml_element() method generate surface from an xml element. It's used for surface operations." }, { "instruction": "How do you call the from_xml_element() method in the Surface class?", "input": "OpenMC Python API Surface.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @staticmethod def from_xml_element(elem: Any). It takes 1 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Surface.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the from_hdf5() method do in the Surface class?", "input": "OpenMC Python API Surface.from_hdf5() method", "output": "The from_hdf5() method create surface from hdf5 group. It's used for surface operations." }, { "instruction": "How do you call the from_hdf5() method in the Surface class?", "input": "OpenMC Python API Surface.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @staticmethod def from_hdf5(group: Any). It takes 1 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Surface.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What is the PlaneMixin class in OpenMC's Python API?", "input": "OpenMC Python API PlaneMixin class", "output": "The PlaneMixin class represents a plane mixin class for all operations on order 1 surfaces. It provides 10 methods and 0 properties for working with planemixin data in OpenMC." }, { "instruction": "What does the PlaneMixin class do in OpenMC's Python API?", "input": "OpenMC Python API PlaneMixin class description", "output": "The PlaneMixin class a plane mixin class for all operations on order 1 surfaces. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the periodic_surface() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.periodic_surface() method signature", "output": "To call the periodic_surface() method, use: @property def periodic_surface(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the periodic_surface() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.periodic_surface() method signature", "output": "To call the periodic_surface() method, use: @periodic_surface.setter def periodic_surface(self: Any, periodic_surface: Any). It takes 2 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _get_normal() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin._get_normal() method signature", "output": "To call the _get_normal() method, use: def _get_normal(self: Any). It takes 1 parameters." }, { "instruction": "What does the bounding_box() method do in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.bounding_box() method", "output": "The bounding_box() method determine an axis-aligned bounding box. an axis-aligned bounding box for plane half-spaces is represented by its lower-left and upper-right coordinates. if the half-space is unbounded in a particular direction, numpy.inf is used to represent infinity. It's used for planemixin operations." }, { "instruction": "How do you call the bounding_box() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "What does the side parameter do in the bounding_box() method?", "input": "OpenMC Python API PlaneMixin.bounding_box() parameter side", "output": "The side parameter indicates the negative or positive half-space. It should be a {'+', '-'} value." }, { "instruction": "What does the evaluate() method do in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.evaluate() method", "output": "The evaluate() method evaluate the surface equation at a given point. It's used for planemixin operations." }, { "instruction": "How do you call the evaluate() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the evaluate() method?", "input": "OpenMC Python API PlaneMixin.evaluate() parameter point", "output": "The point parameter the cartesian coordinates, :math:`(x',y',z')`, at which the surface equation should be evaluated.. It should be a 3-tuple of float value." }, { "instruction": "What does the translate() method do in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.translate() method", "output": "The translate() method translate surface in given direction. It's used for planemixin operations." }, { "instruction": "How do you call the translate() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.translate() method signature", "output": "To call the translate() method, use: def translate(self: Any, vector: Any, inplace: Any). It takes 3 parameters." }, { "instruction": "What does the vector parameter do in the translate() method?", "input": "OpenMC Python API PlaneMixin.translate() parameter vector", "output": "The vector parameter direction in which surface should be translated. It should be a iterable of float value." }, { "instruction": "What does the inplace parameter do in the translate() method?", "input": "OpenMC Python API PlaneMixin.translate() parameter inplace", "output": "The inplace parameter whether or not to return a new instance of a plane or to modify the coefficients of this plane.. It should be a bool value." }, { "instruction": "How do you call the rotate() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.rotate() method signature", "output": "To call the rotate() method, use: def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any). It takes 5 parameters." }, { "instruction": "What does the to_xml_element() method do in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the surface. It's used for planemixin operations." }, { "instruction": "How do you call the to_xml_element() method in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the PlaneMixin class?", "input": "OpenMC Python API PlaneMixin.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What is the Plane class in OpenMC's Python API?", "input": "OpenMC Python API Plane class", "output": "The Plane class represents an arbitrary plane of the form :math:`ax + by + cz = d`. It provides 4 methods and 0 properties for working with plane data in OpenMC." }, { "instruction": "What does the Plane class do in OpenMC's Python API?", "input": "OpenMC Python API Plane class description", "output": "The Plane class an arbitrary plane of the form :math:`ax + by + cz = d`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the a parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter a", "output": "When creating a Plane, the a parameter specifies the 'a' parameter for the plane. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the b parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter b", "output": "When creating a Plane, the b parameter specifies the 'b' parameter for the plane. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the c parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter c", "output": "When creating a Plane, the c parameter specifies the 'c' parameter for the plane. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the d parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter d", "output": "When creating a Plane, the d parameter specifies the 'd' parameter for the plane. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter boundary_type", "output": "When creating a Plane, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter albedo", "output": "When creating a Plane, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter name", "output": "When creating a Plane, the name parameter specifies name of the plane. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a Plane?", "input": "OpenMC Python API Plane constructor parameter surface_id", "output": "When creating a Plane, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the a attribute of a Plane?", "input": "OpenMC Python API Plane attribute a", "output": "The a attribute of a Plane contains the 'a' parameter for the plane. It's a float value that you can access after creating a Plane instance." }, { "instruction": "What is the b attribute of a Plane?", "input": "OpenMC Python API Plane attribute b", "output": "The b attribute of a Plane contains the 'b' parameter for the plane. It's a float value that you can access after creating a Plane instance." }, { "instruction": "What is the c attribute of a Plane?", "input": "OpenMC Python API Plane attribute c", "output": "The c attribute of a Plane contains the 'c' parameter for the plane. It's a float value that you can access after creating a Plane instance." }, { "instruction": "What is the d attribute of a Plane?", "input": "OpenMC Python API Plane attribute d", "output": "The d attribute of a Plane contains the 'd' parameter for the plane. It's a float value that you can access after creating a Plane instance." }, { "instruction": "What is the boundary_type attribute of a Plane?", "input": "OpenMC Python API Plane attribute boundary_type", "output": "The boundary_type attribute of a Plane contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'} value that you can access after creating a Plane instance." }, { "instruction": "What is the albedo attribute of a Plane?", "input": "OpenMC Python API Plane attribute albedo", "output": "The albedo attribute of a Plane contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a Plane instance." }, { "instruction": "What is the periodic_surface attribute of a Plane?", "input": "OpenMC Python API Plane attribute periodic_surface", "output": "The periodic_surface attribute of a Plane contains if a periodic boundary condition is used, the surface with which this one is periodic with. It's a openmc.Surface value that you can access after creating a Plane instance." }, { "instruction": "What is the coefficients attribute of a Plane?", "input": "OpenMC Python API Plane attribute coefficients", "output": "The coefficients attribute of a Plane contains dictionary of surface coefficients. It's a dict value that you can access after creating a Plane instance." }, { "instruction": "What is the id attribute of a Plane?", "input": "OpenMC Python API Plane attribute id", "output": "The id attribute of a Plane contains unique identifier for the surface. It's a int value that you can access after creating a Plane instance." }, { "instruction": "What is the name attribute of a Plane?", "input": "OpenMC Python API Plane attribute name", "output": "The name attribute of a Plane contains name of the surface. It's a str value that you can access after creating a Plane instance." }, { "instruction": "What is the type attribute of a Plane?", "input": "OpenMC Python API Plane attribute type", "output": "The type attribute of a Plane contains type of the surface. It's a str value that you can access after creating a Plane instance." }, { "instruction": "How do you call the __init__() method in the Plane class?", "input": "OpenMC Python API Plane.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, a: Any, b: Any, c: Any, d: Any). It takes 5 parameters." }, { "instruction": "How do you call the __subclasshook__() method in the Plane class?", "input": "OpenMC Python API Plane.__subclasshook__() method signature", "output": "To call the __subclasshook__() method, use: @classmethod def __subclasshook__(cls: Any, c: Any). It takes 2 parameters." }, { "instruction": "What does the from_points() method do in the Plane class?", "input": "OpenMC Python API Plane.from_points() method", "output": "The from_points() method return a plane given three points that pass through it. It's used for plane operations." }, { "instruction": "How do you call the from_points() method in the Plane class?", "input": "OpenMC Python API Plane.from_points() method signature", "output": "To call the from_points() method, use: @classmethod def from_points(cls: Any, p1: Any, p2: Any, p3: Any). It takes 4 parameters." }, { "instruction": "What does the kwargs parameter do in the from_points() method?", "input": "OpenMC Python API Plane.from_points() parameter kwargs", "output": "The kwargs parameter keyword arguments passed to the :class:`plane` constructor. It should be a dict value." }, { "instruction": "What does the flip_normal() method do in the Plane class?", "input": "OpenMC Python API Plane.flip_normal() method", "output": "The flip_normal() method modify plane coefficients to reverse the normal vector.. It's used for plane operations." }, { "instruction": "How do you call the flip_normal() method in the Plane class?", "input": "OpenMC Python API Plane.flip_normal() method signature", "output": "To call the flip_normal() method, use: def flip_normal(self: Any). It takes 1 parameters." }, { "instruction": "What is the XPlane class in OpenMC's Python API?", "input": "OpenMC Python API XPlane class", "output": "The XPlane class represents a plane perpendicular to the x axis of the form :math:`x - x_0 = 0`. It provides 2 methods and 0 properties for working with xplane data in OpenMC." }, { "instruction": "What does the XPlane class do in OpenMC's Python API?", "input": "OpenMC Python API XPlane class description", "output": "The XPlane class a plane perpendicular to the x axis of the form :math:`x - x_0 = 0`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a XPlane?", "input": "OpenMC Python API XPlane constructor parameter x0", "output": "When creating a XPlane, the x0 parameter specifies location of the plane in [cm]. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a XPlane?", "input": "OpenMC Python API XPlane constructor parameter boundary_type", "output": "When creating a XPlane, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface. only axis-aligned periodicity is supported, i.e., x-planes can only be paired with x-planes.. It should be a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a XPlane?", "input": "OpenMC Python API XPlane constructor parameter albedo", "output": "When creating a XPlane, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a XPlane?", "input": "OpenMC Python API XPlane constructor parameter name", "output": "When creating a XPlane, the name parameter specifies name of the plane. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a XPlane?", "input": "OpenMC Python API XPlane constructor parameter surface_id", "output": "When creating a XPlane, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute x0", "output": "The x0 attribute of a XPlane contains location of the plane in [cm]. It's a float value that you can access after creating a XPlane instance." }, { "instruction": "What is the boundary_type attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute boundary_type", "output": "The boundary_type attribute of a XPlane contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'} value that you can access after creating a XPlane instance." }, { "instruction": "What is the albedo attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute albedo", "output": "The albedo attribute of a XPlane contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a XPlane instance." }, { "instruction": "What is the periodic_surface attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute periodic_surface", "output": "The periodic_surface attribute of a XPlane contains if a periodic boundary condition is used, the surface with which this one is periodic with. It's a openmc.Surface value that you can access after creating a XPlane instance." }, { "instruction": "What is the coefficients attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute coefficients", "output": "The coefficients attribute of a XPlane contains dictionary of surface coefficients. It's a dict value that you can access after creating a XPlane instance." }, { "instruction": "What is the id attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute id", "output": "The id attribute of a XPlane contains unique identifier for the surface. It's a int value that you can access after creating a XPlane instance." }, { "instruction": "What is the name attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute name", "output": "The name attribute of a XPlane contains name of the surface. It's a str value that you can access after creating a XPlane instance." }, { "instruction": "What is the type attribute of a XPlane?", "input": "OpenMC Python API XPlane attribute type", "output": "The type attribute of a XPlane contains type of the surface. It's a str value that you can access after creating a XPlane instance." }, { "instruction": "How do you call the __init__() method in the XPlane class?", "input": "OpenMC Python API XPlane.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any). It takes 2 parameters." }, { "instruction": "How do you call the evaluate() method in the XPlane class?", "input": "OpenMC Python API XPlane.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the YPlane class in OpenMC's Python API?", "input": "OpenMC Python API YPlane class", "output": "The YPlane class represents a plane perpendicular to the y axis of the form :math:`y - y_0 = 0`. It provides 2 methods and 0 properties for working with yplane data in OpenMC." }, { "instruction": "What does the YPlane class do in OpenMC's Python API?", "input": "OpenMC Python API YPlane class description", "output": "The YPlane class a plane perpendicular to the y axis of the form :math:`y - y_0 = 0`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the y0 parameter do when creating a YPlane?", "input": "OpenMC Python API YPlane constructor parameter y0", "output": "When creating a YPlane, the y0 parameter specifies location of the plane in [cm]. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a YPlane?", "input": "OpenMC Python API YPlane constructor parameter boundary_type", "output": "When creating a YPlane, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface. only axis-aligned periodicity is supported, i.e., y-planes can only be paired with y-planes.. It should be a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a YPlane?", "input": "OpenMC Python API YPlane constructor parameter albedo", "output": "When creating a YPlane, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a YPlane?", "input": "OpenMC Python API YPlane constructor parameter name", "output": "When creating a YPlane, the name parameter specifies name of the plane. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a YPlane?", "input": "OpenMC Python API YPlane constructor parameter surface_id", "output": "When creating a YPlane, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the y0 attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute y0", "output": "The y0 attribute of a YPlane contains location of the plane in [cm]. It's a float value that you can access after creating a YPlane instance." }, { "instruction": "What is the boundary_type attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute boundary_type", "output": "The boundary_type attribute of a YPlane contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'} value that you can access after creating a YPlane instance." }, { "instruction": "What is the albedo attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute albedo", "output": "The albedo attribute of a YPlane contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a YPlane instance." }, { "instruction": "What is the periodic_surface attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute periodic_surface", "output": "The periodic_surface attribute of a YPlane contains if a periodic boundary condition is used, the surface with which this one is periodic with. It's a openmc.Surface value that you can access after creating a YPlane instance." }, { "instruction": "What is the coefficients attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute coefficients", "output": "The coefficients attribute of a YPlane contains dictionary of surface coefficients. It's a dict value that you can access after creating a YPlane instance." }, { "instruction": "What is the id attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute id", "output": "The id attribute of a YPlane contains unique identifier for the surface. It's a int value that you can access after creating a YPlane instance." }, { "instruction": "What is the name attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute name", "output": "The name attribute of a YPlane contains name of the surface. It's a str value that you can access after creating a YPlane instance." }, { "instruction": "What is the type attribute of a YPlane?", "input": "OpenMC Python API YPlane attribute type", "output": "The type attribute of a YPlane contains type of the surface. It's a str value that you can access after creating a YPlane instance." }, { "instruction": "How do you call the __init__() method in the YPlane class?", "input": "OpenMC Python API YPlane.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, y0: Any). It takes 2 parameters." }, { "instruction": "How do you call the evaluate() method in the YPlane class?", "input": "OpenMC Python API YPlane.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the ZPlane class in OpenMC's Python API?", "input": "OpenMC Python API ZPlane class", "output": "The ZPlane class represents a plane perpendicular to the z axis of the form :math:`z - z_0 = 0`. It provides 2 methods and 0 properties for working with zplane data in OpenMC." }, { "instruction": "What does the ZPlane class do in OpenMC's Python API?", "input": "OpenMC Python API ZPlane class description", "output": "The ZPlane class a plane perpendicular to the z axis of the form :math:`z - z_0 = 0`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the z0 parameter do when creating a ZPlane?", "input": "OpenMC Python API ZPlane constructor parameter z0", "output": "When creating a ZPlane, the z0 parameter specifies location of the plane in [cm]. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a ZPlane?", "input": "OpenMC Python API ZPlane constructor parameter boundary_type", "output": "When creating a ZPlane, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface. only axis-aligned periodicity is supported, i.e., z-planes can only be paired with z-planes.. It should be a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a ZPlane?", "input": "OpenMC Python API ZPlane constructor parameter albedo", "output": "When creating a ZPlane, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a ZPlane?", "input": "OpenMC Python API ZPlane constructor parameter name", "output": "When creating a ZPlane, the name parameter specifies name of the plane. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a ZPlane?", "input": "OpenMC Python API ZPlane constructor parameter surface_id", "output": "When creating a ZPlane, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the z0 attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute z0", "output": "The z0 attribute of a ZPlane contains location of the plane in [cm]. It's a float value that you can access after creating a ZPlane instance." }, { "instruction": "What is the boundary_type attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute boundary_type", "output": "The boundary_type attribute of a ZPlane contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'periodic', 'white'} value that you can access after creating a ZPlane instance." }, { "instruction": "What is the albedo attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute albedo", "output": "The albedo attribute of a ZPlane contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a ZPlane instance." }, { "instruction": "What is the periodic_surface attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute periodic_surface", "output": "The periodic_surface attribute of a ZPlane contains if a periodic boundary condition is used, the surface with which this one is periodic with. It's a openmc.Surface value that you can access after creating a ZPlane instance." }, { "instruction": "What is the coefficients attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute coefficients", "output": "The coefficients attribute of a ZPlane contains dictionary of surface coefficients. It's a dict value that you can access after creating a ZPlane instance." }, { "instruction": "What is the id attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute id", "output": "The id attribute of a ZPlane contains unique identifier for the surface. It's a int value that you can access after creating a ZPlane instance." }, { "instruction": "What is the name attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute name", "output": "The name attribute of a ZPlane contains name of the surface. It's a str value that you can access after creating a ZPlane instance." }, { "instruction": "What is the type attribute of a ZPlane?", "input": "OpenMC Python API ZPlane attribute type", "output": "The type attribute of a ZPlane contains type of the surface. It's a str value that you can access after creating a ZPlane instance." }, { "instruction": "How do you call the __init__() method in the ZPlane class?", "input": "OpenMC Python API ZPlane.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, z0: Any). It takes 2 parameters." }, { "instruction": "How do you call the evaluate() method in the ZPlane class?", "input": "OpenMC Python API ZPlane.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the QuadricMixin class in OpenMC's Python API?", "input": "OpenMC Python API QuadricMixin class", "output": "The QuadricMixin class represents a mixin class implementing common functionality for quadric surfaces. It provides 7 methods and 0 properties for working with quadricmixin data in OpenMC." }, { "instruction": "What does the QuadricMixin class do in OpenMC's Python API?", "input": "OpenMC Python API QuadricMixin class description", "output": "The QuadricMixin class a mixin class implementing common functionality for quadric surfaces. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the _origin() method in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin._origin() method signature", "output": "To call the _origin() method, use: @property def _origin(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _axis() method in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin._axis() method signature", "output": "To call the _axis() method, use: @property def _axis(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_Abc() method do in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.get_Abc() method", "output": "The get_Abc() method compute matrix, vector, and scalar coefficients for this surface or for a specified set of coefficients. It's used for quadricmixin operations." }, { "instruction": "How do you call the get_Abc() method in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.get_Abc() method signature", "output": "To call the get_Abc() method, use: def get_Abc(self: Any, coeffs: Any). It takes 2 parameters." }, { "instruction": "What does the coeffs parameter do in the get_Abc() method?", "input": "OpenMC Python API QuadricMixin.get_Abc() parameter coeffs", "output": "The coeffs parameter tuple of coefficients from which to compute the quadric elements. if none are supplied the coefficients of this surface will be used.. It should be a tuple, optional value." }, { "instruction": "What does the eigh() method do in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.eigh() method", "output": "The eigh() method wrapper method for returning eigenvalues and eigenvectors of this quadric surface which is used for transformations. It's used for quadricmixin operations." }, { "instruction": "How do you call the eigh() method in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.eigh() method signature", "output": "To call the eigh() method, use: def eigh(self: Any, coeffs: Any). It takes 2 parameters." }, { "instruction": "What does the coeffs parameter do in the eigh() method?", "input": "OpenMC Python API QuadricMixin.eigh() parameter coeffs", "output": "The coeffs parameter tuple of coefficients from which to compute the quadric elements. if none are supplied the coefficients of this surface will be used.. It should be a tuple, optional value." }, { "instruction": "What does the evaluate() method do in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.evaluate() method", "output": "The evaluate() method evaluate the surface equation at a given point. It's used for quadricmixin operations." }, { "instruction": "How do you call the evaluate() method in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the evaluate() method?", "input": "OpenMC Python API QuadricMixin.evaluate() parameter point", "output": "The point parameter the cartesian coordinates, :math:`(x',y',z')`, in [cm] at which the surface equation should be evaluated.. It should be a 3-tuple of float value." }, { "instruction": "What does the translate() method do in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.translate() method", "output": "The translate() method translate surface in given direction. It's used for quadricmixin operations." }, { "instruction": "How do you call the translate() method in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.translate() method signature", "output": "To call the translate() method, use: def translate(self: Any, vector: Any, inplace: Any). It takes 3 parameters." }, { "instruction": "What does the vector parameter do in the translate() method?", "input": "OpenMC Python API QuadricMixin.translate() parameter vector", "output": "The vector parameter direction in which surface should be translated. It should be a iterable of float value." }, { "instruction": "What does the inplace parameter do in the translate() method?", "input": "OpenMC Python API QuadricMixin.translate() parameter inplace", "output": "The inplace parameter whether to return a clone of the surface or the surface itself.. It should be a bool value." }, { "instruction": "How do you call the rotate() method in the QuadricMixin class?", "input": "OpenMC Python API QuadricMixin.rotate() method signature", "output": "To call the rotate() method, use: def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any). It takes 5 parameters." }, { "instruction": "What is the Cylinder class in OpenMC's Python API?", "input": "OpenMC Python API Cylinder class", "output": "The Cylinder class represents a cylinder with radius r, centered on the point (x0, y0, z0) with an axis specified by the line through points (x0, y0, z0) and (x0+dx, y0+dy, z0+dz). It provides 6 methods and 0 properties for working with cylinder data in OpenMC." }, { "instruction": "What does the Cylinder class do in OpenMC's Python API?", "input": "OpenMC Python API Cylinder class description", "output": "The Cylinder class a cylinder with radius r, centered on the point (x0, y0, z0) with an axis specified by the line through points (x0, y0, z0) and (x0+dx, y0+dy, z0+dz). It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter x0", "output": "When creating a Cylinder, the x0 parameter specifies x-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter y0", "output": "When creating a Cylinder, the y0 parameter specifies y-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter z0", "output": "When creating a Cylinder, the z0 parameter specifies z-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the r parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter r", "output": "When creating a Cylinder, the r parameter specifies radius of the cylinder in [cm]. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the dx parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter dx", "output": "When creating a Cylinder, the dx parameter specifies x-component of the vector representing the axis of the cylinder. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the dy parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter dy", "output": "When creating a Cylinder, the dy parameter specifies y-component of the vector representing the axis of the cylinder. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the dz parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter dz", "output": "When creating a Cylinder, the dz parameter specifies z-component of the vector representing the axis of the cylinder. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter boundary_type", "output": "When creating a Cylinder, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter albedo", "output": "When creating a Cylinder, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter name", "output": "When creating a Cylinder, the name parameter specifies name of the cylinder. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a Cylinder?", "input": "OpenMC Python API Cylinder constructor parameter surface_id", "output": "When creating a Cylinder, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute x0", "output": "The x0 attribute of a Cylinder contains x-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the y0 attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute y0", "output": "The y0 attribute of a Cylinder contains y-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the z0 attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute z0", "output": "The z0 attribute of a Cylinder contains z-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the r attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute r", "output": "The r attribute of a Cylinder contains radius of the cylinder in [cm]. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the dx attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute dx", "output": "The dx attribute of a Cylinder contains x-component of the vector representing the axis of the cylinder. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the dy attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute dy", "output": "The dy attribute of a Cylinder contains y-component of the vector representing the axis of the cylinder. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the dz attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute dz", "output": "The dz attribute of a Cylinder contains z-component of the vector representing the axis of the cylinder. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the boundary_type attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute boundary_type", "output": "The boundary_type attribute of a Cylinder contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a Cylinder instance." }, { "instruction": "What is the albedo attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute albedo", "output": "The albedo attribute of a Cylinder contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a Cylinder instance." }, { "instruction": "What is the coefficients attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute coefficients", "output": "The coefficients attribute of a Cylinder contains dictionary of surface coefficients. It's a dict value that you can access after creating a Cylinder instance." }, { "instruction": "What is the id attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute id", "output": "The id attribute of a Cylinder contains unique identifier for the surface. It's a int value that you can access after creating a Cylinder instance." }, { "instruction": "What is the name attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute name", "output": "The name attribute of a Cylinder contains name of the surface. It's a str value that you can access after creating a Cylinder instance." }, { "instruction": "What is the type attribute of a Cylinder?", "input": "OpenMC Python API Cylinder attribute type", "output": "The type attribute of a Cylinder contains type of the surface. It's a str value that you can access after creating a Cylinder instance." }, { "instruction": "How do you call the __init__() method in the Cylinder class?", "input": "OpenMC Python API Cylinder.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r: Any, dx: Any, dy: Any, dz: Any). It takes 8 parameters." }, { "instruction": "How do you call the __subclasshook__() method in the Cylinder class?", "input": "OpenMC Python API Cylinder.__subclasshook__() method signature", "output": "To call the __subclasshook__() method, use: @classmethod def __subclasshook__(cls: Any, c: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the Cylinder class?", "input": "OpenMC Python API Cylinder.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the Cylinder class?", "input": "OpenMC Python API Cylinder._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_points() method do in the Cylinder class?", "input": "OpenMC Python API Cylinder.from_points() method", "output": "The from_points() method return a cylinder given points that define the axis and a radius. .. versionadded:: 0.12. It's used for cylinder operations." }, { "instruction": "How do you call the from_points() method in the Cylinder class?", "input": "OpenMC Python API Cylinder.from_points() method signature", "output": "To call the from_points() method, use: @classmethod def from_points(cls: Any, p1: Any, p2: Any, r: Any). It takes 4 parameters." }, { "instruction": "What does the r parameter do in the from_points() method?", "input": "OpenMC Python API Cylinder.from_points() parameter r", "output": "The r parameter radius of the cylinder in [cm]. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the kwargs parameter do in the from_points() method?", "input": "OpenMC Python API Cylinder.from_points() parameter kwargs", "output": "The kwargs parameter keyword arguments passed to the :class:`cylinder` constructor. It should be a dict value." }, { "instruction": "What does the to_xml_element() method do in the Cylinder class?", "input": "OpenMC Python API Cylinder.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the surface. It's used for cylinder operations." }, { "instruction": "How do you call the to_xml_element() method in the Cylinder class?", "input": "OpenMC Python API Cylinder.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Cylinder class?", "input": "OpenMC Python API Cylinder.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What is the XCylinder class in OpenMC's Python API?", "input": "OpenMC Python API XCylinder class", "output": "The XCylinder class represents an infinite cylinder whose length is parallel to the x-axis of the form :math:`(y - y_0)^2 + (z - z_0)^2 = r^2`. It provides 4 methods and 0 properties for working with xcylinder data in OpenMC." }, { "instruction": "What does the XCylinder class do in OpenMC's Python API?", "input": "OpenMC Python API XCylinder class description", "output": "The XCylinder class an infinite cylinder whose length is parallel to the x-axis of the form :math:`(y - y_0)^2 + (z - z_0)^2 = r^2`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the y0 parameter do when creating a XCylinder?", "input": "OpenMC Python API XCylinder constructor parameter y0", "output": "When creating a XCylinder, the y0 parameter specifies y-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a XCylinder?", "input": "OpenMC Python API XCylinder constructor parameter z0", "output": "When creating a XCylinder, the z0 parameter specifies z-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the r parameter do when creating a XCylinder?", "input": "OpenMC Python API XCylinder constructor parameter r", "output": "When creating a XCylinder, the r parameter specifies radius of the cylinder in [cm]. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a XCylinder?", "input": "OpenMC Python API XCylinder constructor parameter boundary_type", "output": "When creating a XCylinder, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a XCylinder?", "input": "OpenMC Python API XCylinder constructor parameter albedo", "output": "When creating a XCylinder, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a XCylinder?", "input": "OpenMC Python API XCylinder constructor parameter name", "output": "When creating a XCylinder, the name parameter specifies name of the cylinder. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a XCylinder?", "input": "OpenMC Python API XCylinder constructor parameter surface_id", "output": "When creating a XCylinder, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the y0 attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute y0", "output": "The y0 attribute of a XCylinder contains y-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a XCylinder instance." }, { "instruction": "What is the z0 attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute z0", "output": "The z0 attribute of a XCylinder contains z-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a XCylinder instance." }, { "instruction": "What is the r attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute r", "output": "The r attribute of a XCylinder contains radius of the cylinder in [cm]. It's a float value that you can access after creating a XCylinder instance." }, { "instruction": "What is the boundary_type attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute boundary_type", "output": "The boundary_type attribute of a XCylinder contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a XCylinder instance." }, { "instruction": "What is the albedo attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute albedo", "output": "The albedo attribute of a XCylinder contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a XCylinder instance." }, { "instruction": "What is the coefficients attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute coefficients", "output": "The coefficients attribute of a XCylinder contains dictionary of surface coefficients. It's a dict value that you can access after creating a XCylinder instance." }, { "instruction": "What is the id attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute id", "output": "The id attribute of a XCylinder contains unique identifier for the surface. It's a int value that you can access after creating a XCylinder instance." }, { "instruction": "What is the name attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute name", "output": "The name attribute of a XCylinder contains name of the surface. It's a str value that you can access after creating a XCylinder instance." }, { "instruction": "What is the type attribute of a XCylinder?", "input": "OpenMC Python API XCylinder attribute type", "output": "The type attribute of a XCylinder contains type of the surface. It's a str value that you can access after creating a XCylinder instance." }, { "instruction": "How do you call the __init__() method in the XCylinder class?", "input": "OpenMC Python API XCylinder.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, y0: Any, z0: Any, r: Any). It takes 4 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the XCylinder class?", "input": "OpenMC Python API XCylinder._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the XCylinder class?", "input": "OpenMC Python API XCylinder.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "How do you call the evaluate() method in the XCylinder class?", "input": "OpenMC Python API XCylinder.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the YCylinder class in OpenMC's Python API?", "input": "OpenMC Python API YCylinder class", "output": "The YCylinder class represents an infinite cylinder whose length is parallel to the y-axis of the form :math:`(x - x_0)^2 + (z - z_0)^2 = r^2`. It provides 4 methods and 0 properties for working with ycylinder data in OpenMC." }, { "instruction": "What does the YCylinder class do in OpenMC's Python API?", "input": "OpenMC Python API YCylinder class description", "output": "The YCylinder class an infinite cylinder whose length is parallel to the y-axis of the form :math:`(x - x_0)^2 + (z - z_0)^2 = r^2`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a YCylinder?", "input": "OpenMC Python API YCylinder constructor parameter x0", "output": "When creating a YCylinder, the x0 parameter specifies x-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a YCylinder?", "input": "OpenMC Python API YCylinder constructor parameter z0", "output": "When creating a YCylinder, the z0 parameter specifies z-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the r parameter do when creating a YCylinder?", "input": "OpenMC Python API YCylinder constructor parameter r", "output": "When creating a YCylinder, the r parameter specifies radius of the cylinder in [cm]. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a YCylinder?", "input": "OpenMC Python API YCylinder constructor parameter boundary_type", "output": "When creating a YCylinder, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a YCylinder?", "input": "OpenMC Python API YCylinder constructor parameter albedo", "output": "When creating a YCylinder, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a YCylinder?", "input": "OpenMC Python API YCylinder constructor parameter name", "output": "When creating a YCylinder, the name parameter specifies name of the cylinder. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a YCylinder?", "input": "OpenMC Python API YCylinder constructor parameter surface_id", "output": "When creating a YCylinder, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute x0", "output": "The x0 attribute of a YCylinder contains x-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a YCylinder instance." }, { "instruction": "What is the z0 attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute z0", "output": "The z0 attribute of a YCylinder contains z-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a YCylinder instance." }, { "instruction": "What is the r attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute r", "output": "The r attribute of a YCylinder contains radius of the cylinder in [cm]. It's a float value that you can access after creating a YCylinder instance." }, { "instruction": "What is the boundary_type attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute boundary_type", "output": "The boundary_type attribute of a YCylinder contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a YCylinder instance." }, { "instruction": "What is the albedo attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute albedo", "output": "The albedo attribute of a YCylinder contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a YCylinder instance." }, { "instruction": "What is the coefficients attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute coefficients", "output": "The coefficients attribute of a YCylinder contains dictionary of surface coefficients. It's a dict value that you can access after creating a YCylinder instance." }, { "instruction": "What is the id attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute id", "output": "The id attribute of a YCylinder contains unique identifier for the surface. It's a int value that you can access after creating a YCylinder instance." }, { "instruction": "What is the name attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute name", "output": "The name attribute of a YCylinder contains name of the surface. It's a str value that you can access after creating a YCylinder instance." }, { "instruction": "What is the type attribute of a YCylinder?", "input": "OpenMC Python API YCylinder attribute type", "output": "The type attribute of a YCylinder contains type of the surface. It's a str value that you can access after creating a YCylinder instance." }, { "instruction": "How do you call the __init__() method in the YCylinder class?", "input": "OpenMC Python API YCylinder.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, z0: Any, r: Any). It takes 4 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the YCylinder class?", "input": "OpenMC Python API YCylinder._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the YCylinder class?", "input": "OpenMC Python API YCylinder.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "How do you call the evaluate() method in the YCylinder class?", "input": "OpenMC Python API YCylinder.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the ZCylinder class in OpenMC's Python API?", "input": "OpenMC Python API ZCylinder class", "output": "The ZCylinder class represents an infinite cylinder whose length is parallel to the z-axis of the form :math:`(x - x_0)^2 + (y - y_0)^2 = r^2`. It provides 4 methods and 0 properties for working with zcylinder data in OpenMC." }, { "instruction": "What does the ZCylinder class do in OpenMC's Python API?", "input": "OpenMC Python API ZCylinder class description", "output": "The ZCylinder class an infinite cylinder whose length is parallel to the z-axis of the form :math:`(x - x_0)^2 + (y - y_0)^2 = r^2`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a ZCylinder?", "input": "OpenMC Python API ZCylinder constructor parameter x0", "output": "When creating a ZCylinder, the x0 parameter specifies x-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a ZCylinder?", "input": "OpenMC Python API ZCylinder constructor parameter y0", "output": "When creating a ZCylinder, the y0 parameter specifies y-coordinate for the origin of the cylinder in [cm]. defaults to 0. It should be a float, optional value." }, { "instruction": "What does the r parameter do when creating a ZCylinder?", "input": "OpenMC Python API ZCylinder constructor parameter r", "output": "When creating a ZCylinder, the r parameter specifies radius of the cylinder in [cm]. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a ZCylinder?", "input": "OpenMC Python API ZCylinder constructor parameter boundary_type", "output": "When creating a ZCylinder, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a ZCylinder?", "input": "OpenMC Python API ZCylinder constructor parameter albedo", "output": "When creating a ZCylinder, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a ZCylinder?", "input": "OpenMC Python API ZCylinder constructor parameter name", "output": "When creating a ZCylinder, the name parameter specifies name of the cylinder. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a ZCylinder?", "input": "OpenMC Python API ZCylinder constructor parameter surface_id", "output": "When creating a ZCylinder, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute x0", "output": "The x0 attribute of a ZCylinder contains x-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the y0 attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute y0", "output": "The y0 attribute of a ZCylinder contains y-coordinate for the origin of the cylinder in [cm]. It's a float value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the r attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute r", "output": "The r attribute of a ZCylinder contains radius of the cylinder in [cm]. It's a float value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the boundary_type attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute boundary_type", "output": "The boundary_type attribute of a ZCylinder contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the albedo attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute albedo", "output": "The albedo attribute of a ZCylinder contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the coefficients attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute coefficients", "output": "The coefficients attribute of a ZCylinder contains dictionary of surface coefficients. It's a dict value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the id attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute id", "output": "The id attribute of a ZCylinder contains unique identifier for the surface. It's a int value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the name attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute name", "output": "The name attribute of a ZCylinder contains name of the surface. It's a str value that you can access after creating a ZCylinder instance." }, { "instruction": "What is the type attribute of a ZCylinder?", "input": "OpenMC Python API ZCylinder attribute type", "output": "The type attribute of a ZCylinder contains type of the surface. It's a str value that you can access after creating a ZCylinder instance." }, { "instruction": "How do you call the __init__() method in the ZCylinder class?", "input": "OpenMC Python API ZCylinder.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, r: Any). It takes 4 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the ZCylinder class?", "input": "OpenMC Python API ZCylinder._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the ZCylinder class?", "input": "OpenMC Python API ZCylinder.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "How do you call the evaluate() method in the ZCylinder class?", "input": "OpenMC Python API ZCylinder.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the Sphere class in OpenMC's Python API?", "input": "OpenMC Python API Sphere class", "output": "The Sphere class represents a sphere of the form :math:`(x - x_0)^2 + (y - y_0)^2 + (z - z_0)^2 = r^2`. It provides 4 methods and 0 properties for working with sphere data in OpenMC." }, { "instruction": "What does the Sphere class do in OpenMC's Python API?", "input": "OpenMC Python API Sphere class description", "output": "The Sphere class a sphere of the form :math:`(x - x_0)^2 + (y - y_0)^2 + (z - z_0)^2 = r^2`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter x0", "output": "When creating a Sphere, the x0 parameter specifies x-coordinate of the center of the sphere in [cm]. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter y0", "output": "When creating a Sphere, the y0 parameter specifies y-coordinate of the center of the sphere in [cm]. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter z0", "output": "When creating a Sphere, the z0 parameter specifies z-coordinate of the center of the sphere in [cm]. defaults to 0.. It should be a float, optional value." }, { "instruction": "What does the r parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter r", "output": "When creating a Sphere, the r parameter specifies radius of the sphere in [cm]. defaults to 1.. It should be a float, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter boundary_type", "output": "When creating a Sphere, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter albedo", "output": "When creating a Sphere, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter name", "output": "When creating a Sphere, the name parameter specifies name of the sphere. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a Sphere?", "input": "OpenMC Python API Sphere constructor parameter surface_id", "output": "When creating a Sphere, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute x0", "output": "The x0 attribute of a Sphere contains x-coordinate of the center of the sphere in [cm]. It's a float value that you can access after creating a Sphere instance." }, { "instruction": "What is the y0 attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute y0", "output": "The y0 attribute of a Sphere contains y-coordinate of the center of the sphere in [cm]. It's a float value that you can access after creating a Sphere instance." }, { "instruction": "What is the z0 attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute z0", "output": "The z0 attribute of a Sphere contains z-coordinate of the center of the sphere in [cm]. It's a float value that you can access after creating a Sphere instance." }, { "instruction": "What is the r attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute r", "output": "The r attribute of a Sphere contains radius of the sphere in [cm]. It's a float value that you can access after creating a Sphere instance." }, { "instruction": "What is the boundary_type attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute boundary_type", "output": "The boundary_type attribute of a Sphere contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a Sphere instance." }, { "instruction": "What is the albedo attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute albedo", "output": "The albedo attribute of a Sphere contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a Sphere instance." }, { "instruction": "What is the coefficients attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute coefficients", "output": "The coefficients attribute of a Sphere contains dictionary of surface coefficients. It's a dict value that you can access after creating a Sphere instance." }, { "instruction": "What is the id attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute id", "output": "The id attribute of a Sphere contains unique identifier for the surface. It's a int value that you can access after creating a Sphere instance." }, { "instruction": "What is the name attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute name", "output": "The name attribute of a Sphere contains name of the surface. It's a str value that you can access after creating a Sphere instance." }, { "instruction": "What is the type attribute of a Sphere?", "input": "OpenMC Python API Sphere attribute type", "output": "The type attribute of a Sphere contains type of the surface. It's a str value that you can access after creating a Sphere instance." }, { "instruction": "How do you call the __init__() method in the Sphere class?", "input": "OpenMC Python API Sphere.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r: Any). It takes 5 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the Sphere class?", "input": "OpenMC Python API Sphere._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the Sphere class?", "input": "OpenMC Python API Sphere.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "How do you call the evaluate() method in the Sphere class?", "input": "OpenMC Python API Sphere.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the Cone class in OpenMC's Python API?", "input": "OpenMC Python API Cone class", "output": "The Cone class represents a conical surface parallel to the x-, y-, or z-axis. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.xconeonesided`, :class:`~openmc.model.yconeonesided`, and :class:`~openmc.model.zconeonesided`. It provides 4 methods and 0 properties for working with cone data in OpenMC." }, { "instruction": "What does the Cone class do in OpenMC's Python API?", "input": "OpenMC Python API Cone class description", "output": "The Cone class a conical surface parallel to the x-, y-, or z-axis. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.xconeonesided`, :class:`~openmc.model.yconeonesided`, and :class:`~openmc.model.zconeonesided`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter x0", "output": "When creating a Cone, the x0 parameter specifies x-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter y0", "output": "When creating a Cone, the y0 parameter specifies y-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter z0", "output": "When creating a Cone, the z0 parameter specifies z-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the r2 parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter r2", "output": "When creating a Cone, the r2 parameter specifies the square of the slope of the cone. it is defined as :math:`\\left(\\frac{r}{h}\\right)^2` for a radius, :math:`r` and an axial. It should be a float, optional value." }, { "instruction": "What does the distance parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter distance", "output": "When creating a Cone, the distance parameter specifies to take the square of the radius of the cone (in cm) 1 cm from the apex.. It should be a math:`h` from the apex. An easy way to define this quantity is value." }, { "instruction": "What does the dx parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter dx", "output": "When creating a Cone, the dx parameter specifies x-component of the vector representing the axis of the cone.. It should be a float, optional value." }, { "instruction": "What does the dy parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter dy", "output": "When creating a Cone, the dy parameter specifies y-component of the vector representing the axis of the cone.. It should be a float, optional value." }, { "instruction": "What does the dz parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter dz", "output": "When creating a Cone, the dz parameter specifies z-component of the vector representing the axis of the cone.. It should be a float, optional value." }, { "instruction": "What does the surface_id parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter surface_id", "output": "When creating a Cone, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What does the boundary_type parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter boundary_type", "output": "When creating a Cone, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter albedo", "output": "When creating a Cone, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a Cone?", "input": "OpenMC Python API Cone constructor parameter name", "output": "When creating a Cone, the name parameter specifies name of the cone. if not specified, the name will be the empty string.. It should be a str value." }, { "instruction": "What is the x0 attribute of a Cone?", "input": "OpenMC Python API Cone attribute x0", "output": "The x0 attribute of a Cone contains x-coordinate of the apex in [cm]. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the y0 attribute of a Cone?", "input": "OpenMC Python API Cone attribute y0", "output": "The y0 attribute of a Cone contains y-coordinate of the apex in [cm]. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the z0 attribute of a Cone?", "input": "OpenMC Python API Cone attribute z0", "output": "The z0 attribute of a Cone contains z-coordinate of the apex in [cm]. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the r2 attribute of a Cone?", "input": "OpenMC Python API Cone attribute r2", "output": "The r2 attribute of a Cone contains parameter related to the aperture. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the dx attribute of a Cone?", "input": "OpenMC Python API Cone attribute dx", "output": "The dx attribute of a Cone contains x-component of the vector representing the axis of the cone.. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the dy attribute of a Cone?", "input": "OpenMC Python API Cone attribute dy", "output": "The dy attribute of a Cone contains y-component of the vector representing the axis of the cone.. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the dz attribute of a Cone?", "input": "OpenMC Python API Cone attribute dz", "output": "The dz attribute of a Cone contains z-component of the vector representing the axis of the cone.. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the boundary_type attribute of a Cone?", "input": "OpenMC Python API Cone attribute boundary_type", "output": "The boundary_type attribute of a Cone contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a Cone instance." }, { "instruction": "What is the albedo attribute of a Cone?", "input": "OpenMC Python API Cone attribute albedo", "output": "The albedo attribute of a Cone contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a Cone instance." }, { "instruction": "What is the coefficients attribute of a Cone?", "input": "OpenMC Python API Cone attribute coefficients", "output": "The coefficients attribute of a Cone contains dictionary of surface coefficients. It's a dict value that you can access after creating a Cone instance." }, { "instruction": "What is the id attribute of a Cone?", "input": "OpenMC Python API Cone attribute id", "output": "The id attribute of a Cone contains unique identifier for the surface. It's a int value that you can access after creating a Cone instance." }, { "instruction": "What is the name attribute of a Cone?", "input": "OpenMC Python API Cone attribute name", "output": "The name attribute of a Cone contains name of the surface. It's a str value that you can access after creating a Cone instance." }, { "instruction": "What is the type attribute of a Cone?", "input": "OpenMC Python API Cone attribute type", "output": "The type attribute of a Cone contains type of the surface. It's a str value that you can access after creating a Cone instance." }, { "instruction": "How do you call the __init__() method in the Cone class?", "input": "OpenMC Python API Cone.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r2: Any, dx: Any, dy: Any, dz: Any). It takes 8 parameters." }, { "instruction": "How do you call the __subclasshook__() method in the Cone class?", "input": "OpenMC Python API Cone.__subclasshook__() method signature", "output": "To call the __subclasshook__() method, use: @classmethod def __subclasshook__(cls: Any, c: Any). It takes 2 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the Cone class?", "input": "OpenMC Python API Cone._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method do in the Cone class?", "input": "OpenMC Python API Cone.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the surface. It's used for cone operations." }, { "instruction": "How do you call the to_xml_element() method in the Cone class?", "input": "OpenMC Python API Cone.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Cone class?", "input": "OpenMC Python API Cone.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing source data. The return type is lxml.etree._Element." }, { "instruction": "What is the XCone class in OpenMC's Python API?", "input": "OpenMC Python API XCone class", "output": "The XCone class represents a cone parallel to the x-axis of the form :math:`(y - y_0)^2 + (z - z_0)^2 = r^2 (x - x_0)^2`. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.xconeonesided`. It provides 3 methods and 0 properties for working with xcone data in OpenMC." }, { "instruction": "What does the XCone class do in OpenMC's Python API?", "input": "OpenMC Python API XCone class description", "output": "The XCone class a cone parallel to the x-axis of the form :math:`(y - y_0)^2 + (z - z_0)^2 = r^2 (x - x_0)^2`. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.xconeonesided`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter x0", "output": "When creating a XCone, the x0 parameter specifies x-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter y0", "output": "When creating a XCone, the y0 parameter specifies y-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter z0", "output": "When creating a XCone, the z0 parameter specifies z-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the r2 parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter r2", "output": "When creating a XCone, the r2 parameter specifies the square of the slope of the cone. it is defined as :math:`\\left(\\frac{r}{h}\\right)^2` for a radius, :math:`r` and an axial. It should be a float, optional value." }, { "instruction": "What does the distance parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter distance", "output": "When creating a XCone, the distance parameter specifies to take the square of the radius of the cone (in cm) 1 cm from the apex.. It should be a math:`h` from the apex. An easy way to define this quantity is value." }, { "instruction": "What does the boundary_type parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter boundary_type", "output": "When creating a XCone, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter albedo", "output": "When creating a XCone, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter name", "output": "When creating a XCone, the name parameter specifies name of the cone. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a XCone?", "input": "OpenMC Python API XCone constructor parameter surface_id", "output": "When creating a XCone, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a XCone?", "input": "OpenMC Python API XCone attribute x0", "output": "The x0 attribute of a XCone contains x-coordinate of the apex in [cm]. It's a float value that you can access after creating a XCone instance." }, { "instruction": "What is the y0 attribute of a XCone?", "input": "OpenMC Python API XCone attribute y0", "output": "The y0 attribute of a XCone contains y-coordinate of the apex in [cm]. It's a float value that you can access after creating a XCone instance." }, { "instruction": "What is the z0 attribute of a XCone?", "input": "OpenMC Python API XCone attribute z0", "output": "The z0 attribute of a XCone contains z-coordinate of the apex in [cm]. It's a float value that you can access after creating a XCone instance." }, { "instruction": "What is the r2 attribute of a XCone?", "input": "OpenMC Python API XCone attribute r2", "output": "The r2 attribute of a XCone contains parameter related to the aperture. It's a float value that you can access after creating a XCone instance." }, { "instruction": "What is the boundary_type attribute of a XCone?", "input": "OpenMC Python API XCone attribute boundary_type", "output": "The boundary_type attribute of a XCone contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a XCone instance." }, { "instruction": "What is the albedo attribute of a XCone?", "input": "OpenMC Python API XCone attribute albedo", "output": "The albedo attribute of a XCone contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a XCone instance." }, { "instruction": "What is the coefficients attribute of a XCone?", "input": "OpenMC Python API XCone attribute coefficients", "output": "The coefficients attribute of a XCone contains dictionary of surface coefficients. It's a dict value that you can access after creating a XCone instance." }, { "instruction": "What is the id attribute of a XCone?", "input": "OpenMC Python API XCone attribute id", "output": "The id attribute of a XCone contains unique identifier for the surface. It's a int value that you can access after creating a XCone instance." }, { "instruction": "What is the name attribute of a XCone?", "input": "OpenMC Python API XCone attribute name", "output": "The name attribute of a XCone contains name of the surface. It's a str value that you can access after creating a XCone instance." }, { "instruction": "What is the type attribute of a XCone?", "input": "OpenMC Python API XCone attribute type", "output": "The type attribute of a XCone contains type of the surface. It's a str value that you can access after creating a XCone instance." }, { "instruction": "How do you call the __init__() method in the XCone class?", "input": "OpenMC Python API XCone.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r2: Any). It takes 5 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the XCone class?", "input": "OpenMC Python API XCone._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the evaluate() method in the XCone class?", "input": "OpenMC Python API XCone.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the YCone class in OpenMC's Python API?", "input": "OpenMC Python API YCone class", "output": "The YCone class represents a cone parallel to the y-axis of the form :math:`(x - x_0)^2 + (z - z_0)^2 = r^2 (y - y_0)^2`. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.yconeonesided`. It provides 3 methods and 0 properties for working with ycone data in OpenMC." }, { "instruction": "What does the YCone class do in OpenMC's Python API?", "input": "OpenMC Python API YCone class description", "output": "The YCone class a cone parallel to the y-axis of the form :math:`(x - x_0)^2 + (z - z_0)^2 = r^2 (y - y_0)^2`. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.yconeonesided`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter x0", "output": "When creating a YCone, the x0 parameter specifies x-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter y0", "output": "When creating a YCone, the y0 parameter specifies y-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter z0", "output": "When creating a YCone, the z0 parameter specifies z-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the r2 parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter r2", "output": "When creating a YCone, the r2 parameter specifies the square of the slope of the cone. it is defined as :math:`\\left(\\frac{r}{h}\\right)^2` for a radius, :math:`r` and an axial. It should be a float, optional value." }, { "instruction": "What does the distance parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter distance", "output": "When creating a YCone, the distance parameter specifies to take the square of the radius of the cone (in cm) 1 cm from the apex.. It should be a math:`h` from the apex. An easy way to define this quantity is value." }, { "instruction": "What does the boundary_type parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter boundary_type", "output": "When creating a YCone, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter albedo", "output": "When creating a YCone, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter name", "output": "When creating a YCone, the name parameter specifies name of the cone. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a YCone?", "input": "OpenMC Python API YCone constructor parameter surface_id", "output": "When creating a YCone, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a YCone?", "input": "OpenMC Python API YCone attribute x0", "output": "The x0 attribute of a YCone contains x-coordinate of the apex in [cm]. It's a float value that you can access after creating a YCone instance." }, { "instruction": "What is the y0 attribute of a YCone?", "input": "OpenMC Python API YCone attribute y0", "output": "The y0 attribute of a YCone contains y-coordinate of the apex in [cm]. It's a float value that you can access after creating a YCone instance." }, { "instruction": "What is the z0 attribute of a YCone?", "input": "OpenMC Python API YCone attribute z0", "output": "The z0 attribute of a YCone contains z-coordinate of the apex in [cm]. It's a float value that you can access after creating a YCone instance." }, { "instruction": "What is the r2 attribute of a YCone?", "input": "OpenMC Python API YCone attribute r2", "output": "The r2 attribute of a YCone contains parameter related to the aperture. It's a float value that you can access after creating a YCone instance." }, { "instruction": "What is the boundary_type attribute of a YCone?", "input": "OpenMC Python API YCone attribute boundary_type", "output": "The boundary_type attribute of a YCone contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a YCone instance." }, { "instruction": "What is the albedo attribute of a YCone?", "input": "OpenMC Python API YCone attribute albedo", "output": "The albedo attribute of a YCone contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a YCone instance." }, { "instruction": "What is the coefficients attribute of a YCone?", "input": "OpenMC Python API YCone attribute coefficients", "output": "The coefficients attribute of a YCone contains dictionary of surface coefficients. It's a dict value that you can access after creating a YCone instance." }, { "instruction": "What is the id attribute of a YCone?", "input": "OpenMC Python API YCone attribute id", "output": "The id attribute of a YCone contains unique identifier for the surface. It's a int value that you can access after creating a YCone instance." }, { "instruction": "What is the name attribute of a YCone?", "input": "OpenMC Python API YCone attribute name", "output": "The name attribute of a YCone contains name of the surface. It's a str value that you can access after creating a YCone instance." }, { "instruction": "What is the type attribute of a YCone?", "input": "OpenMC Python API YCone attribute type", "output": "The type attribute of a YCone contains type of the surface. It's a str value that you can access after creating a YCone instance." }, { "instruction": "How do you call the __init__() method in the YCone class?", "input": "OpenMC Python API YCone.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r2: Any). It takes 5 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the YCone class?", "input": "OpenMC Python API YCone._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the evaluate() method in the YCone class?", "input": "OpenMC Python API YCone.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the ZCone class in OpenMC's Python API?", "input": "OpenMC Python API ZCone class", "output": "The ZCone class represents a cone parallel to the z-axis of the form :math:`(x - x_0)^2 + (y - y_0)^2 = r^2 (z - z_0)^2`. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.zconeonesided`. It provides 3 methods and 0 properties for working with zcone data in OpenMC." }, { "instruction": "What does the ZCone class do in OpenMC's Python API?", "input": "OpenMC Python API ZCone class description", "output": "The ZCone class a cone parallel to the z-axis of the form :math:`(x - x_0)^2 + (y - y_0)^2 = r^2 (z - z_0)^2`. .. note:: this creates a double cone, which is two one-sided cones that meet at their apex. for a one-sided cone see :class:`~openmc.model.zconeonesided`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter x0", "output": "When creating a ZCone, the x0 parameter specifies x-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the y0 parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter y0", "output": "When creating a ZCone, the y0 parameter specifies y-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the z0 parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter z0", "output": "When creating a ZCone, the z0 parameter specifies z-coordinate of the apex in [cm].. It should be a float, optional value." }, { "instruction": "What does the r2 parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter r2", "output": "When creating a ZCone, the r2 parameter specifies the square of the slope of the cone. it is defined as :math:`\\left(\\frac{r}{h}\\right)^2` for a radius, :math:`r` and an axial. It should be a float, optional value." }, { "instruction": "What does the distance parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter distance", "output": "When creating a ZCone, the distance parameter specifies to take the square of the radius of the cone (in cm) 1 cm from the apex.. It should be a math:`h` from the apex. An easy way to define this quantity is value." }, { "instruction": "What does the boundary_type parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter boundary_type", "output": "When creating a ZCone, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter albedo", "output": "When creating a ZCone, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter name", "output": "When creating a ZCone, the name parameter specifies name of the cone. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a ZCone?", "input": "OpenMC Python API ZCone constructor parameter surface_id", "output": "When creating a ZCone, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the x0 attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute x0", "output": "The x0 attribute of a ZCone contains x-coordinate of the apex in [cm]. It's a float value that you can access after creating a ZCone instance." }, { "instruction": "What is the y0 attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute y0", "output": "The y0 attribute of a ZCone contains y-coordinate of the apex in [cm]. It's a float value that you can access after creating a ZCone instance." }, { "instruction": "What is the z0 attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute z0", "output": "The z0 attribute of a ZCone contains z-coordinate of the apex in [cm]. It's a float value that you can access after creating a ZCone instance." }, { "instruction": "What is the r2 attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute r2", "output": "The r2 attribute of a ZCone contains parameter related to the aperture.. It's a float value that you can access after creating a ZCone instance." }, { "instruction": "What is the boundary_type attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute boundary_type", "output": "The boundary_type attribute of a ZCone contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a ZCone instance." }, { "instruction": "What is the albedo attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute albedo", "output": "The albedo attribute of a ZCone contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a ZCone instance." }, { "instruction": "What is the coefficients attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute coefficients", "output": "The coefficients attribute of a ZCone contains dictionary of surface coefficients. It's a dict value that you can access after creating a ZCone instance." }, { "instruction": "What is the id attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute id", "output": "The id attribute of a ZCone contains unique identifier for the surface. It's a int value that you can access after creating a ZCone instance." }, { "instruction": "What is the name attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute name", "output": "The name attribute of a ZCone contains name of the surface. It's a str value that you can access after creating a ZCone instance." }, { "instruction": "What is the type attribute of a ZCone?", "input": "OpenMC Python API ZCone attribute type", "output": "The type attribute of a ZCone contains type of the surface. It's a str value that you can access after creating a ZCone instance." }, { "instruction": "How do you call the __init__() method in the ZCone class?", "input": "OpenMC Python API ZCone.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, r2: Any). It takes 5 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the ZCone class?", "input": "OpenMC Python API ZCone._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the evaluate() method in the ZCone class?", "input": "OpenMC Python API ZCone.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What is the Quadric class in OpenMC's Python API?", "input": "OpenMC Python API Quadric class", "output": "The Quadric class represents a surface of the form :math:`ax^2 + by^2 + cz^2 + dxy + eyz + fxz + gx + hy + jz + k = 0`. It provides 2 methods and 0 properties for working with quadric data in OpenMC." }, { "instruction": "What does the Quadric class do in OpenMC's Python API?", "input": "OpenMC Python API Quadric class description", "output": "The Quadric class a surface of the form :math:`ax^2 + by^2 + cz^2 + dxy + eyz + fxz + gx + hy + jz + k = 0`. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the boundary_type parameter do when creating a Quadric?", "input": "OpenMC Python API Quadric constructor parameter boundary_type", "output": "When creating a Quadric, the boundary_type parameter specifies boundary condition that defines the behavior for particles hitting the surface. defaults to transmissive boundary condition where particles freely pass through the surface.. It should be a {'transmission', 'vacuum', 'reflective', 'white'}, optional value." }, { "instruction": "What does the albedo parameter do when creating a Quadric?", "input": "OpenMC Python API Quadric constructor parameter albedo", "output": "When creating a Quadric, the albedo parameter specifies albedo of the surfaces as a ratio of particle weight after interaction with the surface to the initial weight. values must be positive. only applicable if the boundary type is 'reflective', 'periodic', or 'white'.. It should be a float, optional value." }, { "instruction": "What does the name parameter do when creating a Quadric?", "input": "OpenMC Python API Quadric constructor parameter name", "output": "When creating a Quadric, the name parameter specifies name of the surface. if not specified, the name will be the empty string.. It should be a str, optional value." }, { "instruction": "What does the surface_id parameter do when creating a Quadric?", "input": "OpenMC Python API Quadric constructor parameter surface_id", "output": "When creating a Quadric, the surface_id parameter specifies unique identifier for the surface. if not specified, an identifier will automatically be assigned.. It should be a int, optional value." }, { "instruction": "What is the boundary_type attribute of a Quadric?", "input": "OpenMC Python API Quadric attribute boundary_type", "output": "The boundary_type attribute of a Quadric contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a Quadric instance." }, { "instruction": "What is the albedo attribute of a Quadric?", "input": "OpenMC Python API Quadric attribute albedo", "output": "The albedo attribute of a Quadric contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a Quadric instance." }, { "instruction": "What is the coefficients attribute of a Quadric?", "input": "OpenMC Python API Quadric attribute coefficients", "output": "The coefficients attribute of a Quadric contains dictionary of surface coefficients. It's a dict value that you can access after creating a Quadric instance." }, { "instruction": "What is the id attribute of a Quadric?", "input": "OpenMC Python API Quadric attribute id", "output": "The id attribute of a Quadric contains unique identifier for the surface. It's a int value that you can access after creating a Quadric instance." }, { "instruction": "What is the name attribute of a Quadric?", "input": "OpenMC Python API Quadric attribute name", "output": "The name attribute of a Quadric contains name of the surface. It's a str value that you can access after creating a Quadric instance." }, { "instruction": "What is the type attribute of a Quadric?", "input": "OpenMC Python API Quadric attribute type", "output": "The type attribute of a Quadric contains type of the surface. It's a str value that you can access after creating a Quadric instance." }, { "instruction": "How do you call the __init__() method in the Quadric class?", "input": "OpenMC Python API Quadric.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, a: Any, b: Any, c: Any, d: Any, e: Any, f: Any, g: Any, h: Any, j: Any, k: Any). It takes 11 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the Quadric class?", "input": "OpenMC Python API Quadric._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "What is the TorusMixin class in OpenMC's Python API?", "input": "OpenMC Python API TorusMixin class", "output": "The TorusMixin class represents a mixin class implementing common functionality for torus surfaces. It provides 4 methods and 0 properties for working with torusmixin data in OpenMC." }, { "instruction": "What does the TorusMixin class do in OpenMC's Python API?", "input": "OpenMC Python API TorusMixin class description", "output": "The TorusMixin class a mixin class implementing common functionality for torus surfaces. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "How do you call the __init__() method in the TorusMixin class?", "input": "OpenMC Python API TorusMixin.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, x0: Any, y0: Any, z0: Any, a: Any, b: Any, c: Any). It takes 7 parameters." }, { "instruction": "How do you call the translate() method in the TorusMixin class?", "input": "OpenMC Python API TorusMixin.translate() method signature", "output": "To call the translate() method, use: def translate(self: Any, vector: Any, inplace: Any). It takes 3 parameters." }, { "instruction": "How do you call the rotate() method in the TorusMixin class?", "input": "OpenMC Python API TorusMixin.rotate() method signature", "output": "To call the rotate() method, use: def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any). It takes 5 parameters." }, { "instruction": "How do you call the _get_base_coeffs() method in the TorusMixin class?", "input": "OpenMC Python API TorusMixin._get_base_coeffs() method signature", "output": "To call the _get_base_coeffs() method, use: def _get_base_coeffs(self: Any). It takes 1 parameters." }, { "instruction": "What is the XTorus class in OpenMC's Python API?", "input": "OpenMC Python API XTorus class", "output": "The XTorus class represents a torus of the form :math:`(x - x_0)^2/b^2 + (\\sqrt{(y - y_0)^2 + (z - z_0)^2} - a)^2/c^2 - 1 = 0`. .. versionadded:: 0.13.0. It provides 2 methods and 0 properties for working with xtorus data in OpenMC." }, { "instruction": "What does the XTorus class do in OpenMC's Python API?", "input": "OpenMC Python API XTorus class description", "output": "The XTorus class a torus of the form :math:`(x - x_0)^2/b^2 + (\\sqrt{(y - y_0)^2 + (z - z_0)^2} - a)^2/c^2 - 1 = 0`. .. versionadded:: 0.13.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a XTorus?", "input": "OpenMC Python API XTorus constructor parameter x0", "output": "When creating a XTorus, the x0 parameter specifies x-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the y0 parameter do when creating a XTorus?", "input": "OpenMC Python API XTorus constructor parameter y0", "output": "When creating a XTorus, the y0 parameter specifies y-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the z0 parameter do when creating a XTorus?", "input": "OpenMC Python API XTorus constructor parameter z0", "output": "When creating a XTorus, the z0 parameter specifies z-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the a parameter do when creating a XTorus?", "input": "OpenMC Python API XTorus constructor parameter a", "output": "When creating a XTorus, the a parameter specifies major radius of the torus in [cm]. It should be a float value." }, { "instruction": "What does the b parameter do when creating a XTorus?", "input": "OpenMC Python API XTorus constructor parameter b", "output": "When creating a XTorus, the b parameter specifies minor radius of the torus in [cm] (parallel to axis of revolution). It should be a float value." }, { "instruction": "What does the c parameter do when creating a XTorus?", "input": "OpenMC Python API XTorus constructor parameter c", "output": "When creating a XTorus, the c parameter specifies minor radius of the torus in [cm] (perpendicular to axis of revolution). It should be a float value." }, { "instruction": "What does the kwargs parameter do when creating a XTorus?", "input": "OpenMC Python API XTorus constructor parameter kwargs", "output": "When creating a XTorus, the kwargs parameter specifies keyword arguments passed to the :class:`surface` constructor. It should be a dict value." }, { "instruction": "What is the x0 attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute x0", "output": "The x0 attribute of a XTorus contains x-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a XTorus instance." }, { "instruction": "What is the y0 attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute y0", "output": "The y0 attribute of a XTorus contains y-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a XTorus instance." }, { "instruction": "What is the z0 attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute z0", "output": "The z0 attribute of a XTorus contains z-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a XTorus instance." }, { "instruction": "What is the a attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute a", "output": "The a attribute of a XTorus contains major radius of the torus in [cm]. It's a float value that you can access after creating a XTorus instance." }, { "instruction": "What is the b attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute b", "output": "The b attribute of a XTorus contains minor radius of the torus in [cm] (parallel to axis of revolution). It's a float value that you can access after creating a XTorus instance." }, { "instruction": "What is the c attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute c", "output": "The c attribute of a XTorus contains minor radius of the torus in [cm] (perpendicular to axis of revolution). It's a float value that you can access after creating a XTorus instance." }, { "instruction": "What is the boundary_type attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute boundary_type", "output": "The boundary_type attribute of a XTorus contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a XTorus instance." }, { "instruction": "What is the albedo attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute albedo", "output": "The albedo attribute of a XTorus contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a XTorus instance." }, { "instruction": "What is the coefficients attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute coefficients", "output": "The coefficients attribute of a XTorus contains dictionary of surface coefficients. It's a dict value that you can access after creating a XTorus instance." }, { "instruction": "What is the id attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute id", "output": "The id attribute of a XTorus contains unique identifier for the surface. It's a int value that you can access after creating a XTorus instance." }, { "instruction": "What is the name attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute name", "output": "The name attribute of a XTorus contains name of the surface. It's a str value that you can access after creating a XTorus instance." }, { "instruction": "What is the type attribute of a XTorus?", "input": "OpenMC Python API XTorus attribute type", "output": "The type attribute of a XTorus contains type of the surface. It's a str value that you can access after creating a XTorus instance." }, { "instruction": "How do you call the evaluate() method in the XTorus class?", "input": "OpenMC Python API XTorus.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the XTorus class?", "input": "OpenMC Python API XTorus.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "What is the YTorus class in OpenMC's Python API?", "input": "OpenMC Python API YTorus class", "output": "The YTorus class represents a torus of the form :math:`(y - y_0)^2/b^2 + (\\sqrt{(x - x_0)^2 + (z - z_0)^2} - a)^2/c^2 - 1 = 0`. .. versionadded:: 0.13.0. It provides 2 methods and 0 properties for working with ytorus data in OpenMC." }, { "instruction": "What does the YTorus class do in OpenMC's Python API?", "input": "OpenMC Python API YTorus class description", "output": "The YTorus class a torus of the form :math:`(y - y_0)^2/b^2 + (\\sqrt{(x - x_0)^2 + (z - z_0)^2} - a)^2/c^2 - 1 = 0`. .. versionadded:: 0.13.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a YTorus?", "input": "OpenMC Python API YTorus constructor parameter x0", "output": "When creating a YTorus, the x0 parameter specifies x-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the y0 parameter do when creating a YTorus?", "input": "OpenMC Python API YTorus constructor parameter y0", "output": "When creating a YTorus, the y0 parameter specifies y-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the z0 parameter do when creating a YTorus?", "input": "OpenMC Python API YTorus constructor parameter z0", "output": "When creating a YTorus, the z0 parameter specifies z-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the a parameter do when creating a YTorus?", "input": "OpenMC Python API YTorus constructor parameter a", "output": "When creating a YTorus, the a parameter specifies major radius of the torus in [cm]. It should be a float value." }, { "instruction": "What does the b parameter do when creating a YTorus?", "input": "OpenMC Python API YTorus constructor parameter b", "output": "When creating a YTorus, the b parameter specifies minor radius of the torus in [cm] (parallel to axis of revolution). It should be a float value." }, { "instruction": "What does the c parameter do when creating a YTorus?", "input": "OpenMC Python API YTorus constructor parameter c", "output": "When creating a YTorus, the c parameter specifies minor radius of the torus in [cm] (perpendicular to axis of revolution). It should be a float value." }, { "instruction": "What does the kwargs parameter do when creating a YTorus?", "input": "OpenMC Python API YTorus constructor parameter kwargs", "output": "When creating a YTorus, the kwargs parameter specifies keyword arguments passed to the :class:`surface` constructor. It should be a dict value." }, { "instruction": "What is the x0 attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute x0", "output": "The x0 attribute of a YTorus contains x-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a YTorus instance." }, { "instruction": "What is the y0 attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute y0", "output": "The y0 attribute of a YTorus contains y-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a YTorus instance." }, { "instruction": "What is the z0 attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute z0", "output": "The z0 attribute of a YTorus contains z-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a YTorus instance." }, { "instruction": "What is the a attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute a", "output": "The a attribute of a YTorus contains major radius of the torus in [cm]. It's a float value that you can access after creating a YTorus instance." }, { "instruction": "What is the b attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute b", "output": "The b attribute of a YTorus contains minor radius of the torus in [cm] (parallel to axis of revolution). It's a float value that you can access after creating a YTorus instance." }, { "instruction": "What is the c attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute c", "output": "The c attribute of a YTorus contains minor radius of the torus (perpendicular to axis of revolution). It's a float value that you can access after creating a YTorus instance." }, { "instruction": "What is the boundary_type attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute boundary_type", "output": "The boundary_type attribute of a YTorus contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a YTorus instance." }, { "instruction": "What is the albedo attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute albedo", "output": "The albedo attribute of a YTorus contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a YTorus instance." }, { "instruction": "What is the coefficients attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute coefficients", "output": "The coefficients attribute of a YTorus contains dictionary of surface coefficients. It's a dict value that you can access after creating a YTorus instance." }, { "instruction": "What is the id attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute id", "output": "The id attribute of a YTorus contains unique identifier for the surface. It's a int value that you can access after creating a YTorus instance." }, { "instruction": "What is the name attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute name", "output": "The name attribute of a YTorus contains name of the surface. It's a str value that you can access after creating a YTorus instance." }, { "instruction": "What is the type attribute of a YTorus?", "input": "OpenMC Python API YTorus attribute type", "output": "The type attribute of a YTorus contains type of the surface. It's a str value that you can access after creating a YTorus instance." }, { "instruction": "How do you call the evaluate() method in the YTorus class?", "input": "OpenMC Python API YTorus.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the YTorus class?", "input": "OpenMC Python API YTorus.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "What is the ZTorus class in OpenMC's Python API?", "input": "OpenMC Python API ZTorus class", "output": "The ZTorus class represents a torus of the form :math:`(z - z_0)^2/b^2 + (\\sqrt{(x - x_0)^2 + (y - y_0)^2} - a)^2/c^2 - 1 = 0`. .. versionadded:: 0.13.0. It provides 2 methods and 0 properties for working with ztorus data in OpenMC." }, { "instruction": "What does the ZTorus class do in OpenMC's Python API?", "input": "OpenMC Python API ZTorus class description", "output": "The ZTorus class a torus of the form :math:`(z - z_0)^2/b^2 + (\\sqrt{(x - x_0)^2 + (y - y_0)^2} - a)^2/c^2 - 1 = 0`. .. versionadded:: 0.13.0. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the x0 parameter do when creating a ZTorus?", "input": "OpenMC Python API ZTorus constructor parameter x0", "output": "When creating a ZTorus, the x0 parameter specifies x-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the y0 parameter do when creating a ZTorus?", "input": "OpenMC Python API ZTorus constructor parameter y0", "output": "When creating a ZTorus, the y0 parameter specifies y-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the z0 parameter do when creating a ZTorus?", "input": "OpenMC Python API ZTorus constructor parameter z0", "output": "When creating a ZTorus, the z0 parameter specifies z-coordinate of the center of the axis of revolution in [cm]. It should be a float value." }, { "instruction": "What does the a parameter do when creating a ZTorus?", "input": "OpenMC Python API ZTorus constructor parameter a", "output": "When creating a ZTorus, the a parameter specifies major radius of the torus in [cm]. It should be a float value." }, { "instruction": "What does the b parameter do when creating a ZTorus?", "input": "OpenMC Python API ZTorus constructor parameter b", "output": "When creating a ZTorus, the b parameter specifies minor radius of the torus in [cm] (parallel to axis of revolution). It should be a float value." }, { "instruction": "What does the c parameter do when creating a ZTorus?", "input": "OpenMC Python API ZTorus constructor parameter c", "output": "When creating a ZTorus, the c parameter specifies minor radius of the torus in [cm] (perpendicular to axis of revolution). It should be a float value." }, { "instruction": "What does the kwargs parameter do when creating a ZTorus?", "input": "OpenMC Python API ZTorus constructor parameter kwargs", "output": "When creating a ZTorus, the kwargs parameter specifies keyword arguments passed to the :class:`surface` constructor. It should be a dict value." }, { "instruction": "What is the x0 attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute x0", "output": "The x0 attribute of a ZTorus contains x-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a ZTorus instance." }, { "instruction": "What is the y0 attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute y0", "output": "The y0 attribute of a ZTorus contains y-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a ZTorus instance." }, { "instruction": "What is the z0 attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute z0", "output": "The z0 attribute of a ZTorus contains z-coordinate of the center of the axis of revolution in [cm]. It's a float value that you can access after creating a ZTorus instance." }, { "instruction": "What is the a attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute a", "output": "The a attribute of a ZTorus contains major radius of the torus in [cm]. It's a float value that you can access after creating a ZTorus instance." }, { "instruction": "What is the b attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute b", "output": "The b attribute of a ZTorus contains minor radius of the torus in [cm] (parallel to axis of revolution). It's a float value that you can access after creating a ZTorus instance." }, { "instruction": "What is the c attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute c", "output": "The c attribute of a ZTorus contains minor radius of the torus in [cm] (perpendicular to axis of revolution). It's a float value that you can access after creating a ZTorus instance." }, { "instruction": "What is the boundary_type attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute boundary_type", "output": "The boundary_type attribute of a ZTorus contains boundary condition that defines the behavior for particles hitting the surface.. It's a {'transmission', 'vacuum', 'reflective', 'white'} value that you can access after creating a ZTorus instance." }, { "instruction": "What is the albedo attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute albedo", "output": "The albedo attribute of a ZTorus contains boundary albedo as a positive multiplier of particle weight. It's a float value that you can access after creating a ZTorus instance." }, { "instruction": "What is the coefficients attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute coefficients", "output": "The coefficients attribute of a ZTorus contains dictionary of surface coefficients. It's a dict value that you can access after creating a ZTorus instance." }, { "instruction": "What is the id attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute id", "output": "The id attribute of a ZTorus contains unique identifier for the surface. It's a int value that you can access after creating a ZTorus instance." }, { "instruction": "What is the name attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute name", "output": "The name attribute of a ZTorus contains name of the surface. It's a str value that you can access after creating a ZTorus instance." }, { "instruction": "What is the type attribute of a ZTorus?", "input": "OpenMC Python API ZTorus attribute type", "output": "The type attribute of a ZTorus contains type of the surface. It's a str value that you can access after creating a ZTorus instance." }, { "instruction": "How do you call the evaluate() method in the ZTorus class?", "input": "OpenMC Python API ZTorus.evaluate() method signature", "output": "To call the evaluate() method, use: def evaluate(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the ZTorus class?", "input": "OpenMC Python API ZTorus.bounding_box() method signature", "output": "To call the bounding_box() method, use: def bounding_box(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "What is the Halfspace class in OpenMC's Python API?", "input": "OpenMC Python API Halfspace class", "output": "The Halfspace class represents a positive or negative half-space region. a half-space is either of the two parts into which a two-dimension surface divides the three-dimensional euclidean space. if the equation of the surface is :math:`f(x,y,z) = 0`, the region for which :math:`f(x,y,z) < 0` is referred to as the negative half-space and the region for which :math:`f(x,y,z) > 0` is referred to as the positive half-space. instances of halfspace are generally not instantiated directly. rather, they can be created from an existing surface through the __neg__ and __pos__ operators, as the following example demonstrates: >>> sphere = openmc.sphere(surface_id=1, r=10.0) >>> inside_sphere = -sphere >>> outside_sphere = +sphere >>> type(inside_sphere) . It provides 16 methods and 0 properties for working with halfspace data in OpenMC." }, { "instruction": "What does the Halfspace class do in OpenMC's Python API?", "input": "OpenMC Python API Halfspace class description", "output": "The Halfspace class a positive or negative half-space region. a half-space is either of the two parts into which a two-dimension surface divides the three-dimensional euclidean space. if the equation of the surface is :math:`f(x,y,z) = 0`, the region for which :math:`f(x,y,z) < 0` is referred to as the negative half-space and the region for which :math:`f(x,y,z) > 0` is referred to as the positive half-space. instances of halfspace are generally not instantiated directly. rather, they can be created from an existing surface through the __neg__ and __pos__ operators, as the following example demonstrates: >>> sphere = openmc.sphere(surface_id=1, r=10.0) >>> inside_sphere = -sphere >>> outside_sphere = +sphere >>> type(inside_sphere) . It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the surface parameter do when creating a Halfspace?", "input": "OpenMC Python API Halfspace constructor parameter surface", "output": "When creating a Halfspace, the surface parameter specifies surface which divides euclidean space.. It should be a openmc.Surface value." }, { "instruction": "What does the side parameter do when creating a Halfspace?", "input": "OpenMC Python API Halfspace constructor parameter side", "output": "When creating a Halfspace, the side parameter specifies indicates whether the positive or negative half-space is used.. It should be a {'+', '-'} value." }, { "instruction": "What is the surface attribute of a Halfspace?", "input": "OpenMC Python API Halfspace attribute surface", "output": "The surface attribute of a Halfspace contains surface which divides euclidean space.. It's a openmc.Surface value that you can access after creating a Halfspace instance." }, { "instruction": "What is the side attribute of a Halfspace?", "input": "OpenMC Python API Halfspace attribute side", "output": "The side attribute of a Halfspace contains indicates whether the positive or negative half-space is used.. It's a {'+', '-'} value that you can access after creating a Halfspace instance." }, { "instruction": "What is the bounding_box attribute of a Halfspace?", "input": "OpenMC Python API Halfspace attribute bounding_box", "output": "The bounding_box attribute of a Halfspace contains lower-left and upper-right coordinates of an axis-aligned bounding box. It's a openmc.BoundingBox value that you can access after creating a Halfspace instance." }, { "instruction": "How do you call the __init__() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, surface: Any, side: Any). It takes 3 parameters." }, { "instruction": "How do you call the __and__() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.__and__() method signature", "output": "To call the __and__() method, use: def __and__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __or__() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.__or__() method signature", "output": "To call the __or__() method, use: def __or__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __invert__() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.__invert__() method signature", "output": "To call the __invert__() method, use: def __invert__(self: Any). It takes 1 parameters." }, { "instruction": "What does the __contains__() method do in the Halfspace class?", "input": "OpenMC Python API Halfspace.__contains__() method", "output": "The __contains__() method check whether a point is contained in the half-space. It's used for halfspace operations." }, { "instruction": "How do you call the __contains__() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.__contains__() method signature", "output": "To call the __contains__() method, use: def __contains__(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the __contains__() method?", "input": "OpenMC Python API Halfspace.__contains__() parameter point", "output": "The point parameter cartesian coordinates, :math:`(x',y',z')`, of the point. It should be a 3-tuple of float value." }, { "instruction": "How do you call the surface() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.surface() method signature", "output": "To call the surface() method, use: @property def surface(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the surface() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.surface() method signature", "output": "To call the surface() method, use: @surface.setter def surface(self: Any, surface: Any). It takes 2 parameters." }, { "instruction": "How do you call the side() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.side() method signature", "output": "To call the side() method, use: @property def side(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the side() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.side() method signature", "output": "To call the side() method, use: @side.setter def side(self: Any, side: Any). It takes 2 parameters." }, { "instruction": "How do you call the bounding_box() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __str__() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.__str__() method signature", "output": "To call the __str__() method, use: def __str__(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_surfaces() method do in the Halfspace class?", "input": "OpenMC Python API Halfspace.get_surfaces() method", "output": "The get_surfaces() method returns the surface that this is a halfspace of. It's used for halfspace operations." }, { "instruction": "How do you call the get_surfaces() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.get_surfaces() method signature", "output": "To call the get_surfaces() method, use: def get_surfaces(self: Any, surfaces: Any). It takes 2 parameters." }, { "instruction": "What does the surfaces parameter do in the get_surfaces() method?", "input": "OpenMC Python API Halfspace.get_surfaces() parameter surfaces", "output": "The surfaces parameter dictionary mapping surface ids to :class:`openmc.surface` instances. It should be a dict, optional value." }, { "instruction": "What does the get_surfaces() method return in the Halfspace class?", "input": "OpenMC Python API Halfspace.get_surfaces() return value", "output": "The get_surfaces() method returns dictionary mapping surface ids to :class:`openmc.surface` instances. The return type is dict." }, { "instruction": "What does the remove_redundant_surfaces() method do in the Halfspace class?", "input": "OpenMC Python API Halfspace.remove_redundant_surfaces() method", "output": "The remove_redundant_surfaces() method recursively remove all redundant surfaces referenced by this region. It's used for halfspace operations." }, { "instruction": "How do you call the remove_redundant_surfaces() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.remove_redundant_surfaces() method signature", "output": "To call the remove_redundant_surfaces() method, use: def remove_redundant_surfaces(self: Any, redundant_surfaces: Any). It takes 2 parameters." }, { "instruction": "What does the redundant_surfaces parameter do in the remove_redundant_surfaces() method?", "input": "OpenMC Python API Halfspace.remove_redundant_surfaces() parameter redundant_surfaces", "output": "The redundant_surfaces parameter dictionary mapping redundant surface ids to surface ids for the :class:`openmc.surface` instances that should replace them.. It should be a dict value." }, { "instruction": "What does the clone() method do in the Halfspace class?", "input": "OpenMC Python API Halfspace.clone() method", "output": "The clone() method create a copy of this halfspace, with a cloned surface with a unique id. It's used for halfspace operations." }, { "instruction": "How do you call the clone() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the memo parameter do in the clone() method?", "input": "OpenMC Python API Halfspace.clone() parameter memo", "output": "The memo parameter a nested dictionary of previously cloned objects. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the clone() method return in the Halfspace class?", "input": "OpenMC Python API Halfspace.clone() return value", "output": "The clone() method returns the clone of this halfspace. The return type is openmc.Halfspace." }, { "instruction": "What does the translate() method do in the Halfspace class?", "input": "OpenMC Python API Halfspace.translate() method", "output": "The translate() method translate half-space in given direction. It's used for halfspace operations." }, { "instruction": "How do you call the translate() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.translate() method signature", "output": "To call the translate() method, use: def translate(self: Any, vector: Any, inplace: Any, memo: Any). It takes 4 parameters." }, { "instruction": "What does the vector parameter do in the translate() method?", "input": "OpenMC Python API Halfspace.translate() parameter vector", "output": "The vector parameter direction in which region should be translated. It should be a iterable of float value." }, { "instruction": "What does the memo parameter do in the translate() method?", "input": "OpenMC Python API Halfspace.translate() parameter memo", "output": "The memo parameter dictionary used for memoization. It should be a dict or None value." }, { "instruction": "What does the rotate() method do in the Halfspace class?", "input": "OpenMC Python API Halfspace.rotate() method", "output": "The rotate() method rotate surface by angles provided or by applying matrix directly. .. versionadded:: 0.12. It's used for halfspace operations." }, { "instruction": "How do you call the rotate() method in the Halfspace class?", "input": "OpenMC Python API Halfspace.rotate() method signature", "output": "To call the rotate() method, use: def rotate(self: Any, rotation: Any, pivot: Any, order: Any, inplace: Any, memo: Any). It takes 6 parameters." }, { "instruction": "What does the rotation parameter do in the rotate() method?", "input": "OpenMC Python API Halfspace.rotate() parameter rotation", "output": "The rotation parameter a 3-tuple of angles :math:`(\\phi, \\theta, \\psi)` in degrees where the first element is the rotation about the x-axis in the fixed laboratory frame, the second element is the rotation about the y-axis in the fixed laboratory frame, and the third element is the rotation about the z-axis in the fixed laboratory frame. the rotations are active rotations. additionally a 3x3 rotation matrix can be specified directly either as a nested iterable or array.. It should be a 3-tuple of float, or 3x3 iterable value." }, { "instruction": "What does the pivot parameter do in the rotate() method?", "input": "OpenMC Python API Halfspace.rotate() parameter pivot", "output": "The pivot parameter (x, y, z) coordinates for the point to rotate about. defaults to (0., 0., 0.). It should be a iterable of float, optional value." }, { "instruction": "What does the order parameter do in the rotate() method?", "input": "OpenMC Python API Halfspace.rotate() parameter order", "output": "The order parameter a string of 'x', 'y', and 'z' in some order specifying which rotation to perform first, second, and third. defaults to 'xyz' which means, the rotation by angle :math:`\\phi` about x will be applied first, followed by :math:`\\theta` about y and then :math:`\\psi` about z. this corresponds to an x-y-z extrinsic rotation as well as a z-y'-x'' intrinsic rotation using tait-bryan. It should be a str, optional value." }, { "instruction": "What does the angles parameter do in the rotate() method?", "input": "OpenMC Python API Halfspace.rotate() parameter angles", "output": "The angles parameter . It should be a math:`(\\phi, \\theta, \\psi)`. value." }, { "instruction": "What does the inplace parameter do in the rotate() method?", "input": "OpenMC Python API Halfspace.rotate() parameter inplace", "output": "The inplace parameter whether or not to return a new instance of surface or to modify the coefficients of this surface in place. defaults to false.. It should be a bool value." }, { "instruction": "What does the memo parameter do in the rotate() method?", "input": "OpenMC Python API Halfspace.rotate() parameter memo", "output": "The memo parameter dictionary used for memoization. It should be a dict or None value." }, { "instruction": "How do you call the _future_kwargs_warning_helper() function in OpenMC's Python API?", "input": "OpenMC Python API _future_kwargs_warning_helper() function signature", "output": "To call the _future_kwargs_warning_helper() function, use: def _future_kwargs_warning_helper(cls: Any). It takes 1 parameters." }, { "instruction": "What does the get_rotation_matrix() function do in OpenMC's Python API?", "input": "OpenMC Python API get_rotation_matrix() function", "output": "The get_rotation_matrix() function generate a 3x3 rotation matrix from input angles .. versionadded:: 0.12. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the get_rotation_matrix() function in OpenMC's Python API?", "input": "OpenMC Python API get_rotation_matrix() function purpose", "output": "The get_rotation_matrix() function generate a 3x3 rotation matrix from input angles .. versionadded:: 0.12. It's part of OpenMC's Python API." }, { "instruction": "How do you call the get_rotation_matrix() function in OpenMC's Python API?", "input": "OpenMC Python API get_rotation_matrix() function signature", "output": "To call the get_rotation_matrix() function, use: def get_rotation_matrix(rotation: Any, order: Any). It takes 2 parameters." }, { "instruction": "What does the rotation parameter do in the get_rotation_matrix() function?", "input": "OpenMC Python API get_rotation_matrix() parameter rotation", "output": "The rotation parameter a 3-tuple of angles :math:`(\\phi, \\theta, \\psi)` in degrees where the first element is the rotation about the x-axis in the fixed laboratory frame, the second element is the rotation about the y-axis in the fixed laboratory frame, and the third element is the rotation about the z-axis in the fixed laboratory frame. the rotations are active rotations.. It should be a 3-tuple of float value." }, { "instruction": "What does the order parameter do in the get_rotation_matrix() function?", "input": "OpenMC Python API get_rotation_matrix() parameter order", "output": "The order parameter a string of 'x', 'y', and 'z' in some order specifying which rotation to perform first, second, and third. defaults to 'xyz' which means, the rotation by angle :math:`\\phi` about x will be applied first, followed. It should be a str, optional value." }, { "instruction": "What does the by parameter do in the get_rotation_matrix() function?", "input": "OpenMC Python API get_rotation_matrix() parameter by", "output": "The by parameter corresponds to an x-y-z extrinsic rotation as well as a z-y'-x'' intrinsic rotation using tait-bryan angles :math:`(\\phi, \\theta, \\psi)`.. It should be a math:`\\theta` about y and then :math:`\\psi` about z. This value." }, { "instruction": "What is the Tally class in OpenMC's Python API?", "input": "OpenMC Python API Tally class", "output": "The Tally class represents a tally defined by a set of scores that are accumulated for a list of nuclides given a set of filters. It provides 85 methods and 0 properties for working with tally data in OpenMC." }, { "instruction": "What does the Tally class do in OpenMC's Python API?", "input": "OpenMC Python API Tally class description", "output": "The Tally class a tally defined by a set of scores that are accumulated for a list of nuclides given a set of filters. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the tally_id parameter do when creating a Tally?", "input": "OpenMC Python API Tally constructor parameter tally_id", "output": "When creating a Tally, the tally_id parameter specifies unique identifier for the tally. if none is specified, an identifier will automatically be assigned. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a Tally?", "input": "OpenMC Python API Tally constructor parameter name", "output": "When creating a Tally, the name parameter specifies name of the tally. if not specified, the name is the empty string.. It should be a str, optional value." }, { "instruction": "What is the id attribute of a Tally?", "input": "OpenMC Python API Tally attribute id", "output": "The id attribute of a Tally contains unique identifier for the tally. It's a int value that you can access after creating a Tally instance." }, { "instruction": "What is the name attribute of a Tally?", "input": "OpenMC Python API Tally attribute name", "output": "The name attribute of a Tally contains name of the tally. It's a str value that you can access after creating a Tally instance." }, { "instruction": "What is the multiply_density attribute of a Tally?", "input": "OpenMC Python API Tally attribute multiply_density", "output": "The multiply_density attribute of a Tally contains whether reaction rates should be multiplied by atom density .. versionadded:: 0.14.0. It's a bool value that you can access after creating a Tally instance." }, { "instruction": "What is the filters attribute of a Tally?", "input": "OpenMC Python API Tally attribute filters", "output": "The filters attribute of a Tally contains list of specified filters for the tally. It's a list of openmc.Filter value that you can access after creating a Tally instance." }, { "instruction": "What is the nuclides attribute of a Tally?", "input": "OpenMC Python API Tally attribute nuclides", "output": "The nuclides attribute of a Tally contains list of nuclides to score results for. It's a list of str value that you can access after creating a Tally instance." }, { "instruction": "What is the scores attribute of a Tally?", "input": "OpenMC Python API Tally attribute scores", "output": "The scores attribute of a Tally contains list of defined scores, e.g. 'flux', 'fission', etc.. It's a list of str value that you can access after creating a Tally instance." }, { "instruction": "What is the estimator attribute of a Tally?", "input": "OpenMC Python API Tally attribute estimator", "output": "The estimator attribute of a Tally contains type of estimator for the tally. if unset (none), openmc will automatically select an appropriate estimator based on the tally filters and scores with a preference for 'tracklength'.. It's a {'analog', 'tracklength', 'collision'} value that you can access after creating a Tally instance." }, { "instruction": "What is the triggers attribute of a Tally?", "input": "OpenMC Python API Tally attribute triggers", "output": "The triggers attribute of a Tally contains list of tally triggers. It's a list of openmc.Trigger value that you can access after creating a Tally instance." }, { "instruction": "What is the num_scores attribute of a Tally?", "input": "OpenMC Python API Tally attribute num_scores", "output": "The num_scores attribute of a Tally contains total number of scores. It's a int value that you can access after creating a Tally instance." }, { "instruction": "What is the num_filter_bins attribute of a Tally?", "input": "OpenMC Python API Tally attribute num_filter_bins", "output": "The num_filter_bins attribute of a Tally contains total number of filter bins accounting for all filters. It's a int value that you can access after creating a Tally instance." }, { "instruction": "What is the num_bins attribute of a Tally?", "input": "OpenMC Python API Tally attribute num_bins", "output": "The num_bins attribute of a Tally contains total number of bins for the tally. It's a int value that you can access after creating a Tally instance." }, { "instruction": "What is the shape attribute of a Tally?", "input": "OpenMC Python API Tally attribute shape", "output": "The shape attribute of a Tally contains the shape of the tally data array ordered as the number of filter bins, nuclide bins and score bins. It's a 3-tuple of int value that you can access after creating a Tally instance." }, { "instruction": "What is the filter_strides attribute of a Tally?", "input": "OpenMC Python API Tally attribute filter_strides", "output": "The filter_strides attribute of a Tally contains stride in memory for each filter. It's a list of int value that you can access after creating a Tally instance." }, { "instruction": "What is the num_realizations attribute of a Tally?", "input": "OpenMC Python API Tally attribute num_realizations", "output": "The num_realizations attribute of a Tally contains total number of realizations. It's a int value that you can access after creating a Tally instance." }, { "instruction": "What is the with_summary attribute of a Tally?", "input": "OpenMC Python API Tally attribute with_summary", "output": "The with_summary attribute of a Tally contains whether or not a summary has been linked. It's a bool value that you can access after creating a Tally instance." }, { "instruction": "What is the sum attribute of a Tally?", "input": "OpenMC Python API Tally attribute sum", "output": "The sum attribute of a Tally contains an array containing the sum of each independent realization for each bin. It's a numpy.ndarray value that you can access after creating a Tally instance." }, { "instruction": "What is the sum_sq attribute of a Tally?", "input": "OpenMC Python API Tally attribute sum_sq", "output": "The sum_sq attribute of a Tally contains an array containing the sum of each independent realization squared for each bin. It's a numpy.ndarray value that you can access after creating a Tally instance." }, { "instruction": "What is the mean attribute of a Tally?", "input": "OpenMC Python API Tally attribute mean", "output": "The mean attribute of a Tally contains an array containing the sample mean for each bin. It's a numpy.ndarray value that you can access after creating a Tally instance." }, { "instruction": "What is the std_dev attribute of a Tally?", "input": "OpenMC Python API Tally attribute std_dev", "output": "The std_dev attribute of a Tally contains an array containing the sample standard deviation for each bin. It's a numpy.ndarray value that you can access after creating a Tally instance." }, { "instruction": "What is the derived attribute of a Tally?", "input": "OpenMC Python API Tally attribute derived", "output": "The derived attribute of a Tally contains whether or not the tally is derived from one or more other tallies. It's a bool value that you can access after creating a Tally instance." }, { "instruction": "What is the sparse attribute of a Tally?", "input": "OpenMC Python API Tally attribute sparse", "output": "The sparse attribute of a Tally contains whether or not the tally uses scipy's lil sparse matrix format for compressed data storage. It's a bool value that you can access after creating a Tally instance." }, { "instruction": "What is the derivative attribute of a Tally?", "input": "OpenMC Python API Tally attribute derivative", "output": "The derivative attribute of a Tally contains a material perturbation derivative to apply to all scores in the tally.. It's a openmc.TallyDerivative value that you can access after creating a Tally instance." }, { "instruction": "How do you call the __init__() method in the Tally class?", "input": "OpenMC Python API Tally.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, tally_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the __eq__() method in the Tally class?", "input": "OpenMC Python API Tally.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Tally class?", "input": "OpenMC Python API Tally.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "What does the ensure_results() method do in the Tally class?", "input": "OpenMC Python API Tally.ensure_results() method", "output": "The ensure_results() method a decorator to be applied to any method that might use tally results.\n results will be loaded if appropriate based on the tally properties.\n\n args:\n f function: tally method to wrap\n\n returns:\n function: wrapped function that reads tally results before calling\n the methodif necessary. It's used for tally operations." }, { "instruction": "How do you call the ensure_results() method in the Tally class?", "input": "OpenMC Python API Tally.ensure_results() method signature", "output": "To call the ensure_results() method, use: @staticmethod def ensure_results(f: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Tally class?", "input": "OpenMC Python API Tally.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the Tally class?", "input": "OpenMC Python API Tally.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the multiply_density() method in the Tally class?", "input": "OpenMC Python API Tally.multiply_density() method signature", "output": "To call the multiply_density() method, use: @property def multiply_density(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the multiply_density() method in the Tally class?", "input": "OpenMC Python API Tally.multiply_density() method signature", "output": "To call the multiply_density() method, use: @multiply_density.setter def multiply_density(self: Any, value: Any). It takes 2 parameters." }, { "instruction": "How do you call the filters() method in the Tally class?", "input": "OpenMC Python API Tally.filters() method signature", "output": "To call the filters() method, use: @property def filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the filters() method in the Tally class?", "input": "OpenMC Python API Tally.filters() method signature", "output": "To call the filters() method, use: @filters.setter def filters(self: Any, filters: Any). It takes 2 parameters." }, { "instruction": "How do you call the nuclides() method in the Tally class?", "input": "OpenMC Python API Tally.nuclides() method signature", "output": "To call the nuclides() method, use: @property, @ensure_results def nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclides() method in the Tally class?", "input": "OpenMC Python API Tally.nuclides() method signature", "output": "To call the nuclides() method, use: @nuclides.setter def nuclides(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_nuclides() method in the Tally class?", "input": "OpenMC Python API Tally.num_nuclides() method signature", "output": "To call the num_nuclides() method, use: @property def num_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the Tally class?", "input": "OpenMC Python API Tally.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the Tally class?", "input": "OpenMC Python API Tally.scores() method signature", "output": "To call the scores() method, use: @scores.setter def scores(self: Any, scores: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_scores() method in the Tally class?", "input": "OpenMC Python API Tally.num_scores() method signature", "output": "To call the num_scores() method, use: @property def num_scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_filters() method in the Tally class?", "input": "OpenMC Python API Tally.num_filters() method signature", "output": "To call the num_filters() method, use: @property def num_filters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_filter_bins() method in the Tally class?", "input": "OpenMC Python API Tally.num_filter_bins() method signature", "output": "To call the num_filter_bins() method, use: @property def num_filter_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_bins() method in the Tally class?", "input": "OpenMC Python API Tally.num_bins() method signature", "output": "To call the num_bins() method, use: @property def num_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the shape() method in the Tally class?", "input": "OpenMC Python API Tally.shape() method signature", "output": "To call the shape() method, use: @property def shape(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the estimator() method in the Tally class?", "input": "OpenMC Python API Tally.estimator() method signature", "output": "To call the estimator() method, use: @property def estimator(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the estimator() method in the Tally class?", "input": "OpenMC Python API Tally.estimator() method signature", "output": "To call the estimator() method, use: @estimator.setter def estimator(self: Any, estimator: Any). It takes 2 parameters." }, { "instruction": "How do you call the triggers() method in the Tally class?", "input": "OpenMC Python API Tally.triggers() method signature", "output": "To call the triggers() method, use: @property def triggers(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the triggers() method in the Tally class?", "input": "OpenMC Python API Tally.triggers() method signature", "output": "To call the triggers() method, use: @triggers.setter def triggers(self: Any, triggers: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_realizations() method in the Tally class?", "input": "OpenMC Python API Tally.num_realizations() method signature", "output": "To call the num_realizations() method, use: @property, @ensure_results def num_realizations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the num_realizations() method in the Tally class?", "input": "OpenMC Python API Tally.num_realizations() method signature", "output": "To call the num_realizations() method, use: @num_realizations.setter def num_realizations(self: Any, num_realizations: Any). It takes 2 parameters." }, { "instruction": "How do you call the with_summary() method in the Tally class?", "input": "OpenMC Python API Tally.with_summary() method signature", "output": "To call the with_summary() method, use: @property def with_summary(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the with_summary() method in the Tally class?", "input": "OpenMC Python API Tally.with_summary() method signature", "output": "To call the with_summary() method, use: @with_summary.setter def with_summary(self: Any, with_summary: Any). It takes 2 parameters." }, { "instruction": "How do you call the _read_results() method in the Tally class?", "input": "OpenMC Python API Tally._read_results() method signature", "output": "To call the _read_results() method, use: def _read_results(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sum() method in the Tally class?", "input": "OpenMC Python API Tally.sum() method signature", "output": "To call the sum() method, use: @property, @ensure_results def sum(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sum() method in the Tally class?", "input": "OpenMC Python API Tally.sum() method signature", "output": "To call the sum() method, use: @sum.setter def sum(self: Any, sum: Any). It takes 2 parameters." }, { "instruction": "How do you call the sum_sq() method in the Tally class?", "input": "OpenMC Python API Tally.sum_sq() method signature", "output": "To call the sum_sq() method, use: @property, @ensure_results def sum_sq(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the sum_sq() method in the Tally class?", "input": "OpenMC Python API Tally.sum_sq() method signature", "output": "To call the sum_sq() method, use: @sum_sq.setter def sum_sq(self: Any, sum_sq: Any). It takes 2 parameters." }, { "instruction": "How do you call the mean() method in the Tally class?", "input": "OpenMC Python API Tally.mean() method signature", "output": "To call the mean() method, use: @property def mean(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the std_dev() method in the Tally class?", "input": "OpenMC Python API Tally.std_dev() method signature", "output": "To call the std_dev() method, use: @property def std_dev(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the with_batch_statistics() method in the Tally class?", "input": "OpenMC Python API Tally.with_batch_statistics() method signature", "output": "To call the with_batch_statistics() method, use: @property def with_batch_statistics(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the with_batch_statistics() method in the Tally class?", "input": "OpenMC Python API Tally.with_batch_statistics() method signature", "output": "To call the with_batch_statistics() method, use: @with_batch_statistics.setter def with_batch_statistics(self: Any, with_batch_statistics: Any). It takes 2 parameters." }, { "instruction": "How do you call the derived() method in the Tally class?", "input": "OpenMC Python API Tally.derived() method signature", "output": "To call the derived() method, use: @property def derived(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the derivative() method in the Tally class?", "input": "OpenMC Python API Tally.derivative() method signature", "output": "To call the derivative() method, use: @property def derivative(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the derivative() method in the Tally class?", "input": "OpenMC Python API Tally.derivative() method signature", "output": "To call the derivative() method, use: @derivative.setter def derivative(self: Any, deriv: Any). It takes 2 parameters." }, { "instruction": "How do you call the sparse() method in the Tally class?", "input": "OpenMC Python API Tally.sparse() method signature", "output": "To call the sparse() method, use: @property def sparse(self: Any). It takes 1 parameters." }, { "instruction": "What does the sparse() method do in the Tally class?", "input": "OpenMC Python API Tally.sparse() method", "output": "The sparse() method convert tally data from numpy arrays to scipy list of lists (lil)\n sparse matrices, and vice versa.\n\n this property may be used to reduce the amount of data in memory during\n tally data processing. the tally data will be stored as scipy lil\n matrices internally within the tally object. all tally data access\n properties and methods will return data as a dense numpy array.. It's used for tally operations." }, { "instruction": "How do you call the sparse() method in the Tally class?", "input": "OpenMC Python API Tally.sparse() method signature", "output": "To call the sparse() method, use: @sparse.setter def sparse(self: Any, sparse: Any). It takes 2 parameters." }, { "instruction": "What does the remove_score() method do in the Tally class?", "input": "OpenMC Python API Tally.remove_score() method", "output": "The remove_score() method remove a score from the tally. It's used for tally operations." }, { "instruction": "How do you call the remove_score() method in the Tally class?", "input": "OpenMC Python API Tally.remove_score() method signature", "output": "To call the remove_score() method, use: def remove_score(self: Any, score: Any). It takes 2 parameters." }, { "instruction": "What does the score parameter do in the remove_score() method?", "input": "OpenMC Python API Tally.remove_score() parameter score", "output": "The score parameter score to remove. It should be a str value." }, { "instruction": "What does the remove_filter() method do in the Tally class?", "input": "OpenMC Python API Tally.remove_filter() method", "output": "The remove_filter() method remove a filter from the tally. It's used for tally operations." }, { "instruction": "How do you call the remove_filter() method in the Tally class?", "input": "OpenMC Python API Tally.remove_filter() method signature", "output": "To call the remove_filter() method, use: def remove_filter(self: Any, old_filter: Any). It takes 2 parameters." }, { "instruction": "What does the old_filter parameter do in the remove_filter() method?", "input": "OpenMC Python API Tally.remove_filter() parameter old_filter", "output": "The old_filter parameter filter to remove. It should be a openmc.Filter value." }, { "instruction": "What does the remove_nuclide() method do in the Tally class?", "input": "OpenMC Python API Tally.remove_nuclide() method", "output": "The remove_nuclide() method remove a nuclide from the tally. It's used for tally operations." }, { "instruction": "How do you call the remove_nuclide() method in the Tally class?", "input": "OpenMC Python API Tally.remove_nuclide() method signature", "output": "To call the remove_nuclide() method, use: def remove_nuclide(self: Any, nuclide: Any). It takes 2 parameters." }, { "instruction": "What does the nuclide parameter do in the remove_nuclide() method?", "input": "OpenMC Python API Tally.remove_nuclide() parameter nuclide", "output": "The nuclide parameter nuclide to remove. It should be a str value." }, { "instruction": "What does the _can_merge_filters() method do in the Tally class?", "input": "OpenMC Python API Tally._can_merge_filters() method", "output": "The _can_merge_filters() method determine if another tally's filters can be merged with this one's the types of filters between the two tallies must match identically. the bins in all of the filters must match identically, or be mergeable in only one filter. this is a helper method for the can_merge(...) and merge(...) methods. It's used for tally operations." }, { "instruction": "How do you call the _can_merge_filters() method in the Tally class?", "input": "OpenMC Python API Tally._can_merge_filters() method signature", "output": "To call the _can_merge_filters() method, use: def _can_merge_filters(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the _can_merge_filters() method?", "input": "OpenMC Python API Tally._can_merge_filters() parameter other", "output": "The other parameter tally to check for mergeable filters. It should be a openmc.Tally value." }, { "instruction": "What does the _can_merge_nuclides() method do in the Tally class?", "input": "OpenMC Python API Tally._can_merge_nuclides() method", "output": "The _can_merge_nuclides() method determine if another tally's nuclides can be merged with this one's the nuclides between the two tallies must be mutually exclusive or identically matching. this is a helper method for the can_merge(...) and merge(...) methods. It's used for tally operations." }, { "instruction": "How do you call the _can_merge_nuclides() method in the Tally class?", "input": "OpenMC Python API Tally._can_merge_nuclides() method signature", "output": "To call the _can_merge_nuclides() method, use: def _can_merge_nuclides(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the _can_merge_nuclides() method?", "input": "OpenMC Python API Tally._can_merge_nuclides() parameter other", "output": "The other parameter tally to check for mergeable nuclides. It should be a openmc.Tally value." }, { "instruction": "What does the _can_merge_scores() method do in the Tally class?", "input": "OpenMC Python API Tally._can_merge_scores() method", "output": "The _can_merge_scores() method determine if another tally's scores can be merged with this one's the scores between the two tallies must be mutually exclusive or identically matching. this is a helper method for the can_merge(...) and merge(...) methods. It's used for tally operations." }, { "instruction": "How do you call the _can_merge_scores() method in the Tally class?", "input": "OpenMC Python API Tally._can_merge_scores() method signature", "output": "To call the _can_merge_scores() method, use: def _can_merge_scores(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the _can_merge_scores() method?", "input": "OpenMC Python API Tally._can_merge_scores() parameter other", "output": "The other parameter tally to check for mergeable scores. It should be a openmc.Tally value." }, { "instruction": "What does the can_merge() method do in the Tally class?", "input": "OpenMC Python API Tally.can_merge() method", "output": "The can_merge() method determine if another tally can be merged with this one if results have been loaded from a statepoint, then tallies are only mergeable along one and only one of filter bins, nuclides or scores. It's used for tally operations." }, { "instruction": "How do you call the can_merge() method in the Tally class?", "input": "OpenMC Python API Tally.can_merge() method signature", "output": "To call the can_merge() method, use: def can_merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the can_merge() method?", "input": "OpenMC Python API Tally.can_merge() parameter other", "output": "The other parameter tally to check for merging. It should be a openmc.Tally value." }, { "instruction": "What does the merge() method do in the Tally class?", "input": "OpenMC Python API Tally.merge() method", "output": "The merge() method merge another tally with this one if results have been loaded from a statepoint, then tallies are only mergeable along one and only one of filter bins, nuclides or scores. It's used for tally operations." }, { "instruction": "How do you call the merge() method in the Tally class?", "input": "OpenMC Python API Tally.merge() method signature", "output": "To call the merge() method, use: def merge(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the merge() method?", "input": "OpenMC Python API Tally.merge() parameter other", "output": "The other parameter tally to merge with this one. It should be a openmc.Tally value." }, { "instruction": "What does the merge() method return in the Tally class?", "input": "OpenMC Python API Tally.merge() return value", "output": "The merge() method returns merged tallies. The return type is openmc.Tally." }, { "instruction": "What does the to_xml_element() method do in the Tally class?", "input": "OpenMC Python API Tally.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the tally. It's used for tally operations." }, { "instruction": "How do you call the to_xml_element() method in the Tally class?", "input": "OpenMC Python API Tally.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Tally class?", "input": "OpenMC Python API Tally.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing tally data. The return type is lxml.etree._Element." }, { "instruction": "What does the add_results() method do in the Tally class?", "input": "OpenMC Python API Tally.add_results() method", "output": "The add_results() method add results from the provided statepoint file to this tally instance .. versionadded:: 0.15.1. It's used for tally operations." }, { "instruction": "How do you call the add_results() method in the Tally class?", "input": "OpenMC Python API Tally.add_results() method signature", "output": "To call the add_results() method, use: def add_results(self: Any, statepoint: Any). It takes 2 parameters." }, { "instruction": "What does the statepoint parameter do in the add_results() method?", "input": "OpenMC Python API Tally.add_results() parameter statepoint", "output": "The statepoint parameter statepoint used to update tally results. It should be a openmc.PathLike or openmc.StatePoint value." }, { "instruction": "What does the from_xml_element() method do in the Tally class?", "input": "OpenMC Python API Tally.from_xml_element() method", "output": "The from_xml_element() method generate tally object from an xml element .. versionadded:: 0.13.0. It's used for tally operations." }, { "instruction": "How do you call the from_xml_element() method in the Tally class?", "input": "OpenMC Python API Tally.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Tally.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the contains_filter() method do in the Tally class?", "input": "OpenMC Python API Tally.contains_filter() method", "output": "The contains_filter() method looks for a filter in the tally that matches a specified type. It's used for tally operations." }, { "instruction": "How do you call the contains_filter() method in the Tally class?", "input": "OpenMC Python API Tally.contains_filter() method signature", "output": "To call the contains_filter() method, use: def contains_filter(self: Any, filter_type: Any). It takes 2 parameters." }, { "instruction": "What does the filter_type parameter do in the contains_filter() method?", "input": "OpenMC Python API Tally.contains_filter() parameter filter_type", "output": "The filter_type parameter type of the filter, e.g. meshfilter. It should be a openmc.FilterMeta value." }, { "instruction": "What does the contains_filter() method return in the Tally class?", "input": "OpenMC Python API Tally.contains_filter() return value", "output": "The contains_filter() method returns true if the tally contains a filter of the requested type; otherwise false. The return type is bool." }, { "instruction": "What does the find_filter() method do in the Tally class?", "input": "OpenMC Python API Tally.find_filter() method", "output": "The find_filter() method return a filter in the tally that matches a specified type. It's used for tally operations." }, { "instruction": "How do you call the find_filter() method in the Tally class?", "input": "OpenMC Python API Tally.find_filter() method signature", "output": "To call the find_filter() method, use: def find_filter(self: Any, filter_type: Any). It takes 2 parameters." }, { "instruction": "What does the filter_type parameter do in the find_filter() method?", "input": "OpenMC Python API Tally.find_filter() parameter filter_type", "output": "The filter_type parameter type of the filter, e.g. meshfilter. It should be a openmc.FilterMeta value." }, { "instruction": "What does the find_filter() method return in the Tally class?", "input": "OpenMC Python API Tally.find_filter() return value", "output": "The find_filter() method returns filter from this tally with matching type, or none if no matching filter is found. The return type is openmc.Filter." }, { "instruction": "What does the get_nuclide_index() method do in the Tally class?", "input": "OpenMC Python API Tally.get_nuclide_index() method", "output": "The get_nuclide_index() method returns the index in the tally's results array for a nuclide bin. It's used for tally operations." }, { "instruction": "How do you call the get_nuclide_index() method in the Tally class?", "input": "OpenMC Python API Tally.get_nuclide_index() method signature", "output": "To call the get_nuclide_index() method, use: def get_nuclide_index(self: Any, nuclide: Any). It takes 2 parameters." }, { "instruction": "What does the nuclide parameter do in the get_nuclide_index() method?", "input": "OpenMC Python API Tally.get_nuclide_index() parameter nuclide", "output": "The nuclide parameter the name of the nuclide (e.g., 'h1', 'u238'). It should be a str value." }, { "instruction": "What does the get_nuclide_index() method return in the Tally class?", "input": "OpenMC Python API Tally.get_nuclide_index() return value", "output": "The get_nuclide_index() method returns the index in the tally data array for this nuclide.. The return type is int." }, { "instruction": "What does the get_score_index() method do in the Tally class?", "input": "OpenMC Python API Tally.get_score_index() method", "output": "The get_score_index() method returns the index in the tally's results array for a score bin. It's used for tally operations." }, { "instruction": "How do you call the get_score_index() method in the Tally class?", "input": "OpenMC Python API Tally.get_score_index() method signature", "output": "To call the get_score_index() method, use: def get_score_index(self: Any, score: Any). It takes 2 parameters." }, { "instruction": "What does the score parameter do in the get_score_index() method?", "input": "OpenMC Python API Tally.get_score_index() parameter score", "output": "The score parameter the score string (e.g., 'absorption', 'nu-fission'). It should be a str value." }, { "instruction": "What does the get_score_index() method return in the Tally class?", "input": "OpenMC Python API Tally.get_score_index() return value", "output": "The get_score_index() method returns the index in the tally data array for this score.. The return type is int." }, { "instruction": "What does the get_filter_indices() method do in the Tally class?", "input": "OpenMC Python API Tally.get_filter_indices() method", "output": "The get_filter_indices() method get indices into the filter axis of this tally's data arrays. this is a helper method for the tally.get_values(...) method to extract tally data. this method returns the indices into the filter axis of the tally's data array (axis=0) for particular combinations of filters and their corresponding bins. It's used for tally operations." }, { "instruction": "How do you call the get_filter_indices() method in the Tally class?", "input": "OpenMC Python API Tally.get_filter_indices() method signature", "output": "To call the get_filter_indices() method, use: def get_filter_indices(self: Any, filters: Any, filter_bins: Any). It takes 3 parameters." }, { "instruction": "What does the filters parameter do in the get_filter_indices() method?", "input": "OpenMC Python API Tally.get_filter_indices() parameter filters", "output": "The filters parameter an iterable of filter types (e.g., [meshfilter, energyfilter]; default is []). It should be a Iterable of openmc.FilterMeta value." }, { "instruction": "What does the filter_bins parameter do in the get_filter_indices() method?", "input": "OpenMC Python API Tally.get_filter_indices() parameter filter_bins", "output": "The filter_bins parameter a list of tuples of filter bins corresponding to the filter_types parameter (e.g., [(1,), ((0., 0.625e-6),)]; default is []). each tuple contains bins for the corresponding filter type in the filters parameter. each bin is an integer id for material-, surface-, cell-, cellborn-, and universe- filters. each bin is an integer for the cell instance id for distribcellfilters. each bin is a 2-tuple of floats for energy- and energyout- filters corresponding to the energy boundaries of the bin of interest. the bin is an (x,y,z) 3-tuple for meshfilters corresponding to the mesh cell of interest. the order of the bins in the list must correspond to the filter_types parameter.. It should be a Iterable of tuple value." }, { "instruction": "What does the get_nuclide_indices() method do in the Tally class?", "input": "OpenMC Python API Tally.get_nuclide_indices() method", "output": "The get_nuclide_indices() method get indices into the nuclide axis of this tally's data arrays. this is a helper method for the tally.get_values(...) method to extract tally data. this method returns the indices into the nuclide axis of the tally's data array (axis=1) for one or more nuclides. It's used for tally operations." }, { "instruction": "How do you call the get_nuclide_indices() method in the Tally class?", "input": "OpenMC Python API Tally.get_nuclide_indices() method signature", "output": "To call the get_nuclide_indices() method, use: def get_nuclide_indices(self: Any, nuclides: Any). It takes 2 parameters." }, { "instruction": "What does the nuclides parameter do in the get_nuclide_indices() method?", "input": "OpenMC Python API Tally.get_nuclide_indices() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the get_score_indices() method do in the Tally class?", "input": "OpenMC Python API Tally.get_score_indices() method", "output": "The get_score_indices() method get indices into the score axis of this tally's data arrays. this is a helper method for the tally.get_values(...) method to extract tally data. this method returns the indices into the score axis of the tally's data array (axis=2) for one or more scores. It's used for tally operations." }, { "instruction": "How do you call the get_score_indices() method in the Tally class?", "input": "OpenMC Python API Tally.get_score_indices() method signature", "output": "To call the get_score_indices() method, use: def get_score_indices(self: Any, scores: Any). It takes 2 parameters." }, { "instruction": "What does the scores parameter do in the get_score_indices() method?", "input": "OpenMC Python API Tally.get_score_indices() parameter scores", "output": "The scores parameter a list of one or more score strings (e.g., ['absorption', 'nu-fission']; default is []). It should be a list of str or openmc.CrossScore value." }, { "instruction": "What does the get_values() method do in the Tally class?", "input": "OpenMC Python API Tally.get_values() method", "output": "The get_values() method returns one or more tallied values given a list of scores, filters, filter bins and nuclides. this method constructs a 3d numpy array for the requested tally data indexed by filter bin, nuclide bin, and score index. the method will order the data in the array as specified in the parameter lists. It's used for tally operations." }, { "instruction": "How do you call the get_values() method in the Tally class?", "input": "OpenMC Python API Tally.get_values() method signature", "output": "To call the get_values() method, use: def get_values(self: Any, scores: Any, filters: Any, filter_bins: Any, nuclides: Any, value: Any). It takes 6 parameters." }, { "instruction": "What does the scores parameter do in the get_values() method?", "input": "OpenMC Python API Tally.get_values() parameter scores", "output": "The scores parameter a list of one or more score strings (e.g., ['absorption', 'nu-fission']; default is []). It should be a list of str value." }, { "instruction": "What does the filters parameter do in the get_values() method?", "input": "OpenMC Python API Tally.get_values() parameter filters", "output": "The filters parameter an iterable of filter types (e.g., [meshfilter, energyfilter]; default is []). It should be a Iterable of openmc.FilterMeta value." }, { "instruction": "What does the filter_bins parameter do in the get_values() method?", "input": "OpenMC Python API Tally.get_values() parameter filter_bins", "output": "The filter_bins parameter a list of tuples of filter bins corresponding to the filter_types parameter (e.g., [(1,), ((0., 0.625e-6),)]; default is []). each tuple contains bins for the corresponding filter type in the filters parameter. each bins is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. each bin is an integer for the cell instance id for 'distribcell' filters. each bin is a 2-tuple of floats for 'energy' and 'energyout' filters corresponding to the energy boundaries of the bin of interest. the bin is an (x,y,z) 3-tuple for 'mesh' filters corresponding to the mesh cell of interest. the order of the bins in the list must correspond to the filter_types parameter.. It should be a list of Iterables value." }, { "instruction": "What does the nuclides parameter do in the get_values() method?", "input": "OpenMC Python API Tally.get_values() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the value parameter do in the get_values() method?", "input": "OpenMC Python API Tally.get_values() parameter value", "output": "The value parameter a string for the type of value to return - 'mean' (default), 'std_dev', 'rel_err', 'sum', or 'sum_sq' are accepted. It should be a str value." }, { "instruction": "What does the get_pandas_dataframe() method do in the Tally class?", "input": "OpenMC Python API Tally.get_pandas_dataframe() method", "output": "The get_pandas_dataframe() method build a pandas dataframe for the tally data. this method constructs a pandas dataframe object for the tally data with columns annotated by filter, nuclide and score bin information. this capability has been tested for pandas >=0.13.1. however, it is recommended to use v0.16 or newer versions of pandas since this method uses the multi-index pandas feature. It's used for tally operations." }, { "instruction": "How do you call the get_pandas_dataframe() method in the Tally class?", "input": "OpenMC Python API Tally.get_pandas_dataframe() method signature", "output": "To call the get_pandas_dataframe() method, use: def get_pandas_dataframe(self: Any, filters: Any, nuclides: Any, scores: Any, derivative: Any, paths: Any, float_format: Any). It takes 7 parameters." }, { "instruction": "What does the filters parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Tally.get_pandas_dataframe() parameter filters", "output": "The filters parameter include columns with filter bin information (default is true).. It should be a bool value." }, { "instruction": "What does the nuclides parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Tally.get_pandas_dataframe() parameter nuclides", "output": "The nuclides parameter include columns with nuclide bin information (default is true).. It should be a bool value." }, { "instruction": "What does the scores parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Tally.get_pandas_dataframe() parameter scores", "output": "The scores parameter include columns with score bin information (default is true).. It should be a bool value." }, { "instruction": "What does the derivative parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Tally.get_pandas_dataframe() parameter derivative", "output": "The derivative parameter include columns with differential tally info (default is true).. It should be a bool value." }, { "instruction": "What does the paths parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Tally.get_pandas_dataframe() parameter paths", "output": "The paths parameter construct columns for distribcell tally filters (default is true). the geometric information in the summary object is embedded into a multi-index column with a geometric \"path\" to each distribcell instance.. It should be a bool, optional value." }, { "instruction": "What does the float_format parameter do in the get_pandas_dataframe() method?", "input": "OpenMC Python API Tally.get_pandas_dataframe() parameter float_format", "output": "The float_format parameter all floats in the dataframe will be formatted using the given format string before printing.. It should be a str value." }, { "instruction": "What does the get_reshaped_data() method do in the Tally class?", "input": "OpenMC Python API Tally.get_reshaped_data() method", "output": "The get_reshaped_data() method returns an array of tally data with one dimension per filter. the tally data in openmc is stored as a 3d array with the dimensions corresponding to filters, nuclides and scores. as a result, tally data can be opaque for a user to directly index (i.e., without use of :meth:`openmc.tally.get_values`) since one must know how to properly use the number of bins and strides for each filter to index into the first (filter) dimension. this builds and returns a reshaped version of the tally data array with unique dimensions corresponding to each tally filter. for example, suppose this tally has arrays of data with shape (30,5,5) corresponding to two filters (2 and 15 bins, respectively), five nuclides and five scores. this method will return a version of the data array with the with a new shape of (2,15,5,5) such that the first two dimensions correspond directly to the two filters with two and fifteen bins. if expand_dims is true and our filter above with 15 bins is an instance of :class:`openmc.meshfilter` with a shape of (3,5,1). the resulting tally data array will have a new shape of (2,3,5,1,5,5). It's used for tally operations." }, { "instruction": "How do you call the get_reshaped_data() method in the Tally class?", "input": "OpenMC Python API Tally.get_reshaped_data() method signature", "output": "To call the get_reshaped_data() method, use: def get_reshaped_data(self: Any, value: Any, expand_dims: Any). It takes 3 parameters." }, { "instruction": "What does the value parameter do in the get_reshaped_data() method?", "input": "OpenMC Python API Tally.get_reshaped_data() parameter value", "output": "The value parameter a string for the type of value to return - 'mean' (default), 'std_dev', 'rel_err', 'sum', or 'sum_sq' are accepted. It should be a str value." }, { "instruction": "What does the expand_dims parameter do in the get_reshaped_data() method?", "input": "OpenMC Python API Tally.get_reshaped_data() parameter expand_dims", "output": "The expand_dims parameter whether or not to expand the dimensions of filters with multiple dimensions. this will result in more than one dimension per filter for the returned data array. .. versionadded:: 0.13.3. It should be a bool, optional value." }, { "instruction": "What does the hybrid_product() method do in the Tally class?", "input": "OpenMC Python API Tally.hybrid_product() method", "output": "The hybrid_product() method combines filters, scores and nuclides with another tally. this is a helper method for the tally arithmetic operator overloaded methods. it is called a \"hybrid product\" because it performs a combination of tensor (or kronecker) and entrywise (or hadamard) products. the filters from both tallies are combined using an entrywise (or hadamard) product on matching filters. by default, if all nuclides are identical in the two tallies, the entrywise product is performed across nuclides; else the tensor product is performed. by default, if all scores are identical in the two tallies, the entrywise product is performed across scores; else the tensor product is performed. users can also call the method explicitly and specify the desired product. It's used for tally operations." }, { "instruction": "How do you call the hybrid_product() method in the Tally class?", "input": "OpenMC Python API Tally.hybrid_product() method signature", "output": "To call the hybrid_product() method, use: def hybrid_product(self: Any, other: Any, binary_op: Any, filter_product: Any, nuclide_product: Any, score_product: Any). It takes 6 parameters." }, { "instruction": "What does the other parameter do in the hybrid_product() method?", "input": "OpenMC Python API Tally.hybrid_product() parameter other", "output": "The other parameter the tally on the right hand side of the hybrid product. It should be a openmc.Tally value." }, { "instruction": "What does the binary_op parameter do in the hybrid_product() method?", "input": "OpenMC Python API Tally.hybrid_product() parameter binary_op", "output": "The binary_op parameter the binary operation in the hybrid product. It should be a {'+', '-', '*', '/', '^'} value." }, { "instruction": "What does the filter_product parameter do in the hybrid_product() method?", "input": "OpenMC Python API Tally.hybrid_product() parameter filter_product", "output": "The filter_product parameter the type of product (tensor or entrywise) to be performed between filter data. the default is the entrywise product. currently only the entrywise product is supported since a tally cannot contain two of the same filter.. It should be a {'tensor', 'entrywise' or None} value." }, { "instruction": "What does the nuclide_product parameter do in the hybrid_product() method?", "input": "OpenMC Python API Tally.hybrid_product() parameter nuclide_product", "output": "The nuclide_product parameter the type of product (tensor or entrywise) to be performed between nuclide data. the default is the entrywise product if all nuclides between the two tallies are the same; otherwise the default is the tensor product.. It should be a {'tensor', 'entrywise' or None} value." }, { "instruction": "What does the score_product parameter do in the hybrid_product() method?", "input": "OpenMC Python API Tally.hybrid_product() parameter score_product", "output": "The score_product parameter the type of product (tensor or entrywise) to be performed between score data. the default is the entrywise product if all scores between the two tallies are the same; otherwise the default is the tensor product.. It should be a {'tensor', 'entrywise' or None} value." }, { "instruction": "How do you call the filter_strides() method in the Tally class?", "input": "OpenMC Python API Tally.filter_strides() method signature", "output": "To call the filter_strides() method, use: @property def filter_strides(self: Any). It takes 1 parameters." }, { "instruction": "What does the _align_tally_data() method do in the Tally class?", "input": "OpenMC Python API Tally._align_tally_data() method", "output": "The _align_tally_data() method aligns data from two tallies for tally arithmetic. this is a helper method to construct a dict of dicts of the \"aligned\" data arrays from each tally for tally arithmetic. the method analyzes the filters, scores and nuclides in both tallies and determines how to appropriately align the data for vectorized arithmetic. for example, if the two tallies have different filters, this method will use numpy 'tile' and 'repeat' operations to the new data arrays such that all possible combinations of the data in each tally's bins will be made when the arithmetic operation is applied to the arrays. It's used for tally operations." }, { "instruction": "How do you call the _align_tally_data() method in the Tally class?", "input": "OpenMC Python API Tally._align_tally_data() method signature", "output": "To call the _align_tally_data() method, use: def _align_tally_data(self: Any, other: Any, filter_product: Any, nuclide_product: Any, score_product: Any). It takes 5 parameters." }, { "instruction": "What does the other parameter do in the _align_tally_data() method?", "input": "OpenMC Python API Tally._align_tally_data() parameter other", "output": "The other parameter the tally to outer product with this tally. It should be a openmc.Tally value." }, { "instruction": "What does the filter_product parameter do in the _align_tally_data() method?", "input": "OpenMC Python API Tally._align_tally_data() parameter filter_product", "output": "The filter_product parameter the type of product to be performed between filter data. currently, only the entrywise product is supported for the filter product.. It should be a {'entrywise'} value." }, { "instruction": "What does the nuclide_product parameter do in the _align_tally_data() method?", "input": "OpenMC Python API Tally._align_tally_data() parameter nuclide_product", "output": "The nuclide_product parameter the type of product (tensor or entrywise) to be performed between nuclide data.. It should be a {'tensor', 'entrywise'} value." }, { "instruction": "What does the score_product parameter do in the _align_tally_data() method?", "input": "OpenMC Python API Tally._align_tally_data() parameter score_product", "output": "The score_product parameter the type of product (tensor or entrywise) to be performed between score data.. It should be a {'tensor', 'entrywise'} value." }, { "instruction": "What does the _swap_filters() method do in the Tally class?", "input": "OpenMC Python API Tally._swap_filters() method", "output": "The _swap_filters() method reverse the ordering of two filters in this tally this is a helper method for tally arithmetic which helps align the data in two tallies with shared filters. this method reverses the order of the two filters in place. It's used for tally operations." }, { "instruction": "How do you call the _swap_filters() method in the Tally class?", "input": "OpenMC Python API Tally._swap_filters() method signature", "output": "To call the _swap_filters() method, use: def _swap_filters(self: Any, filter1: Any, filter2: Any). It takes 3 parameters." }, { "instruction": "What does the filter1 parameter do in the _swap_filters() method?", "input": "OpenMC Python API Tally._swap_filters() parameter filter1", "output": "The filter1 parameter the filter to swap with filter2. It should be a Filter value." }, { "instruction": "What does the filter2 parameter do in the _swap_filters() method?", "input": "OpenMC Python API Tally._swap_filters() parameter filter2", "output": "The filter2 parameter the filter to swap with filter1. It should be a Filter value." }, { "instruction": "What does the _swap_nuclides() method do in the Tally class?", "input": "OpenMC Python API Tally._swap_nuclides() method", "output": "The _swap_nuclides() method reverse the ordering of two nuclides in this tally this is a helper method for tally arithmetic which helps align the data in two tallies with shared nuclides. this method reverses the order of the two nuclides in place. It's used for tally operations." }, { "instruction": "How do you call the _swap_nuclides() method in the Tally class?", "input": "OpenMC Python API Tally._swap_nuclides() method signature", "output": "To call the _swap_nuclides() method, use: def _swap_nuclides(self: Any, nuclide1: Any, nuclide2: Any). It takes 3 parameters." }, { "instruction": "What does the nuclide1 parameter do in the _swap_nuclides() method?", "input": "OpenMC Python API Tally._swap_nuclides() parameter nuclide1", "output": "The nuclide1 parameter the nuclide to swap with nuclide2. It should be a Nuclide value." }, { "instruction": "What does the nuclide2 parameter do in the _swap_nuclides() method?", "input": "OpenMC Python API Tally._swap_nuclides() parameter nuclide2", "output": "The nuclide2 parameter the nuclide to swap with nuclide1. It should be a Nuclide value." }, { "instruction": "What does the _swap_scores() method do in the Tally class?", "input": "OpenMC Python API Tally._swap_scores() method", "output": "The _swap_scores() method reverse the ordering of two scores in this tally this is a helper method for tally arithmetic which helps align the data in two tallies with shared scores. this method reverses the order of the two scores in place. It's used for tally operations." }, { "instruction": "How do you call the _swap_scores() method in the Tally class?", "input": "OpenMC Python API Tally._swap_scores() method signature", "output": "To call the _swap_scores() method, use: def _swap_scores(self: Any, score1: Any, score2: Any). It takes 3 parameters." }, { "instruction": "What does the score1 parameter do in the _swap_scores() method?", "input": "OpenMC Python API Tally._swap_scores() parameter score1", "output": "The score1 parameter the score to swap with score2. It should be a str or CrossScore value." }, { "instruction": "What does the score2 parameter do in the _swap_scores() method?", "input": "OpenMC Python API Tally._swap_scores() parameter score2", "output": "The score2 parameter the score to swap with score1. It should be a str or CrossScore value." }, { "instruction": "What does the __add__() method do in the Tally class?", "input": "OpenMC Python API Tally.__add__() method", "output": "The __add__() method adds this tally to another tally or scalar value. this method builds a new tally with data that is the sum of this tally's data and that from the other tally or scalar value. if the filters, scores and nuclides in the two tallies are not the same, then they are combined in all possible ways in the new derived tally. uncertainty propagation is used to compute the standard deviation for the new tally's data. it is important to note that this makes the assumption that the tally data is independently distributed. in most use cases, this is *not* true and may lead to under-prediction of the uncertainty. the uncertainty propagation model is from the following source: https://en.wikipedia.org/wiki/propagation_of_uncertainty. It's used for tally operations." }, { "instruction": "How do you call the __add__() method in the Tally class?", "input": "OpenMC Python API Tally.__add__() method signature", "output": "To call the __add__() method, use: def __add__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __add__() method?", "input": "OpenMC Python API Tally.__add__() parameter other", "output": "The other parameter the tally or scalar value to add to this tally. It should be a openmc.Tally or float value." }, { "instruction": "What does the __sub__() method do in the Tally class?", "input": "OpenMC Python API Tally.__sub__() method", "output": "The __sub__() method subtracts another tally or scalar value from this tally. this method builds a new tally with data that is the difference of this tally's data and that from the other tally or scalar value. if the filters, scores and nuclides in the two tallies are not the same, then they are combined in all possible ways in the new derived tally. uncertainty propagation is used to compute the standard deviation for the new tally's data. it is important to note that this makes the assumption that the tally data is independently distributed. in most use cases, this is *not* true and may lead to under-prediction of the uncertainty. the uncertainty propagation model is from the following source: https://en.wikipedia.org/wiki/propagation_of_uncertainty. It's used for tally operations." }, { "instruction": "How do you call the __sub__() method in the Tally class?", "input": "OpenMC Python API Tally.__sub__() method signature", "output": "To call the __sub__() method, use: def __sub__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __sub__() method?", "input": "OpenMC Python API Tally.__sub__() parameter other", "output": "The other parameter the tally or scalar value to subtract from this tally. It should be a openmc.Tally or float value." }, { "instruction": "What does the __mul__() method do in the Tally class?", "input": "OpenMC Python API Tally.__mul__() method", "output": "The __mul__() method multiplies this tally with another tally or scalar value. this method builds a new tally with data that is the product of this tally's data and that from the other tally or scalar value. if the filters, scores and nuclides in the two tallies are not the same, then they are combined in all possible ways in the new derived tally. uncertainty propagation is used to compute the standard deviation for the new tally's data. it is important to note that this makes the assumption that the tally data is independently distributed. in most use cases, this is *not* true and may lead to under-prediction of the uncertainty. the uncertainty propagation model is from the following source: https://en.wikipedia.org/wiki/propagation_of_uncertainty. It's used for tally operations." }, { "instruction": "How do you call the __mul__() method in the Tally class?", "input": "OpenMC Python API Tally.__mul__() method signature", "output": "To call the __mul__() method, use: def __mul__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __mul__() method?", "input": "OpenMC Python API Tally.__mul__() parameter other", "output": "The other parameter the tally or scalar value to multiply with this tally. It should be a openmc.Tally or float value." }, { "instruction": "What does the __truediv__() method do in the Tally class?", "input": "OpenMC Python API Tally.__truediv__() method", "output": "The __truediv__() method divides this tally by another tally or scalar value. this method builds a new tally with data that is the dividend of this tally's data and that from the other tally or scalar value. if the filters, scores and nuclides in the two tallies are not the same, then they are combined in all possible ways in the new derived tally. uncertainty propagation is used to compute the standard deviation for the new tally's data. it is important to note that this makes the assumption that the tally data is independently distributed. in most use cases, this is *not* true and may lead to under-prediction of the uncertainty. the uncertainty propagation model is from the following source: https://en.wikipedia.org/wiki/propagation_of_uncertainty. It's used for tally operations." }, { "instruction": "How do you call the __truediv__() method in the Tally class?", "input": "OpenMC Python API Tally.__truediv__() method signature", "output": "To call the __truediv__() method, use: def __truediv__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __truediv__() method?", "input": "OpenMC Python API Tally.__truediv__() parameter other", "output": "The other parameter the tally or scalar value to divide this tally by. It should be a openmc.Tally or float value." }, { "instruction": "How do you call the __div__() method in the Tally class?", "input": "OpenMC Python API Tally.__div__() method signature", "output": "To call the __div__() method, use: def __div__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the __pow__() method do in the Tally class?", "input": "OpenMC Python API Tally.__pow__() method", "output": "The __pow__() method raises this tally to another tally or scalar value power. this method builds a new tally with data that is the power of this tally's data to that from the other tally or scalar value. if the filters, scores and nuclides in the two tallies are not the same, then they are combined in all possible ways in the new derived tally. uncertainty propagation is used to compute the standard deviation for the new tally's data. it is important to note that this makes the assumption that the tally data is independently distributed. in most use cases, this is *not* true and may lead to under-prediction of the uncertainty. the uncertainty propagation model is from the following source: https://en.wikipedia.org/wiki/propagation_of_uncertainty. It's used for tally operations." }, { "instruction": "How do you call the __pow__() method in the Tally class?", "input": "OpenMC Python API Tally.__pow__() method signature", "output": "To call the __pow__() method, use: def __pow__(self: Any, power: Any). It takes 2 parameters." }, { "instruction": "What does the power parameter do in the __pow__() method?", "input": "OpenMC Python API Tally.__pow__() parameter power", "output": "The power parameter the tally or scalar value exponent. It should be a openmc.Tally or float value." }, { "instruction": "What does the __radd__() method do in the Tally class?", "input": "OpenMC Python API Tally.__radd__() method", "output": "The __radd__() method right addition with a scalar value. this reverses the operands and calls the __add__ method. It's used for tally operations." }, { "instruction": "How do you call the __radd__() method in the Tally class?", "input": "OpenMC Python API Tally.__radd__() method signature", "output": "To call the __radd__() method, use: def __radd__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __radd__() method?", "input": "OpenMC Python API Tally.__radd__() parameter other", "output": "The other parameter the scalar value to add to this tally. It should be a float value." }, { "instruction": "What does the __rsub__() method do in the Tally class?", "input": "OpenMC Python API Tally.__rsub__() method", "output": "The __rsub__() method right subtraction from a scalar value. this reverses the operands and calls the __sub__ method. It's used for tally operations." }, { "instruction": "How do you call the __rsub__() method in the Tally class?", "input": "OpenMC Python API Tally.__rsub__() method signature", "output": "To call the __rsub__() method, use: def __rsub__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __rsub__() method?", "input": "OpenMC Python API Tally.__rsub__() parameter other", "output": "The other parameter the scalar value to subtract this tally from. It should be a float value." }, { "instruction": "What does the __rmul__() method do in the Tally class?", "input": "OpenMC Python API Tally.__rmul__() method", "output": "The __rmul__() method right multiplication with a scalar value. this reverses the operands and calls the __mul__ method. It's used for tally operations." }, { "instruction": "How do you call the __rmul__() method in the Tally class?", "input": "OpenMC Python API Tally.__rmul__() method signature", "output": "To call the __rmul__() method, use: def __rmul__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __rmul__() method?", "input": "OpenMC Python API Tally.__rmul__() parameter other", "output": "The other parameter the scalar value to multiply with this tally. It should be a float value." }, { "instruction": "What does the __rdiv__() method do in the Tally class?", "input": "OpenMC Python API Tally.__rdiv__() method", "output": "The __rdiv__() method right division with a scalar value. this reverses the operands and calls the __div__ method. It's used for tally operations." }, { "instruction": "How do you call the __rdiv__() method in the Tally class?", "input": "OpenMC Python API Tally.__rdiv__() method signature", "output": "To call the __rdiv__() method, use: def __rdiv__(self: Any, other: Any). It takes 2 parameters." }, { "instruction": "What does the other parameter do in the __rdiv__() method?", "input": "OpenMC Python API Tally.__rdiv__() parameter other", "output": "The other parameter the scalar value to divide by this tally. It should be a float value." }, { "instruction": "What does the __abs__() method do in the Tally class?", "input": "OpenMC Python API Tally.__abs__() method", "output": "The __abs__() method the absolute value of this tally. It's used for tally operations." }, { "instruction": "How do you call the __abs__() method in the Tally class?", "input": "OpenMC Python API Tally.__abs__() method signature", "output": "To call the __abs__() method, use: def __abs__(self: Any). It takes 1 parameters." }, { "instruction": "What does the __neg__() method do in the Tally class?", "input": "OpenMC Python API Tally.__neg__() method", "output": "The __neg__() method the negated value of this tally. It's used for tally operations." }, { "instruction": "How do you call the __neg__() method in the Tally class?", "input": "OpenMC Python API Tally.__neg__() method signature", "output": "To call the __neg__() method, use: def __neg__(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_slice() method do in the Tally class?", "input": "OpenMC Python API Tally.get_slice() method", "output": "The get_slice() method build a sliced tally for the specified filters, scores and nuclides. this method constructs a new tally to encapsulate a subset of the data represented by this tally. the subset of data to include in the tally slice is determined by the scores, filters and nuclides specified in the input parameters. It's used for tally operations." }, { "instruction": "How do you call the get_slice() method in the Tally class?", "input": "OpenMC Python API Tally.get_slice() method signature", "output": "To call the get_slice() method, use: def get_slice(self: Any, scores: Any, filters: Any, filter_bins: Any, nuclides: Any, squeeze: Any). It takes 6 parameters." }, { "instruction": "What does the scores parameter do in the get_slice() method?", "input": "OpenMC Python API Tally.get_slice() parameter scores", "output": "The scores parameter a list of one or more score strings (e.g., ['absorption', 'nu-fission']. It should be a list of str value." }, { "instruction": "What does the filters parameter do in the get_slice() method?", "input": "OpenMC Python API Tally.get_slice() parameter filters", "output": "The filters parameter an iterable of filter types (e.g., [meshfilter, energyfilter]). It should be a Iterable of openmc.FilterMeta value." }, { "instruction": "What does the filter_bins parameter do in the get_slice() method?", "input": "OpenMC Python API Tally.get_slice() parameter filter_bins", "output": "The filter_bins parameter a list of iterables of filter bins corresponding to the specified filter types (e.g., [(1,), ((0., 0.625e-6),)]). each iterable contains bins to slice for the corresponding filter type in the filters parameter. each bin is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. each bin is an integer for the cell instance id for 'distribcell' filters. each bin is a 2-tuple of floats for 'energy' and 'energyout' filters corresponding to the energy boundaries of the bin of interest. the bin is an (x,y,z) 3-tuple for 'mesh' filters corresponding to the mesh cell of interest. the order of the bins in the list must correspond to the `filters` argument.. It should be a list of Iterables value." }, { "instruction": "What does the nuclides parameter do in the get_slice() method?", "input": "OpenMC Python API Tally.get_slice() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings (e.g., ['u235', 'u238']). It should be a list of str value." }, { "instruction": "What does the squeeze parameter do in the get_slice() method?", "input": "OpenMC Python API Tally.get_slice() parameter squeeze", "output": "The squeeze parameter whether to remove filters with only a single bin in the sliced tally. It should be a bool value." }, { "instruction": "What does the summation() method do in the Tally class?", "input": "OpenMC Python API Tally.summation() method", "output": "The summation() method vectorized sum of tally data across scores, filter bins and/or nuclides using tally aggregation. this method constructs a new tally to encapsulate the sum of the data represented by the summation of the data in this tally. the tally data sum is determined by the scores, filter bins and nuclides specified in the input parameters. It's used for tally operations." }, { "instruction": "How do you call the summation() method in the Tally class?", "input": "OpenMC Python API Tally.summation() method signature", "output": "To call the summation() method, use: def summation(self: Any, scores: Any, filter_type: Any, filter_bins: Any, nuclides: Any, remove_filter: Any). It takes 6 parameters." }, { "instruction": "What does the scores parameter do in the summation() method?", "input": "OpenMC Python API Tally.summation() parameter scores", "output": "The scores parameter a list of one or more score strings to sum across (e.g., ['absorption', 'nu-fission']; default is []). It should be a list of str value." }, { "instruction": "What does the filter_type parameter do in the summation() method?", "input": "OpenMC Python API Tally.summation() parameter filter_type", "output": "The filter_type parameter type of the filter, e.g. meshfilter. It should be a openmc.FilterMeta value." }, { "instruction": "What does the filter_bins parameter do in the summation() method?", "input": "OpenMC Python API Tally.summation() parameter filter_bins", "output": "The filter_bins parameter a list of the filter bins corresponding to the filter_type parameter each bin in the list is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. each bin is an integer for the cell instance id for 'distribcell' filters. each bin is a 2-tuple of floats for 'energy' and 'energyout' filters corresponding to the energy boundaries of the bin of interest. each bin is an (x,y,z) 3-tuple for 'mesh' filters corresponding to the mesh cell of interest.. It should be a Iterable of int or tuple value." }, { "instruction": "What does the nuclides parameter do in the summation() method?", "input": "OpenMC Python API Tally.summation() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings to sum across (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the remove_filter parameter do in the summation() method?", "input": "OpenMC Python API Tally.summation() parameter remove_filter", "output": "The remove_filter parameter if a filter is being summed over, this bool indicates whether to remove that filter in the returned tally. default is false.. It should be a bool value." }, { "instruction": "What does the average() method do in the Tally class?", "input": "OpenMC Python API Tally.average() method", "output": "The average() method vectorized average of tally data across scores, filter bins and/or nuclides using tally aggregation. this method constructs a new tally to encapsulate the average of the data represented by the average of the data in this tally. the tally data average is determined by the scores, filter bins and nuclides specified in the input parameters. It's used for tally operations." }, { "instruction": "How do you call the average() method in the Tally class?", "input": "OpenMC Python API Tally.average() method signature", "output": "To call the average() method, use: def average(self: Any, scores: Any, filter_type: Any, filter_bins: Any, nuclides: Any, remove_filter: Any). It takes 6 parameters." }, { "instruction": "What does the scores parameter do in the average() method?", "input": "OpenMC Python API Tally.average() parameter scores", "output": "The scores parameter a list of one or more score strings to average across (e.g., ['absorption', 'nu-fission']; default is []). It should be a list of str value." }, { "instruction": "What does the filter_type parameter do in the average() method?", "input": "OpenMC Python API Tally.average() parameter filter_type", "output": "The filter_type parameter type of the filter, e.g. meshfilter. It should be a openmc.FilterMeta value." }, { "instruction": "What does the filter_bins parameter do in the average() method?", "input": "OpenMC Python API Tally.average() parameter filter_bins", "output": "The filter_bins parameter a list of the filter bins corresponding to the filter_type parameter each bin in the list is the integer id for 'material', 'surface', 'cell', 'cellborn', and 'universe' filters. each bin is an integer for the cell instance id for 'distribcell' filters. each bin is a 2-tuple of floats for 'energy' and 'energyout' filters corresponding to the energy boundaries of the bin of interest. each bin is an (x,y,z) 3-tuple for 'mesh' filters corresponding to the mesh cell of interest.. It should be a Iterable of int or tuple value." }, { "instruction": "What does the nuclides parameter do in the average() method?", "input": "OpenMC Python API Tally.average() parameter nuclides", "output": "The nuclides parameter a list of nuclide name strings to average across (e.g., ['u235', 'u238']; default is []). It should be a list of str value." }, { "instruction": "What does the remove_filter parameter do in the average() method?", "input": "OpenMC Python API Tally.average() parameter remove_filter", "output": "The remove_filter parameter if a filter is being averaged over, this bool indicates whether to remove that filter in the returned tally. default is false.. It should be a bool value." }, { "instruction": "What does the diagonalize_filter() method do in the Tally class?", "input": "OpenMC Python API Tally.diagonalize_filter() method", "output": "The diagonalize_filter() method diagonalize the tally data array along a new axis of filter bins. this is a helper method for the tally arithmetic methods. this method adds the new filter to a derived tally constructed copied from this one. the data in the derived tally arrays is \"diagonalized\" along the bins in the new filter. this functionality is used by the openmc.mgxs module; to transport-correct scattering matrices by subtracting a 'scatter-p1' reaction rate tally with an energy filter from a 'scatter' reaction rate tally with both energy and energyout filters. It's used for tally operations." }, { "instruction": "How do you call the diagonalize_filter() method in the Tally class?", "input": "OpenMC Python API Tally.diagonalize_filter() method signature", "output": "To call the diagonalize_filter() method, use: def diagonalize_filter(self: Any, new_filter: Any, filter_position: Any). It takes 3 parameters." }, { "instruction": "What does the new_filter parameter do in the diagonalize_filter() method?", "input": "OpenMC Python API Tally.diagonalize_filter() parameter new_filter", "output": "The new_filter parameter the filter along which to diagonalize the data in the new. It should be a Filter value." }, { "instruction": "What does the filter_position parameter do in the diagonalize_filter() method?", "input": "OpenMC Python API Tally.diagonalize_filter() parameter filter_position", "output": "The filter_position parameter where to place the new filter in the tally.filters list. defaults to last position.. It should be a int value." }, { "instruction": "What is the Tallies class in OpenMC's Python API?", "input": "OpenMC Python API Tallies class", "output": "The Tallies class represents collection of tallies used for an openmc simulation. this class corresponds directly to the tallies.xml input file. it can be thought of as a normal python list where each member is a :class:`tally`. it behaves like a list as the following example demonstrates: >>> t1 = openmc.tally() >>> t2 = openmc.tally() >>> t3 = openmc.tally() >>> tallies = openmc.tallies([t1]) >>> tallies.append(t2) >>> tallies += [t3]. It provides 13 methods and 0 properties for working with tallies data in OpenMC." }, { "instruction": "What does the Tallies class do in OpenMC's Python API?", "input": "OpenMC Python API Tallies class description", "output": "The Tallies class collection of tallies used for an openmc simulation. this class corresponds directly to the tallies.xml input file. it can be thought of as a normal python list where each member is a :class:`tally`. it behaves like a list as the following example demonstrates: >>> t1 = openmc.tally() >>> t2 = openmc.tally() >>> t3 = openmc.tally() >>> tallies = openmc.tallies([t1]) >>> tallies.append(t2) >>> tallies += [t3]. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the tallies parameter do when creating a Tallies?", "input": "OpenMC Python API Tallies constructor parameter tallies", "output": "When creating a Tallies, the tallies parameter specifies tallies to add to the collection. It should be a Iterable of openmc.Tally value." }, { "instruction": "How do you call the __init__() method in the Tallies class?", "input": "OpenMC Python API Tallies.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, tallies: Any). It takes 2 parameters." }, { "instruction": "What does the append() method do in the Tallies class?", "input": "OpenMC Python API Tallies.append() method", "output": "The append() method append tally to collection. It's used for tallies operations." }, { "instruction": "How do you call the append() method in the Tallies class?", "input": "OpenMC Python API Tallies.append() method signature", "output": "To call the append() method, use: def append(self: Any, tally: Any, merge: Any). It takes 3 parameters." }, { "instruction": "What does the tally parameter do in the append() method?", "input": "OpenMC Python API Tallies.append() parameter tally", "output": "The tally parameter tally to append. It should be a openmc.Tally value." }, { "instruction": "What does the merge parameter do in the append() method?", "input": "OpenMC Python API Tallies.append() parameter merge", "output": "The merge parameter indicate whether the tally should be merged with an existing tally, if possible. defaults to false.. It should be a bool value." }, { "instruction": "What does the insert() method do in the Tallies class?", "input": "OpenMC Python API Tallies.insert() method", "output": "The insert() method insert tally before index. It's used for tallies operations." }, { "instruction": "How do you call the insert() method in the Tallies class?", "input": "OpenMC Python API Tallies.insert() method signature", "output": "To call the insert() method, use: def insert(self: Any, index: Any, item: Any). It takes 3 parameters." }, { "instruction": "What does the index parameter do in the insert() method?", "input": "OpenMC Python API Tallies.insert() parameter index", "output": "The index parameter index in list. It should be a int value." }, { "instruction": "What does the item parameter do in the insert() method?", "input": "OpenMC Python API Tallies.insert() parameter item", "output": "The item parameter tally to insert. It should be a openmc.Tally value." }, { "instruction": "What does the merge_tallies() method do in the Tallies class?", "input": "OpenMC Python API Tallies.merge_tallies() method", "output": "The merge_tallies() method merge any mergeable tallies together. note that n-way merges are\n possible.. It's used for tallies operations." }, { "instruction": "How do you call the merge_tallies() method in the Tallies class?", "input": "OpenMC Python API Tallies.merge_tallies() method signature", "output": "To call the merge_tallies() method, use: def merge_tallies(self: Any). It takes 1 parameters." }, { "instruction": "What does the add_results() method do in the Tallies class?", "input": "OpenMC Python API Tallies.add_results() method", "output": "The add_results() method add results from the provided statepoint file .. versionadded:: 0.15.1. It's used for tallies operations." }, { "instruction": "How do you call the add_results() method in the Tallies class?", "input": "OpenMC Python API Tallies.add_results() method signature", "output": "To call the add_results() method, use: def add_results(self: Any, statepoint: Any). It takes 2 parameters." }, { "instruction": "What does the statepoint parameter do in the add_results() method?", "input": "OpenMC Python API Tallies.add_results() parameter statepoint", "output": "The statepoint parameter statepoint used to update tally results. It should be a openmc.PathLike or openmc.StatePoint value." }, { "instruction": "How do you call the _create_tally_subelements() method in the Tallies class?", "input": "OpenMC Python API Tallies._create_tally_subelements() method signature", "output": "To call the _create_tally_subelements() method, use: def _create_tally_subelements(self: Any, root_element: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_mesh_subelements() method in the Tallies class?", "input": "OpenMC Python API Tallies._create_mesh_subelements() method signature", "output": "To call the _create_mesh_subelements() method, use: def _create_mesh_subelements(self: Any, root_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "How do you call the _create_filter_subelements() method in the Tallies class?", "input": "OpenMC Python API Tallies._create_filter_subelements() method signature", "output": "To call the _create_filter_subelements() method, use: def _create_filter_subelements(self: Any, root_element: Any). It takes 2 parameters." }, { "instruction": "How do you call the _create_derivative_subelements() method in the Tallies class?", "input": "OpenMC Python API Tallies._create_derivative_subelements() method signature", "output": "To call the _create_derivative_subelements() method, use: def _create_derivative_subelements(self: Any, root_element: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the Tallies class?", "input": "OpenMC Python API Tallies.to_xml_element() method", "output": "The to_xml_element() method creates a 'tallies' element to be written to an xml file.. It's used for tallies operations." }, { "instruction": "How do you call the to_xml_element() method in the Tallies class?", "input": "OpenMC Python API Tallies.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the export_to_xml() method do in the Tallies class?", "input": "OpenMC Python API Tallies.export_to_xml() method", "output": "The export_to_xml() method create a tallies.xml file that can be used for a simulation. It's used for tallies operations." }, { "instruction": "How do you call the export_to_xml() method in the Tallies class?", "input": "OpenMC Python API Tallies.export_to_xml() method signature", "output": "To call the export_to_xml() method, use: def export_to_xml(self: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the export_to_xml() method?", "input": "OpenMC Python API Tallies.export_to_xml() parameter path", "output": "The path parameter path to file to write. defaults to 'tallies.xml'.. It should be a str value." }, { "instruction": "What does the from_xml_element() method do in the Tallies class?", "input": "OpenMC Python API Tallies.from_xml_element() method", "output": "The from_xml_element() method generate tallies from an xml element. It's used for tallies operations." }, { "instruction": "How do you call the from_xml_element() method in the Tallies class?", "input": "OpenMC Python API Tallies.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Tallies.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API Tallies.from_xml_element() parameter meshes", "output": "The meshes parameter a dictionary with mesh ids as keys and mesh instances as values that have already been read from xml. pre-existing meshes are used and new meshes are added to when creating tally objects.. It should be a dict or None value." }, { "instruction": "What does the from_xml() method do in the Tallies class?", "input": "OpenMC Python API Tallies.from_xml() method", "output": "The from_xml() method generate tallies from xml file. It's used for tallies operations." }, { "instruction": "How do you call the from_xml() method in the Tallies class?", "input": "OpenMC Python API Tallies.from_xml() method signature", "output": "To call the from_xml() method, use: @classmethod def from_xml(cls: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the path parameter do in the from_xml() method?", "input": "OpenMC Python API Tallies.from_xml() parameter path", "output": "The path parameter path to tallies xml file. It should be a str, optional value." }, { "instruction": "How do you call the read() function in OpenMC's Python API?", "input": "OpenMC Python API read() function signature", "output": "To call the read() function, use: def read(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cross_score() function in OpenMC's Python API?", "input": "OpenMC Python API cross_score() function signature", "output": "To call the cross_score() function, use: def cross_score(score1: Any, score2: Any, binary_op: Any). It takes 3 parameters." }, { "instruction": "What is the TallyDerivative class in OpenMC's Python API?", "input": "OpenMC Python API TallyDerivative class", "output": "The TallyDerivative class represents a material perturbation derivative to apply to a tally. It provides 10 methods and 0 properties for working with tallyderivative data in OpenMC." }, { "instruction": "What does the TallyDerivative class do in OpenMC's Python API?", "input": "OpenMC Python API TallyDerivative class description", "output": "The TallyDerivative class a material perturbation derivative to apply to a tally. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the derivative_id parameter do when creating a TallyDerivative?", "input": "OpenMC Python API TallyDerivative constructor parameter derivative_id", "output": "When creating a TallyDerivative, the derivative_id parameter specifies unique identifier for the tally derivative. if none is specified, an identifier will automatically be assigned. It should be a int, optional value." }, { "instruction": "What does the variable parameter do when creating a TallyDerivative?", "input": "OpenMC Python API TallyDerivative constructor parameter variable", "output": "When creating a TallyDerivative, the variable parameter specifies accepted values are 'density', 'nuclide_density', and 'temperature'. It should be a str, optional value." }, { "instruction": "What does the material parameter do when creating a TallyDerivative?", "input": "OpenMC Python API TallyDerivative constructor parameter material", "output": "When creating a TallyDerivative, the material parameter specifies the perturbed material id. It should be a int, optional value." }, { "instruction": "What does the nuclide parameter do when creating a TallyDerivative?", "input": "OpenMC Python API TallyDerivative constructor parameter nuclide", "output": "When creating a TallyDerivative, the nuclide parameter specifies the perturbed nuclide. only needed for 'nuclide_density' derivatives.. It should be a str, optional value." }, { "instruction": "What does the Ex parameter do when creating a TallyDerivative?", "input": "OpenMC Python API TallyDerivative constructor parameter Ex", "output": "When creating a TallyDerivative, the Ex parameter specifies . It should be a 'Xe135' value." }, { "instruction": "What is the id attribute of a TallyDerivative?", "input": "OpenMC Python API TallyDerivative attribute id", "output": "The id attribute of a TallyDerivative contains unique identifier for the tally derivative. It's a int value that you can access after creating a TallyDerivative instance." }, { "instruction": "What is the variable attribute of a TallyDerivative?", "input": "OpenMC Python API TallyDerivative attribute variable", "output": "The variable attribute of a TallyDerivative contains accepted values are 'density', 'nuclide_density', and 'temperature'. It's a str value that you can access after creating a TallyDerivative instance." }, { "instruction": "What is the material attribute of a TallyDerivative?", "input": "OpenMC Python API TallyDerivative attribute material", "output": "The material attribute of a TallyDerivative contains the perturubed material id. It's a int value that you can access after creating a TallyDerivative instance." }, { "instruction": "What is the nuclide attribute of a TallyDerivative?", "input": "OpenMC Python API TallyDerivative attribute nuclide", "output": "The nuclide attribute of a TallyDerivative contains the perturbed nuclide. only needed for 'nuclide_density' derivatives.. It's a str value that you can access after creating a TallyDerivative instance." }, { "instruction": "What is the Ex attribute of a TallyDerivative?", "input": "OpenMC Python API TallyDerivative attribute Ex", "output": "The Ex attribute of a TallyDerivative contains . It's a 'Xe135' value that you can access after creating a TallyDerivative instance." }, { "instruction": "How do you call the __init__() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, derivative_id: Any, variable: Any, material: Any, nuclide: Any). It takes 5 parameters." }, { "instruction": "How do you call the __repr__() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the variable() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.variable() method signature", "output": "To call the variable() method, use: @property def variable(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the variable() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.variable() method signature", "output": "To call the variable() method, use: @variable.setter def variable(self: Any, var: Any). It takes 2 parameters." }, { "instruction": "How do you call the material() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.material() method signature", "output": "To call the material() method, use: @property def material(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the material() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.material() method signature", "output": "To call the material() method, use: @material.setter def material(self: Any, mat: Any). It takes 2 parameters." }, { "instruction": "How do you call the nuclide() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.nuclide() method signature", "output": "To call the nuclide() method, use: @property def nuclide(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the nuclide() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.nuclide() method signature", "output": "To call the nuclide() method, use: @nuclide.setter def nuclide(self: Any, nuc: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the tally derivative. It's used for tallyderivative operations." }, { "instruction": "How do you call the to_xml_element() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing derivative data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.from_xml_element() method", "output": "The from_xml_element() method generate tally derivative from an xml element. It's used for tallyderivative operations." }, { "instruction": "How do you call the from_xml_element() method in the TallyDerivative class?", "input": "OpenMC Python API TallyDerivative.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API TallyDerivative.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the Track class in OpenMC's Python API?", "input": "OpenMC Python API Track class", "output": "The Track class represents tracks resulting from a single source particle this class stores information for all tracks resulting from a primary source particle and any secondary particles that it created. the track for each primary/secondary particle is stored in the :attr:`particle_tracks` attribute. .. versionadded:: 0.13.1. It provides 7 methods and 0 properties for working with track data in OpenMC." }, { "instruction": "What does the Track class do in OpenMC's Python API?", "input": "OpenMC Python API Track class description", "output": "The Track class tracks resulting from a single source particle this class stores information for all tracks resulting from a primary source particle and any secondary particles that it created. the track for each primary/secondary particle is stored in the :attr:`particle_tracks` attribute. .. versionadded:: 0.13.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the dset parameter do when creating a Track?", "input": "OpenMC Python API Track constructor parameter dset", "output": "When creating a Track, the dset parameter specifies dataset to read track data from. It should be a h5py.Dataset value." }, { "instruction": "What is the identifier attribute of a Track?", "input": "OpenMC Python API Track attribute identifier", "output": "The identifier attribute of a Track contains tuple of (batch, generation, particle number). It's a tuple value that you can access after creating a Track instance." }, { "instruction": "What is the particle_tracks attribute of a Track?", "input": "OpenMC Python API Track attribute particle_tracks", "output": "The particle_tracks attribute of a Track contains list of tuples containing (particle type, array of track states). It's a list value that you can access after creating a Track instance." }, { "instruction": "What is the sources attribute of a Track?", "input": "OpenMC Python API Track attribute sources", "output": "The sources attribute of a Track contains list of :class:`sourceparticle` representing each primary/secondary particle. It's a list value that you can access after creating a Track instance." }, { "instruction": "How do you call the __init__() method in the Track class?", "input": "OpenMC Python API Track.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, dset: Any). It takes 2 parameters." }, { "instruction": "How do you call the __repr__() method in the Track class?", "input": "OpenMC Python API Track.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __getitem__() method in the Track class?", "input": "OpenMC Python API Track.__getitem__() method signature", "output": "To call the __getitem__() method, use: def __getitem__(self: Any, index: Any). It takes 2 parameters." }, { "instruction": "How do you call the __len__() method in the Track class?", "input": "OpenMC Python API Track.__len__() method signature", "output": "To call the __len__() method, use: def __len__(self: Any). It takes 1 parameters." }, { "instruction": "What does the filter() method do in the Track class?", "input": "OpenMC Python API Track.filter() method", "output": "The filter() method filter particle tracks by given criteria. It's used for track operations." }, { "instruction": "How do you call the filter() method in the Track class?", "input": "OpenMC Python API Track.filter() method signature", "output": "To call the filter() method, use: def filter(self: Any, particle: Any, state_filter: Any). It takes 3 parameters." }, { "instruction": "What does the particle parameter do in the filter() method?", "input": "OpenMC Python API Track.filter() parameter particle", "output": "The particle parameter matching particle type. It should be a {'neutron', 'photon', 'electron', 'positron'} value." }, { "instruction": "What does the state_filter parameter do in the filter() method?", "input": "OpenMC Python API Track.filter() parameter state_filter", "output": "The state_filter parameter function that takes a state (structured datatype) and returns a bool depending on some criteria.. It should be a function value." }, { "instruction": "What does the plot() method do in the Track class?", "input": "OpenMC Python API Track.plot() method", "output": "The plot() method produce a 3d plot of particle tracks. It's used for track operations." }, { "instruction": "How do you call the plot() method in the Track class?", "input": "OpenMC Python API Track.plot() method signature", "output": "To call the plot() method, use: def plot(self: Any, axes: Any). It takes 2 parameters." }, { "instruction": "What does the axes parameter do in the plot() method?", "input": "OpenMC Python API Track.plot() parameter axes", "output": "The axes parameter axes for plot. It should be a matplotlib.axes.Axes, optional value." }, { "instruction": "What does the plot() method return in the Track class?", "input": "OpenMC Python API Track.plot() return value", "output": "The plot() method returns axes for plot. The return type is matplotlib.axes.Axes." }, { "instruction": "How do you call the sources() method in the Track class?", "input": "OpenMC Python API Track.sources() method signature", "output": "To call the sources() method, use: @property def sources(self: Any). It takes 1 parameters." }, { "instruction": "What is the Tracks class in OpenMC's Python API?", "input": "OpenMC Python API Tracks class", "output": "The Tracks class represents collection of particle tracks this class behaves like a list and can be indexed using the normal subscript notation. each element in the list is a :class:`openmc.track` object. .. versionadded:: 0.13.1. It provides 5 methods and 0 properties for working with tracks data in OpenMC." }, { "instruction": "What does the Tracks class do in OpenMC's Python API?", "input": "OpenMC Python API Tracks class description", "output": "The Tracks class collection of particle tracks this class behaves like a list and can be indexed using the normal subscript notation. each element in the list is a :class:`openmc.track` object. .. versionadded:: 0.13.1. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the filepath parameter do when creating a Tracks?", "input": "OpenMC Python API Tracks constructor parameter filepath", "output": "When creating a Tracks, the filepath parameter specifies path of file to load. It should be a str or pathlib.Path value." }, { "instruction": "How do you call the __init__() method in the Tracks class?", "input": "OpenMC Python API Tracks.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, filepath: Any). It takes 2 parameters." }, { "instruction": "What does the filter() method do in the Tracks class?", "input": "OpenMC Python API Tracks.filter() method", "output": "The filter() method filter tracks by given criteria. It's used for tracks operations." }, { "instruction": "How do you call the filter() method in the Tracks class?", "input": "OpenMC Python API Tracks.filter() method signature", "output": "To call the filter() method, use: def filter(self: Any, particle: Any, state_filter: Any). It takes 3 parameters." }, { "instruction": "What does the particle parameter do in the filter() method?", "input": "OpenMC Python API Tracks.filter() parameter particle", "output": "The particle parameter matching particle type. It should be a {'neutron', 'photon', 'electron', 'positron'} value." }, { "instruction": "What does the state_filter parameter do in the filter() method?", "input": "OpenMC Python API Tracks.filter() parameter state_filter", "output": "The state_filter parameter function that takes a state (structured datatype) and returns a bool depending on some criteria.. It should be a function value." }, { "instruction": "What does the plot() method do in the Tracks class?", "input": "OpenMC Python API Tracks.plot() method", "output": "The plot() method produce a 3d plot of particle tracks. It's used for tracks operations." }, { "instruction": "How do you call the plot() method in the Tracks class?", "input": "OpenMC Python API Tracks.plot() method signature", "output": "To call the plot() method, use: def plot(self: Any). It takes 1 parameters." }, { "instruction": "What does the write_to_vtk() method do in the Tracks class?", "input": "OpenMC Python API Tracks.write_to_vtk() method", "output": "The write_to_vtk() method creates a vtp file of the tracks. It's used for tracks operations." }, { "instruction": "How do you call the write_to_vtk() method in the Tracks class?", "input": "OpenMC Python API Tracks.write_to_vtk() method signature", "output": "To call the write_to_vtk() method, use: def write_to_vtk(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the write_to_vtk() method?", "input": "OpenMC Python API Tracks.write_to_vtk() parameter filename", "output": "The filename parameter name of the vtp file to write.. It should be a path-like value." }, { "instruction": "What does the combine() method do in the Tracks class?", "input": "OpenMC Python API Tracks.combine() method", "output": "The combine() method combine multiple track files into a single track file. It's used for tracks operations." }, { "instruction": "How do you call the combine() method in the Tracks class?", "input": "OpenMC Python API Tracks.combine() method signature", "output": "To call the combine() method, use: @staticmethod def combine(track_files: Any, path: Any). It takes 2 parameters." }, { "instruction": "What does the track_files parameter do in the combine() method?", "input": "OpenMC Python API Tracks.combine() parameter track_files", "output": "The track_files parameter paths to track files to combine. It should be a list of path-like value." }, { "instruction": "What does the path parameter do in the combine() method?", "input": "OpenMC Python API Tracks.combine() parameter path", "output": "The path parameter path of combined track file to create. It should be a path-like value." }, { "instruction": "How do you call the _particle_track_repr() function in OpenMC's Python API?", "input": "OpenMC Python API _particle_track_repr() function signature", "output": "To call the _particle_track_repr() function, use: def _particle_track_repr(self: Any). It takes 1 parameters." }, { "instruction": "What does the _identifier() function do in OpenMC's Python API?", "input": "OpenMC Python API _identifier() function", "output": "The _identifier() function return (batch, gen, particle) tuple given dataset name. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _identifier() function in OpenMC's Python API?", "input": "OpenMC Python API _identifier() function purpose", "output": "The _identifier() function return (batch, gen, particle) tuple given dataset name. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _identifier() function in OpenMC's Python API?", "input": "OpenMC Python API _identifier() function signature", "output": "To call the _identifier() function, use: def _identifier(dset_name: Any). It takes 1 parameters." }, { "instruction": "What is the Trigger class in OpenMC's Python API?", "input": "OpenMC Python API Trigger class", "output": "The Trigger class represents a criterion for when to finish a simulation based on tally uncertainties. It provides 12 methods and 0 properties for working with trigger data in OpenMC." }, { "instruction": "What does the Trigger class do in OpenMC's Python API?", "input": "OpenMC Python API Trigger class description", "output": "The Trigger class a criterion for when to finish a simulation based on tally uncertainties. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the trigger_type parameter do when creating a Trigger?", "input": "OpenMC Python API Trigger constructor parameter trigger_type", "output": "When creating a Trigger, the trigger_type parameter specifies determine whether to trigger on the variance, standard deviation, or relative error of scores.. It should be a {'variance', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the threshold parameter do when creating a Trigger?", "input": "OpenMC Python API Trigger constructor parameter threshold", "output": "When creating a Trigger, the threshold parameter specifies the threshold for the trigger type.. It should be a float value." }, { "instruction": "What does the ignore_zeros parameter do when creating a Trigger?", "input": "OpenMC Python API Trigger constructor parameter ignore_zeros", "output": "When creating a Trigger, the ignore_zeros parameter specifies whether to allow zero tally bins to be ignored. note that this option can cause the trigger to fire prematurely if there are zero scores in any bin at the first evaluation. .. versionadded:: 0.15.0. It should be a bool value." }, { "instruction": "What is the trigger_type attribute of a Trigger?", "input": "OpenMC Python API Trigger attribute trigger_type", "output": "The trigger_type attribute of a Trigger contains determine whether to trigger on the variance, standard deviation, or relative error of scores.. It's a {'variance', 'std_dev', 'rel_err'} value that you can access after creating a Trigger instance." }, { "instruction": "What is the threshold attribute of a Trigger?", "input": "OpenMC Python API Trigger attribute threshold", "output": "The threshold attribute of a Trigger contains the threshold for the trigger type.. It's a float value that you can access after creating a Trigger instance." }, { "instruction": "What is the scores attribute of a Trigger?", "input": "OpenMC Python API Trigger attribute scores", "output": "The scores attribute of a Trigger contains scores which should be checked against the trigger. It's a list of str value that you can access after creating a Trigger instance." }, { "instruction": "What is the ignore_zeros attribute of a Trigger?", "input": "OpenMC Python API Trigger attribute ignore_zeros", "output": "The ignore_zeros attribute of a Trigger contains whether to allow zero tally bins to be ignored.. It's a bool value that you can access after creating a Trigger instance." }, { "instruction": "How do you call the __init__() method in the Trigger class?", "input": "OpenMC Python API Trigger.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, trigger_type: str, threshold: float, ignore_zeros: bool). It takes 4 parameters." }, { "instruction": "How do you call the __repr__() method in the Trigger class?", "input": "OpenMC Python API Trigger.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the trigger_type() method in the Trigger class?", "input": "OpenMC Python API Trigger.trigger_type() method signature", "output": "To call the trigger_type() method, use: @property def trigger_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the trigger_type() method in the Trigger class?", "input": "OpenMC Python API Trigger.trigger_type() method signature", "output": "To call the trigger_type() method, use: @trigger_type.setter def trigger_type(self: Any, trigger_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the threshold() method in the Trigger class?", "input": "OpenMC Python API Trigger.threshold() method signature", "output": "To call the threshold() method, use: @property def threshold(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the threshold() method in the Trigger class?", "input": "OpenMC Python API Trigger.threshold() method signature", "output": "To call the threshold() method, use: @threshold.setter def threshold(self: Any, threshold: Any). It takes 2 parameters." }, { "instruction": "How do you call the ignore_zeros() method in the Trigger class?", "input": "OpenMC Python API Trigger.ignore_zeros() method signature", "output": "To call the ignore_zeros() method, use: @property def ignore_zeros(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ignore_zeros() method in the Trigger class?", "input": "OpenMC Python API Trigger.ignore_zeros() method signature", "output": "To call the ignore_zeros() method, use: @ignore_zeros.setter def ignore_zeros(self: Any, ignore_zeros: Any). It takes 2 parameters." }, { "instruction": "How do you call the scores() method in the Trigger class?", "input": "OpenMC Python API Trigger.scores() method signature", "output": "To call the scores() method, use: @property def scores(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the scores() method in the Trigger class?", "input": "OpenMC Python API Trigger.scores() method signature", "output": "To call the scores() method, use: @scores.setter def scores(self: Any, scores: Any). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the Trigger class?", "input": "OpenMC Python API Trigger.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the trigger. It's used for trigger operations." }, { "instruction": "How do you call the to_xml_element() method in the Trigger class?", "input": "OpenMC Python API Trigger.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the Trigger class?", "input": "OpenMC Python API Trigger.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing trigger data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the Trigger class?", "input": "OpenMC Python API Trigger.from_xml_element() method", "output": "The from_xml_element() method generate trigger object from an xml element. It's used for trigger operations." }, { "instruction": "How do you call the from_xml_element() method in the Trigger class?", "input": "OpenMC Python API Trigger.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API Trigger.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What is the UniverseBase class in OpenMC's Python API?", "input": "OpenMC Python API UniverseBase class", "output": "The UniverseBase class represents a collection of cells that can be repeated. It provides 23 methods and 0 properties for working with universebase data in OpenMC." }, { "instruction": "What does the UniverseBase class do in OpenMC's Python API?", "input": "OpenMC Python API UniverseBase class description", "output": "The UniverseBase class a collection of cells that can be repeated. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What is the id attribute of a UniverseBase?", "input": "OpenMC Python API UniverseBase attribute id", "output": "The id attribute of a UniverseBase contains unique identifier of the universe. It's a int value that you can access after creating a UniverseBase instance." }, { "instruction": "What is the name attribute of a UniverseBase?", "input": "OpenMC Python API UniverseBase attribute name", "output": "The name attribute of a UniverseBase contains name of the universe. It's a str value that you can access after creating a UniverseBase instance." }, { "instruction": "How do you call the __init__() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, universe_id: Any, name: Any). It takes 3 parameters." }, { "instruction": "How do you call the __repr__() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.name() method signature", "output": "To call the name() method, use: @property def name(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the cells() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.cells() method signature", "output": "To call the cells() method, use: @property def cells(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the name() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.name() method signature", "output": "To call the name() method, use: @name.setter def name(self: Any, name: Any). It takes 2 parameters." }, { "instruction": "How do you call the volume() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.volume() method signature", "output": "To call the volume() method, use: @property def volume(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volume() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.volume() method signature", "output": "To call the volume() method, use: @volume.setter def volume(self: Any, volume: Any). It takes 2 parameters." }, { "instruction": "What does the add_volume_information() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.add_volume_information() method", "output": "The add_volume_information() method add volume information to a universe. It's used for universebase operations." }, { "instruction": "How do you call the add_volume_information() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.add_volume_information() method signature", "output": "To call the add_volume_information() method, use: def add_volume_information(self: Any, volume_calc: Any). It takes 2 parameters." }, { "instruction": "What does the volume_calc parameter do in the add_volume_information() method?", "input": "OpenMC Python API UniverseBase.add_volume_information() parameter volume_calc", "output": "The volume_calc parameter results from a stochastic volume calculation. It should be a openmc.VolumeCalculation value." }, { "instruction": "What does the get_all_universes() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_universes() method", "output": "The get_all_universes() method return all universes that are contained within this one. It's used for universebase operations." }, { "instruction": "How do you call the get_all_universes() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_universes() method signature", "output": "To call the get_all_universes() method, use: def get_all_universes(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_universes() method return in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_universes() return value", "output": "The get_all_universes() method returns dictionary whose keys are universe ids and values are :class:`universe` instances. The return type is dict." }, { "instruction": "What does the create_xml_subelement() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.create_xml_subelement() method", "output": "The create_xml_subelement() method add the universe xml representation to an incoming xml element. It's used for universebase operations." }, { "instruction": "How do you call the create_xml_subelement() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.create_xml_subelement() method signature", "output": "To call the create_xml_subelement() method, use: @abstractmethod def create_xml_subelement(self: Any, xml_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "What does the xml_element parameter do in the create_xml_subelement() method?", "input": "OpenMC Python API UniverseBase.create_xml_subelement() parameter xml_element", "output": "The xml_element parameter xml element to be added to. It should be a lxml.etree._Element value." }, { "instruction": "What does the memo parameter do in the create_xml_subelement() method?", "input": "OpenMC Python API UniverseBase.create_xml_subelement() parameter memo", "output": "The memo parameter a set of object id's representing geometry entities already written to the xml_element. this parameter is used internally and should not be specified by users.. It should be a set or None value." }, { "instruction": "What does the _determine_paths() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase._determine_paths() method", "output": "The _determine_paths() method count the number of instances for each cell in the universe, and\n record the count in the :attr:`cell.num_instances` properties.. It's used for universebase operations." }, { "instruction": "How do you call the _determine_paths() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase._determine_paths() method signature", "output": "To call the _determine_paths() method, use: def _determine_paths(self: Any, path: Any, instances_only: Any). It takes 3 parameters." }, { "instruction": "What does the add_cells() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.add_cells() method", "output": "The add_cells() method add multiple cells to the universe. It's used for universebase operations." }, { "instruction": "How do you call the add_cells() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.add_cells() method signature", "output": "To call the add_cells() method, use: def add_cells(self: Any, cells: Any). It takes 2 parameters." }, { "instruction": "What does the cells parameter do in the add_cells() method?", "input": "OpenMC Python API UniverseBase.add_cells() parameter cells", "output": "The cells parameter cells to add. It should be a Iterable of openmc.Cell value." }, { "instruction": "How do you call the add_cell() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.add_cell() method signature", "output": "To call the add_cell() method, use: @abstractmethod def add_cell(self: Any, cell: Any). It takes 2 parameters." }, { "instruction": "How do you call the remove_cell() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.remove_cell() method signature", "output": "To call the remove_cell() method, use: @abstractmethod def remove_cell(self: Any, cell: Any). It takes 2 parameters." }, { "instruction": "What does the clear_cells() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.clear_cells() method", "output": "The clear_cells() method remove all cells from the universe.. It's used for universebase operations." }, { "instruction": "How do you call the clear_cells() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.clear_cells() method signature", "output": "To call the clear_cells() method, use: def clear_cells(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_all_cells() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_cells() method", "output": "The get_all_cells() method return all cells that are contained within the universe. It's used for universebase operations." }, { "instruction": "How do you call the get_all_cells() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_cells() method signature", "output": "To call the get_all_cells() method, use: def get_all_cells(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_cells() method return in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_cells() return value", "output": "The get_all_cells() method returns dictionary whose keys are cell ids and values are :class:`cell` instances. The return type is dict." }, { "instruction": "What does the get_all_materials() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_materials() method", "output": "The get_all_materials() method return all materials that are contained within the universe. It's used for universebase operations." }, { "instruction": "How do you call the get_all_materials() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_materials() method signature", "output": "To call the get_all_materials() method, use: def get_all_materials(self: Any, memo: Any). It takes 2 parameters." }, { "instruction": "What does the get_all_materials() method return in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_all_materials() return value", "output": "The get_all_materials() method returns dictionary whose keys are material ids and values are :class:`material` instances. The return type is dict." }, { "instruction": "What does the _partial_deepcopy() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase._partial_deepcopy() method", "output": "The _partial_deepcopy() method deepcopy all parameters of an openmc.universebase object except its cells.\n this should only be used from the openmc.universebase.clone() context.. It's used for universebase operations." }, { "instruction": "How do you call the _partial_deepcopy() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase._partial_deepcopy() method signature", "output": "To call the _partial_deepcopy() method, use: @abstractmethod def _partial_deepcopy(self: Any). It takes 1 parameters." }, { "instruction": "What does the clone() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.clone() method", "output": "The clone() method create a copy of this universe with a new unique id, and clones all cells within this universe. It's used for universebase operations." }, { "instruction": "How do you call the clone() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.clone() method signature", "output": "To call the clone() method, use: def clone(self: Any, clone_materials: Any, clone_regions: Any, memo: Any). It takes 4 parameters." }, { "instruction": "What does the clone_materials parameter do in the clone() method?", "input": "OpenMC Python API UniverseBase.clone() parameter clone_materials", "output": "The clone_materials parameter whether to create separates copies of the materials filling cells contained in this universe.. It should be a bool value." }, { "instruction": "What does the clone_regions parameter do in the clone() method?", "input": "OpenMC Python API UniverseBase.clone() parameter clone_regions", "output": "The clone_regions parameter whether to create separates copies of the regions bounding cells contained in this universe.. It should be a bool value." }, { "instruction": "What does the memo parameter do in the clone() method?", "input": "OpenMC Python API UniverseBase.clone() parameter memo", "output": "The memo parameter a nested dictionary of previously cloned objects. this parameter is used internally and should not be specified by the user.. It should be a dict or None value." }, { "instruction": "What does the clone() method return in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.clone() return value", "output": "The clone() method returns the clone of this universe. The return type is openmc.Universe." }, { "instruction": "What does the find() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.find() method", "output": "The find() method find cells/universes/lattices which contain a given point. It's used for universebase operations." }, { "instruction": "How do you call the find() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.find() method signature", "output": "To call the find() method, use: def find(self: Any, point: Any). It takes 2 parameters." }, { "instruction": "What does the point parameter do in the find() method?", "input": "OpenMC Python API UniverseBase.find() parameter point", "output": "The point parameter cartesian coordinates of the point. It should be a 3-tuple of float value." }, { "instruction": "What does the plot() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.plot() method", "output": "The plot() method display a slice plot of the universe.. It's used for universebase operations." }, { "instruction": "How do you call the plot() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.plot() method signature", "output": "To call the plot() method, use: @add_plot_params def plot(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclides() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_nuclides() method", "output": "The get_nuclides() method returns all nuclides in the universe. It's used for universebase operations." }, { "instruction": "How do you call the get_nuclides() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_nuclides() method signature", "output": "To call the get_nuclides() method, use: def get_nuclides(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclides() method return in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_nuclides() return value", "output": "The get_nuclides() method returns list of nuclide names. The return type is list of str." }, { "instruction": "What does the get_nuclide_densities() method do in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_nuclide_densities() method", "output": "The get_nuclide_densities() method return all nuclides contained in the universe. It's used for universebase operations." }, { "instruction": "How do you call the get_nuclide_densities() method in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_nuclide_densities() method signature", "output": "To call the get_nuclide_densities() method, use: def get_nuclide_densities(self: Any). It takes 1 parameters." }, { "instruction": "What does the get_nuclide_densities() method return in the UniverseBase class?", "input": "OpenMC Python API UniverseBase.get_nuclide_densities() return value", "output": "The get_nuclide_densities() method returns dictionary whose keys are nuclide names and values are 2-tuples of (nuclide, density). The return type is dict." }, { "instruction": "What is the Universe class in OpenMC's Python API?", "input": "OpenMC Python API Universe class", "output": "The Universe class represents a collection of cells that can be repeated. It provides 8 methods and 0 properties for working with universe data in OpenMC." }, { "instruction": "What does the Universe class do in OpenMC's Python API?", "input": "OpenMC Python API Universe class description", "output": "The Universe class a collection of cells that can be repeated. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the universe_id parameter do when creating a Universe?", "input": "OpenMC Python API Universe constructor parameter universe_id", "output": "When creating a Universe, the universe_id parameter specifies unique identifier of the universe. if not specified, an identifier will automatically be assigned. It should be a int, optional value." }, { "instruction": "What does the name parameter do when creating a Universe?", "input": "OpenMC Python API Universe constructor parameter name", "output": "When creating a Universe, the name parameter specifies name of the universe. if not specified, the name is the empty string.. It should be a str, optional value." }, { "instruction": "What does the cells parameter do when creating a Universe?", "input": "OpenMC Python API Universe constructor parameter cells", "output": "When creating a Universe, the cells parameter specifies cells to add to the universe. by default no cells are added.. It should be a Iterable of openmc.Cell, optional value." }, { "instruction": "What is the id attribute of a Universe?", "input": "OpenMC Python API Universe attribute id", "output": "The id attribute of a Universe contains unique identifier of the universe. It's a int value that you can access after creating a Universe instance." }, { "instruction": "What is the name attribute of a Universe?", "input": "OpenMC Python API Universe attribute name", "output": "The name attribute of a Universe contains name of the universe. It's a str value that you can access after creating a Universe instance." }, { "instruction": "What is the cells attribute of a Universe?", "input": "OpenMC Python API Universe attribute cells", "output": "The cells attribute of a Universe contains dictionary whose keys are cell ids and values are :class:`cell` instances. It's a dict value that you can access after creating a Universe instance." }, { "instruction": "What is the volume attribute of a Universe?", "input": "OpenMC Python API Universe attribute volume", "output": "The volume attribute of a Universe contains volume of the universe in cm^3. this can either be set manually or calculated in a stochastic volume calculation and added via the :meth:`universe.add_volume_information` method.. It's a float value that you can access after creating a Universe instance." }, { "instruction": "What is the bounding_box attribute of a Universe?", "input": "OpenMC Python API Universe attribute bounding_box", "output": "The bounding_box attribute of a Universe contains lower-left and upper-right coordinates of an axis-aligned bounding box of the universe.. It's a openmc.BoundingBox value that you can access after creating a Universe instance." }, { "instruction": "How do you call the __init__() method in the Universe class?", "input": "OpenMC Python API Universe.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, universe_id: Any, name: Any, cells: Any). It takes 4 parameters." }, { "instruction": "How do you call the __repr__() method in the Universe class?", "input": "OpenMC Python API Universe.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the bounding_box() method in the Universe class?", "input": "OpenMC Python API Universe.bounding_box() method signature", "output": "To call the bounding_box() method, use: @property def bounding_box(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_hdf5() method do in the Universe class?", "input": "OpenMC Python API Universe.from_hdf5() method", "output": "The from_hdf5() method create universe from hdf5 group. It's used for universe operations." }, { "instruction": "How do you call the from_hdf5() method in the Universe class?", "input": "OpenMC Python API Universe.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: Any, cells: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API Universe.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the cells parameter do in the from_hdf5() method?", "input": "OpenMC Python API Universe.from_hdf5() parameter cells", "output": "The cells parameter dictionary mapping cell ids to instances of :class:`openmc.cell`.. It should be a dict value." }, { "instruction": "What does the add_cell() method do in the Universe class?", "input": "OpenMC Python API Universe.add_cell() method", "output": "The add_cell() method add a cell to the universe. It's used for universe operations." }, { "instruction": "How do you call the add_cell() method in the Universe class?", "input": "OpenMC Python API Universe.add_cell() method signature", "output": "To call the add_cell() method, use: def add_cell(self: Any, cell: Any). It takes 2 parameters." }, { "instruction": "What does the cell parameter do in the add_cell() method?", "input": "OpenMC Python API Universe.add_cell() parameter cell", "output": "The cell parameter cell to add. It should be a openmc.Cell value." }, { "instruction": "What does the remove_cell() method do in the Universe class?", "input": "OpenMC Python API Universe.remove_cell() method", "output": "The remove_cell() method remove a cell from the universe. It's used for universe operations." }, { "instruction": "How do you call the remove_cell() method in the Universe class?", "input": "OpenMC Python API Universe.remove_cell() method signature", "output": "To call the remove_cell() method, use: def remove_cell(self: Any, cell: Any). It takes 2 parameters." }, { "instruction": "What does the cell parameter do in the remove_cell() method?", "input": "OpenMC Python API Universe.remove_cell() parameter cell", "output": "The cell parameter cell to remove. It should be a openmc.Cell value." }, { "instruction": "How do you call the create_xml_subelement() method in the Universe class?", "input": "OpenMC Python API Universe.create_xml_subelement() method signature", "output": "To call the create_xml_subelement() method, use: def create_xml_subelement(self: Any, xml_element: Any, memo: Any). It takes 3 parameters." }, { "instruction": "What does the _partial_deepcopy() method do in the Universe class?", "input": "OpenMC Python API Universe._partial_deepcopy() method", "output": "The _partial_deepcopy() method clone all of the openmc.universe object's attributes except for its cells,\n as they are copied within the clone function. this should only to be\n used within the openmc.universebase.clone() context.. It's used for universe operations." }, { "instruction": "How do you call the _partial_deepcopy() method in the Universe class?", "input": "OpenMC Python API Universe._partial_deepcopy() method signature", "output": "To call the _partial_deepcopy() method, use: def _partial_deepcopy(self: Any). It takes 1 parameters." }, { "instruction": "What does the change_directory() function do in OpenMC's Python API?", "input": "OpenMC Python API change_directory() function", "output": "The change_directory() function context manager for executing in a provided working directory. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the change_directory() function in OpenMC's Python API?", "input": "OpenMC Python API change_directory() function purpose", "output": "The change_directory() function context manager for executing in a provided working directory. It's part of OpenMC's Python API." }, { "instruction": "How do you call the change_directory() function in OpenMC's Python API?", "input": "OpenMC Python API change_directory() function signature", "output": "To call the change_directory() function, use: @contextmanager def change_directory(working_dir: Any). It takes 1 parameters." }, { "instruction": "What does the working_dir parameter do in the change_directory() function?", "input": "OpenMC Python API change_directory() parameter working_dir", "output": "The working_dir parameter directory to switch to.. It should be a path-like value." }, { "instruction": "What does the tmpdir parameter do in the change_directory() function?", "input": "OpenMC Python API change_directory() parameter tmpdir", "output": "The tmpdir parameter whether to use a temporary directory instead of a specific working directory. It should be a bool value." }, { "instruction": "What does the input_path() function do in OpenMC's Python API?", "input": "OpenMC Python API input_path() function", "output": "The input_path() function return a path object for an input file based on global configuration. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the input_path() function in OpenMC's Python API?", "input": "OpenMC Python API input_path() function purpose", "output": "The input_path() function return a path object for an input file based on global configuration. It's part of OpenMC's Python API." }, { "instruction": "How do you call the input_path() function in OpenMC's Python API?", "input": "OpenMC Python API input_path() function signature", "output": "To call the input_path() function, use: def input_path(filename: PathLike). It takes 1 parameters." }, { "instruction": "What does the filename parameter do in the input_path() function?", "input": "OpenMC Python API input_path() parameter filename", "output": "The filename parameter path to input file. It should be a PathLike value." }, { "instruction": "What is the VolumeCalculation class in OpenMC's Python API?", "input": "OpenMC Python API VolumeCalculation class", "output": "The VolumeCalculation class represents stochastic volume calculation specifications and results. It provides 26 methods and 0 properties for working with volumecalculation data in OpenMC." }, { "instruction": "What does the VolumeCalculation class do in OpenMC's Python API?", "input": "OpenMC Python API VolumeCalculation class description", "output": "The VolumeCalculation class stochastic volume calculation specifications and results. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the domains parameter do when creating a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation constructor parameter domains", "output": "When creating a VolumeCalculation, the domains parameter specifies domains to find volumes of. It should be a Iterable of openmc.Cell, openmc.Material, or openmc.Universe value." }, { "instruction": "What does the samples parameter do when creating a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation constructor parameter samples", "output": "When creating a VolumeCalculation, the samples parameter specifies number of samples used to generate volume estimates. It should be a int value." }, { "instruction": "What does the lower_left parameter do when creating a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation constructor parameter lower_left", "output": "When creating a VolumeCalculation, the lower_left parameter specifies lower-left coordinates of bounding box used to sample points. if this argument is not supplied, an attempt is made to automatically determine a bounding box.. It should be a Iterable of float value." }, { "instruction": "What does the upper_right parameter do when creating a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation constructor parameter upper_right", "output": "When creating a VolumeCalculation, the upper_right parameter specifies upper-right coordinates of bounding box used to sample points. if this argument is not supplied, an attempt is made to automatically determine a bounding box.. It should be a Iterable of float value." }, { "instruction": "What is the ids attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute ids", "output": "The ids attribute of a VolumeCalculation contains ids of domains to find volumes of. It's a Iterable of int value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the domain_type attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute domain_type", "output": "The domain_type attribute of a VolumeCalculation contains type of each domain. It's a {'cell', 'material', 'universe'} value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the samples attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute samples", "output": "The samples attribute of a VolumeCalculation contains number of samples used to generate volume estimates. It's a int value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the lower_left attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute lower_left", "output": "The lower_left attribute of a VolumeCalculation contains lower-left coordinates of bounding box used to sample points. It's a Iterable of float value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the upper_right attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute upper_right", "output": "The upper_right attribute of a VolumeCalculation contains upper-right coordinates of bounding box used to sample points. It's a Iterable of float value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the atoms attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute atoms", "output": "The atoms attribute of a VolumeCalculation contains dictionary mapping unique ids of domains to a mapping of nuclides to total number of atoms for each nuclide present in the domain. for example, {10: {'u235': 1.0e22, 'u238': 5.0e22, ...}}.. It's a dict value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the atoms_dataframe attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute atoms_dataframe", "output": "The atoms_dataframe attribute of a VolumeCalculation contains dataframe showing the estimated number of atoms for each nuclide present in each domain specified.. It's a pandas.DataFrame value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the volumes attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute volumes", "output": "The volumes attribute of a VolumeCalculation contains dictionary mapping unique ids of domains to estimated volumes in cm^3.. It's a dict value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the threshold attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute threshold", "output": "The threshold attribute of a VolumeCalculation contains threshold for the maximum standard deviation of volumes. .. versionadded:: 0.12. It's a float value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the trigger_type attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute trigger_type", "output": "The trigger_type attribute of a VolumeCalculation contains value type used to halt volume calculation .. versionadded:: 0.12. It's a {'variance', 'std_dev', 'rel_err'} value that you can access after creating a VolumeCalculation instance." }, { "instruction": "What is the iterations attribute of a VolumeCalculation?", "input": "OpenMC Python API VolumeCalculation attribute iterations", "output": "The iterations attribute of a VolumeCalculation contains number of iterations over samples (for calculations with a trigger). .. versionadded:: 0.12. It's a int value that you can access after creating a VolumeCalculation instance." }, { "instruction": "How do you call the __init__() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, domains: Any, samples: Any, lower_left: Any, upper_right: Any). It takes 5 parameters." }, { "instruction": "How do you call the ids() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.ids() method signature", "output": "To call the ids() method, use: @property def ids(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the ids() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.ids() method signature", "output": "To call the ids() method, use: @ids.setter def ids(self: Any, ids: Any). It takes 2 parameters." }, { "instruction": "How do you call the samples() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.samples() method signature", "output": "To call the samples() method, use: @property def samples(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the samples() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.samples() method signature", "output": "To call the samples() method, use: @samples.setter def samples(self: Any, samples: Any). It takes 2 parameters." }, { "instruction": "How do you call the lower_left() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.lower_left() method signature", "output": "To call the lower_left() method, use: @property def lower_left(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_left() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.lower_left() method signature", "output": "To call the lower_left() method, use: @lower_left.setter def lower_left(self: Any, lower_left: Any). It takes 2 parameters." }, { "instruction": "How do you call the upper_right() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.upper_right() method signature", "output": "To call the upper_right() method, use: @property def upper_right(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_right() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.upper_right() method signature", "output": "To call the upper_right() method, use: @upper_right.setter def upper_right(self: Any, upper_right: Any). It takes 2 parameters." }, { "instruction": "How do you call the threshold() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.threshold() method signature", "output": "To call the threshold() method, use: @property def threshold(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the threshold() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.threshold() method signature", "output": "To call the threshold() method, use: @threshold.setter def threshold(self: Any, threshold: Any). It takes 2 parameters." }, { "instruction": "How do you call the trigger_type() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.trigger_type() method signature", "output": "To call the trigger_type() method, use: @property def trigger_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the trigger_type() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.trigger_type() method signature", "output": "To call the trigger_type() method, use: @trigger_type.setter def trigger_type(self: Any, trigger_type: Any). It takes 2 parameters." }, { "instruction": "How do you call the iterations() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.iterations() method signature", "output": "To call the iterations() method, use: @property def iterations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the iterations() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.iterations() method signature", "output": "To call the iterations() method, use: @iterations.setter def iterations(self: Any, iterations: Any). It takes 2 parameters." }, { "instruction": "How do you call the domain_type() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.domain_type() method signature", "output": "To call the domain_type() method, use: @property def domain_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atoms() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.atoms() method signature", "output": "To call the atoms() method, use: @property def atoms(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the atoms() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.atoms() method signature", "output": "To call the atoms() method, use: @atoms.setter def atoms(self: Any, atoms: Any). It takes 2 parameters." }, { "instruction": "How do you call the volumes() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.volumes() method signature", "output": "To call the volumes() method, use: @property def volumes(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the volumes() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.volumes() method signature", "output": "To call the volumes() method, use: @volumes.setter def volumes(self: Any, volumes: Any). It takes 2 parameters." }, { "instruction": "How do you call the atoms_dataframe() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.atoms_dataframe() method signature", "output": "To call the atoms_dataframe() method, use: @property def atoms_dataframe(self: Any). It takes 1 parameters." }, { "instruction": "What does the set_trigger() method do in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.set_trigger() method", "output": "The set_trigger() method set a trigger on the volume calculation .. versionadded:: 0.12. It's used for volumecalculation operations." }, { "instruction": "How do you call the set_trigger() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.set_trigger() method signature", "output": "To call the set_trigger() method, use: def set_trigger(self: Any, threshold: Any, trigger_type: Any). It takes 3 parameters." }, { "instruction": "What does the threshold parameter do in the set_trigger() method?", "input": "OpenMC Python API VolumeCalculation.set_trigger() parameter threshold", "output": "The threshold parameter threshold for the maximum standard deviation of volumes. It should be a float value." }, { "instruction": "What does the trigger_type parameter do in the set_trigger() method?", "input": "OpenMC Python API VolumeCalculation.set_trigger() parameter trigger_type", "output": "The trigger_type parameter value type used to halt volume calculation. It should be a {'variance', 'std_dev', 'rel_err'} value." }, { "instruction": "What does the from_hdf5() method do in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.from_hdf5() method", "output": "The from_hdf5() method load stochastic volume calculation results from hdf5 file. It's used for volumecalculation operations." }, { "instruction": "How do you call the from_hdf5() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the from_hdf5() method?", "input": "OpenMC Python API VolumeCalculation.from_hdf5() parameter filename", "output": "The filename parameter path to volume.h5 file. It should be a str value." }, { "instruction": "What does the load_results() method do in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.load_results() method", "output": "The load_results() method load stochastic volume calculation results from an hdf5 file. It's used for volumecalculation operations." }, { "instruction": "How do you call the load_results() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.load_results() method signature", "output": "To call the load_results() method, use: def load_results(self: Any, filename: Any). It takes 2 parameters." }, { "instruction": "What does the filename parameter do in the load_results() method?", "input": "OpenMC Python API VolumeCalculation.load_results() parameter filename", "output": "The filename parameter path to volume.h5 file. It should be a str value." }, { "instruction": "What does the to_xml_element() method do in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.to_xml_element() method", "output": "The to_xml_element() method return xml representation of the volume calculation. It's used for volumecalculation operations." }, { "instruction": "How do you call the to_xml_element() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing volume calculation data. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.from_xml_element() method", "output": "The from_xml_element() method generate volume calculation object from an xml element .. versionadded:: 0.13.0. It's used for volumecalculation operations." }, { "instruction": "How do you call the from_xml_element() method in the VolumeCalculation class?", "input": "OpenMC Python API VolumeCalculation.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: Any). It takes 2 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API VolumeCalculation.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the _waste_classification() function do in OpenMC's Python API?", "input": "OpenMC Python API _waste_classification() function", "output": "The _waste_classification() function classify a material for near-surface waste disposal. this method determines a waste classification for a material based on the nrc regulations (10 cfr 61.55). It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _waste_classification() function in OpenMC's Python API?", "input": "OpenMC Python API _waste_classification() function purpose", "output": "The _waste_classification() function classify a material for near-surface waste disposal. this method determines a waste classification for a material based on the nrc regulations (10 cfr 61.55). It's part of OpenMC's Python API." }, { "instruction": "How do you call the _waste_classification() function in OpenMC's Python API?", "input": "OpenMC Python API _waste_classification() function signature", "output": "To call the _waste_classification() function, use: def _waste_classification(mat: openmc.Material, metal: bool). It takes 2 parameters." }, { "instruction": "What does the mat parameter do in the _waste_classification() function?", "input": "OpenMC Python API _waste_classification() parameter mat", "output": "The mat parameter the material to classify.. It should be a openmc.Material value." }, { "instruction": "What does the metal parameter do in the _waste_classification() function?", "input": "OpenMC Python API _waste_classification() parameter metal", "output": "The metal parameter whether or not the material is in metal form. this changes the acceptable limits in tables 1 and 2 for certain nuclides.. It should be a bool, optional value." }, { "instruction": "What does the _waste_disposal_rating() function do in OpenMC's Python API?", "input": "OpenMC Python API _waste_disposal_rating() function", "output": "The _waste_disposal_rating() function return the waste disposal rating for a material. this method returns a waste disposal rating for the material based on a set of specific activity limits. the waste disposal rating is a single number that represents the sum of the ratios of the specific activity for each radionuclide in the material against a nuclide-specific limit. a value less than 1.0 indicates that the material \"meets\" the limits whereas a value greater than 1.0 exceeds the limits. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the _waste_disposal_rating() function in OpenMC's Python API?", "input": "OpenMC Python API _waste_disposal_rating() function purpose", "output": "The _waste_disposal_rating() function return the waste disposal rating for a material. this method returns a waste disposal rating for the material based on a set of specific activity limits. the waste disposal rating is a single number that represents the sum of the ratios of the specific activity for each radionuclide in the material against a nuclide-specific limit. a value less than 1.0 indicates that the material \"meets\" the limits whereas a value greater than 1.0 exceeds the limits. It's part of OpenMC's Python API." }, { "instruction": "How do you call the _waste_disposal_rating() function in OpenMC's Python API?", "input": "OpenMC Python API _waste_disposal_rating() function signature", "output": "To call the _waste_disposal_rating() function, use: def _waste_disposal_rating(mat: openmc.Material, limits: Any, metal: bool). It takes 3 parameters." }, { "instruction": "What does the mat parameter do in the _waste_disposal_rating() function?", "input": "OpenMC Python API _waste_disposal_rating() parameter mat", "output": "The mat parameter the material to classify.. It should be a openmc.Material value." }, { "instruction": "What does the limits parameter do in the _waste_disposal_rating() function?", "input": "OpenMC Python API _waste_disposal_rating() parameter limits", "output": "The limits parameter the name of a predefined set of specific activity limits or a dictionary that contains specific activity limits for radionuclides, where keys are nuclide names and values are activities in units of [ci/m3]. the predefined options are: - 'fetter': uses limits from fetter et al. (1990) - 'nrc_long': uses the 10 cfr 61.55 limits for long-lived radionuclides - 'nrc_short_a': uses the 10 cfr 61.55 class a limits for short-lived radionuclides - 'nrc_short_b': uses the 10 cfr 61.55 class b limits for short-lived radionuclides - 'nrc_short_c': uses the 10 cfr 61.55 class c limits for short-lived radionuclides. It should be a str or dict, optional value." }, { "instruction": "What does the metal parameter do in the _waste_disposal_rating() function?", "input": "OpenMC Python API _waste_disposal_rating() parameter metal", "output": "The metal parameter whether or not the material is in metal form (only applicable for nrc based limits). It should be a bool, optional value." }, { "instruction": "How do you call the classify_table2() function in OpenMC's Python API?", "input": "OpenMC Python API classify_table2() function signature", "output": "To call the classify_table2() function, use: def classify_table2(col1: Any, col2: Any, col3: Any). It takes 3 parameters." }, { "instruction": "What is the WeightWindows class in OpenMC's Python API?", "input": "OpenMC Python API WeightWindows class", "output": "The WeightWindows class represents mesh-based weight windows this class enables you to specify weight window parameters that are used in a simulation. multiple sets of weight windows can be defined for different meshes and different particles. an iterable of :class:`weightwindows` instances can be assigned to the :attr:`openmc.settings.weight_windows` attribute, which is then exported to xml. weight window lower/upper bounds are to be specified for each combination of a mesh element and an energy bin. thus the total number of bounds should be equal to the product of the number of mesh bins and the number of energy bins. .. versionadded:: 0.13. It provides 25 methods and 0 properties for working with weightwindows data in OpenMC." }, { "instruction": "What does the WeightWindows class do in OpenMC's Python API?", "input": "OpenMC Python API WeightWindows class description", "output": "The WeightWindows class mesh-based weight windows this class enables you to specify weight window parameters that are used in a simulation. multiple sets of weight windows can be defined for different meshes and different particles. an iterable of :class:`weightwindows` instances can be assigned to the :attr:`openmc.settings.weight_windows` attribute, which is then exported to xml. weight window lower/upper bounds are to be specified for each combination of a mesh element and an energy bin. thus the total number of bounds should be equal to the product of the number of mesh bins and the number of energy bins. .. versionadded:: 0.13. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter mesh", "output": "When creating a WeightWindows, the mesh parameter specifies mesh for the weight windows. It should be a openmc.MeshBase value." }, { "instruction": "What does the lower_ww_bounds parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter lower_ww_bounds", "output": "When creating a WeightWindows, the lower_ww_bounds parameter specifies a list of values for which each value is the lower bound of a weight window. It should be a Iterable of Real value." }, { "instruction": "What does the upper_ww_bounds parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter upper_ww_bounds", "output": "When creating a WeightWindows, the upper_ww_bounds parameter specifies a list of values for which each value is the upper bound of a weight window. It should be a Iterable of Real value." }, { "instruction": "What does the upper_bound_ratio parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter upper_bound_ratio", "output": "When creating a WeightWindows, the upper_bound_ratio parameter specifies ratio of the lower to upper weight window bounds. It should be a float value." }, { "instruction": "What does the energy_bounds parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter energy_bounds", "output": "When creating a WeightWindows, the energy_bounds parameter specifies a list of values for which each successive pair constitutes a range of energies in [ev] for a single bin. if no energy bins are provided, the maximum and minimum energy for the data available at runtime.. It should be a Iterable of Real value." }, { "instruction": "What does the particle_type parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter particle_type", "output": "When creating a WeightWindows, the particle_type parameter specifies particle type the weight windows apply to. It should be a {'neutron', 'photon'} value." }, { "instruction": "What does the survival_ratio parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter survival_ratio", "output": "When creating a WeightWindows, the survival_ratio parameter specifies ratio of the survival weight to the lower weight window bound for rouletting. It should be a float value." }, { "instruction": "What does the max_lower_bound_ratio parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter max_lower_bound_ratio", "output": "When creating a WeightWindows, the max_lower_bound_ratio parameter specifies maximum allowed ratio of a particle's weight to the weight window's lower bound. a factor will be applied to raise the weight window to be lower than the particle's weight by a factor of max_lower_bound_ratio during transport if exceeded.. It should be a float value." }, { "instruction": "What does the max_split parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter max_split", "output": "When creating a WeightWindows, the max_split parameter specifies maximum allowable number of particles when splitting. It should be a int value." }, { "instruction": "What does the weight_cutoff parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter weight_cutoff", "output": "When creating a WeightWindows, the weight_cutoff parameter specifies threshold below which particles will be terminated. It should be a float value." }, { "instruction": "What does the id parameter do when creating a WeightWindows?", "input": "OpenMC Python API WeightWindows constructor parameter id", "output": "When creating a WeightWindows, the id parameter specifies unique identifier for the weight window settings. if not specified, an identifier will automatically be assigned.. It should be a int value." }, { "instruction": "What is the id attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute id", "output": "The id attribute of a WeightWindows contains unique identifier for the weight window settings.. It's a int value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the mesh attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute mesh", "output": "The mesh attribute of a WeightWindows contains mesh for the weight windows with dimension (ni, nj, nk). It's a openmc.MeshBase value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the particle_type attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute particle_type", "output": "The particle_type attribute of a WeightWindows contains particle type the weight windows apply to. It's a str value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the energy_bounds attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute energy_bounds", "output": "The energy_bounds attribute of a WeightWindows contains a list of values for which each successive pair constitutes a range of energies in [ev] for a single bin. It's a Iterable of Real value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the num_energy_bins attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute num_energy_bins", "output": "The num_energy_bins attribute of a WeightWindows contains number of energy bins. It's a int value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the lower_ww_bounds attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute lower_ww_bounds", "output": "The lower_ww_bounds attribute of a WeightWindows contains an array of values for which each value is the lower bound of a weight window. shape: (ni, nj, nk, num_energy_bins) for structuredmesh; (num_elements, num_energy_bins) for unstructuredmesh. It's a numpy.ndarray of float value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the upper_ww_bounds attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute upper_ww_bounds", "output": "The upper_ww_bounds attribute of a WeightWindows contains an array of values for which each value is the upper bound of a weight window. shape: (ni, nj, nk, num_energy_bins) for structuredmesh; (num_elements, num_energy_bins) for unstructuredmesh. It's a numpy.ndarray of float value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the survival_ratio attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute survival_ratio", "output": "The survival_ratio attribute of a WeightWindows contains ratio of the survival weight to the lower weight window bound for rouletting. It's a float value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the max_lower_bound_ratio attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute max_lower_bound_ratio", "output": "The max_lower_bound_ratio attribute of a WeightWindows contains maximum allowed ratio of a particle's weight to the weight window's lower bound. (default: 1.0). It's a float value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the max_split attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute max_split", "output": "The max_split attribute of a WeightWindows contains maximum allowable number of particles when splitting. It's a int value that you can access after creating a WeightWindows instance." }, { "instruction": "What is the weight_cutoff attribute of a WeightWindows?", "input": "OpenMC Python API WeightWindows attribute weight_cutoff", "output": "The weight_cutoff attribute of a WeightWindows contains threshold below which particles will be terminated see also -------- openmc.settings. It's a float value that you can access after creating a WeightWindows instance." }, { "instruction": "How do you call the __init__() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: MeshBase, lower_ww_bounds: Any, upper_ww_bounds: Any, upper_bound_ratio: Any, energy_bounds: Any, particle_type: str, survival_ratio: float, max_lower_bound_ratio: Any, max_split: int, weight_cutoff: float, id: Any). It takes 12 parameters." }, { "instruction": "How do you call the __repr__() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the __eq__() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.__eq__() method signature", "output": "To call the __eq__() method, use: def __eq__(self: Any, other: WeightWindows). It takes 2 parameters." }, { "instruction": "How do you call the mesh() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, mesh: MeshBase). It takes 2 parameters." }, { "instruction": "How do you call the particle_type() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.particle_type() method signature", "output": "To call the particle_type() method, use: @property def particle_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the particle_type() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.particle_type() method signature", "output": "To call the particle_type() method, use: @particle_type.setter def particle_type(self: Any, pt: str). It takes 2 parameters." }, { "instruction": "How do you call the energy_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.energy_bounds() method signature", "output": "To call the energy_bounds() method, use: @property def energy_bounds(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.energy_bounds() method signature", "output": "To call the energy_bounds() method, use: @energy_bounds.setter def energy_bounds(self: Any, bounds: Any). It takes 2 parameters." }, { "instruction": "How do you call the num_energy_bins() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.num_energy_bins() method signature", "output": "To call the num_energy_bins() method, use: @property def num_energy_bins(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_ww_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.lower_ww_bounds() method signature", "output": "To call the lower_ww_bounds() method, use: @property def lower_ww_bounds(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the lower_ww_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.lower_ww_bounds() method signature", "output": "To call the lower_ww_bounds() method, use: @lower_ww_bounds.setter def lower_ww_bounds(self: Any, bounds: Any). It takes 2 parameters." }, { "instruction": "How do you call the upper_ww_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.upper_ww_bounds() method signature", "output": "To call the upper_ww_bounds() method, use: @property def upper_ww_bounds(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the upper_ww_bounds() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.upper_ww_bounds() method signature", "output": "To call the upper_ww_bounds() method, use: @upper_ww_bounds.setter def upper_ww_bounds(self: Any, bounds: Any). It takes 2 parameters." }, { "instruction": "How do you call the survival_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.survival_ratio() method signature", "output": "To call the survival_ratio() method, use: @property def survival_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the survival_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.survival_ratio() method signature", "output": "To call the survival_ratio() method, use: @survival_ratio.setter def survival_ratio(self: Any, val: float). It takes 2 parameters." }, { "instruction": "How do you call the max_lower_bound_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_lower_bound_ratio() method signature", "output": "To call the max_lower_bound_ratio() method, use: @property def max_lower_bound_ratio(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_lower_bound_ratio() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_lower_bound_ratio() method signature", "output": "To call the max_lower_bound_ratio() method, use: @max_lower_bound_ratio.setter def max_lower_bound_ratio(self: Any, val: float). It takes 2 parameters." }, { "instruction": "How do you call the max_split() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_split() method signature", "output": "To call the max_split() method, use: @property def max_split(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_split() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.max_split() method signature", "output": "To call the max_split() method, use: @max_split.setter def max_split(self: Any, val: int). It takes 2 parameters." }, { "instruction": "How do you call the weight_cutoff() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.weight_cutoff() method signature", "output": "To call the weight_cutoff() method, use: @property def weight_cutoff(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the weight_cutoff() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.weight_cutoff() method signature", "output": "To call the weight_cutoff() method, use: @weight_cutoff.setter def weight_cutoff(self: Any, cutoff: float). It takes 2 parameters." }, { "instruction": "What does the to_xml_element() method do in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.to_xml_element() method", "output": "The to_xml_element() method return an xml representation of the weight window settings. It's used for weightwindows operations." }, { "instruction": "How do you call the to_xml_element() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the to_xml_element() method return in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.to_xml_element() return value", "output": "The to_xml_element() method returns xml element containing the weight window information. The return type is lxml.etree._Element." }, { "instruction": "What does the from_xml_element() method do in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.from_xml_element() method", "output": "The from_xml_element() method generate weight window settings from an xml element. It's used for weightwindows operations." }, { "instruction": "How do you call the from_xml_element() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API WeightWindows.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a lxml.etree._Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API WeightWindows.from_xml_element() parameter meshes", "output": "The meshes parameter dictionary mapping ids to mesh objects. It should be a dict value." }, { "instruction": "What does the from_hdf5() method do in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.from_hdf5() method", "output": "The from_hdf5() method create weight windows from hdf5 group. It's used for weightwindows operations." }, { "instruction": "How do you call the from_hdf5() method in the WeightWindows class?", "input": "OpenMC Python API WeightWindows.from_hdf5() method signature", "output": "To call the from_hdf5() method, use: @classmethod def from_hdf5(cls: Any, group: h5py.Group, meshes: Any). It takes 3 parameters." }, { "instruction": "What does the group parameter do in the from_hdf5() method?", "input": "OpenMC Python API WeightWindows.from_hdf5() parameter group", "output": "The group parameter group in hdf5 file. It should be a h5py.Group value." }, { "instruction": "What does the meshes parameter do in the from_hdf5() method?", "input": "OpenMC Python API WeightWindows.from_hdf5() parameter meshes", "output": "The meshes parameter dictionary mapping ids to mesh objects. It should be a dict value." }, { "instruction": "What is the WeightWindowGenerator class in OpenMC's Python API?", "input": "OpenMC Python API WeightWindowGenerator class", "output": "The WeightWindowGenerator class represents class passed to setting to govern weight window generation using the openmc executable. It provides 23 methods and 0 properties for working with weightwindowgenerator data in OpenMC." }, { "instruction": "What does the WeightWindowGenerator class do in OpenMC's Python API?", "input": "OpenMC Python API WeightWindowGenerator class description", "output": "The WeightWindowGenerator class class passed to setting to govern weight window generation using the openmc executable. It's used in OpenMC's Python API for nuclear data operations." }, { "instruction": "What does the mesh parameter do when creating a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator constructor parameter mesh", "output": "When creating a WeightWindowGenerator, the mesh parameter specifies mesh used to represent the weight windows spatially. It should be a :class:`openmc.MeshBase` value." }, { "instruction": "What does the energy_bounds parameter do when creating a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator constructor parameter energy_bounds", "output": "When creating a WeightWindowGenerator, the energy_bounds parameter specifies a list of values for which each successive pair constitutes a range of energies in [ev] for a single bin. if no energy bins are provided, the maximum and minimum energy for the data available at runtime.. It should be a Iterable of Real value." }, { "instruction": "What does the particle_type parameter do when creating a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator constructor parameter particle_type", "output": "When creating a WeightWindowGenerator, the particle_type parameter specifies particle type the weight windows apply to. It should be a {'neutron', 'photon'} value." }, { "instruction": "What does the method parameter do when creating a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator constructor parameter method", "output": "When creating a WeightWindowGenerator, the method parameter specifies the weight window generation methodology applied during an update.. It should be a {'magic', 'fw_cadis'} value." }, { "instruction": "What does the max_realizations parameter do when creating a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator constructor parameter max_realizations", "output": "When creating a WeightWindowGenerator, the max_realizations parameter specifies the upper limit for number of tally realizations when generating weight windows.. It should be a int value." }, { "instruction": "What does the update_interval parameter do when creating a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator constructor parameter update_interval", "output": "When creating a WeightWindowGenerator, the update_interval parameter specifies the number of tally realizations between updates.. It should be a int value." }, { "instruction": "What does the on_the_fly parameter do when creating a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator constructor parameter on_the_fly", "output": "When creating a WeightWindowGenerator, the on_the_fly parameter specifies whether or not to apply weight windows on the fly.. It should be a bool value." }, { "instruction": "What is the mesh attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute mesh", "output": "The mesh attribute of a WeightWindowGenerator contains mesh used to represent the weight windows spatially. It's a openmc.MeshBase value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "What is the energy_bounds attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute energy_bounds", "output": "The energy_bounds attribute of a WeightWindowGenerator contains a list of values for which each successive pair constitutes a range of energies in [ev] for a single bin. It's a Iterable of Real value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "What is the particle_type attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute particle_type", "output": "The particle_type attribute of a WeightWindowGenerator contains particle type the weight windows apply to. It's a {'neutron', 'photon'} value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "What is the method attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute method", "output": "The method attribute of a WeightWindowGenerator contains the weight window generation methodology applied during an update.. It's a {'magic', 'fw_cadis'} value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "What is the max_realizations attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute max_realizations", "output": "The max_realizations attribute of a WeightWindowGenerator contains the upper limit for number of tally realizations when generating weight windows.. It's a int value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "What is the update_interval attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute update_interval", "output": "The update_interval attribute of a WeightWindowGenerator contains the number of tally realizations between updates.. It's a int value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "What is the update_parameters attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute update_parameters", "output": "The update_parameters attribute of a WeightWindowGenerator contains a set of parameters related to the update.. It's a dict value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "What is the on_the_fly attribute of a WeightWindowGenerator?", "input": "OpenMC Python API WeightWindowGenerator attribute on_the_fly", "output": "The on_the_fly attribute of a WeightWindowGenerator contains whether or not to apply weight windows on the fly.. It's a bool value that you can access after creating a WeightWindowGenerator instance." }, { "instruction": "How do you call the __init__() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.__init__() method signature", "output": "To call the __init__() method, use: def __init__(self: Any, mesh: openmc.MeshBase, energy_bounds: Any, particle_type: str, method: str, max_realizations: int, update_interval: int, on_the_fly: bool). It takes 8 parameters." }, { "instruction": "How do you call the __repr__() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.__repr__() method signature", "output": "To call the __repr__() method, use: def __repr__(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.mesh() method signature", "output": "To call the mesh() method, use: @property def mesh(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the mesh() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.mesh() method signature", "output": "To call the mesh() method, use: @mesh.setter def mesh(self: Any, m: openmc.MeshBase). It takes 2 parameters." }, { "instruction": "How do you call the energy_bounds() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.energy_bounds() method signature", "output": "To call the energy_bounds() method, use: @property def energy_bounds(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the energy_bounds() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.energy_bounds() method signature", "output": "To call the energy_bounds() method, use: @energy_bounds.setter def energy_bounds(self: Any, eb: Any). It takes 2 parameters." }, { "instruction": "How do you call the particle_type() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.particle_type() method signature", "output": "To call the particle_type() method, use: @property def particle_type(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the particle_type() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.particle_type() method signature", "output": "To call the particle_type() method, use: @particle_type.setter def particle_type(self: Any, pt: str). It takes 2 parameters." }, { "instruction": "How do you call the method() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.method() method signature", "output": "To call the method() method, use: @property def method(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the method() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.method() method signature", "output": "To call the method() method, use: @method.setter def method(self: Any, m: str). It takes 2 parameters." }, { "instruction": "How do you call the max_realizations() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.max_realizations() method signature", "output": "To call the max_realizations() method, use: @property def max_realizations(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the max_realizations() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.max_realizations() method signature", "output": "To call the max_realizations() method, use: @max_realizations.setter def max_realizations(self: Any, m: int). It takes 2 parameters." }, { "instruction": "How do you call the update_interval() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.update_interval() method signature", "output": "To call the update_interval() method, use: @property def update_interval(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the update_interval() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.update_interval() method signature", "output": "To call the update_interval() method, use: @update_interval.setter def update_interval(self: Any, ui: int). It takes 2 parameters." }, { "instruction": "How do you call the update_parameters() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.update_parameters() method signature", "output": "To call the update_parameters() method, use: @property def update_parameters(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the _check_update_parameters() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator._check_update_parameters() method signature", "output": "To call the _check_update_parameters() method, use: def _check_update_parameters(self: Any, params: dict). It takes 2 parameters." }, { "instruction": "How do you call the update_parameters() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.update_parameters() method signature", "output": "To call the update_parameters() method, use: @update_parameters.setter def update_parameters(self: Any, params: dict). It takes 2 parameters." }, { "instruction": "How do you call the on_the_fly() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.on_the_fly() method signature", "output": "To call the on_the_fly() method, use: @property def on_the_fly(self: Any). It takes 1 parameters." }, { "instruction": "How do you call the on_the_fly() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.on_the_fly() method signature", "output": "To call the on_the_fly() method, use: @on_the_fly.setter def on_the_fly(self: Any, otf: bool). It takes 2 parameters." }, { "instruction": "How do you call the _update_parameters_subelement() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator._update_parameters_subelement() method signature", "output": "To call the _update_parameters_subelement() method, use: def _update_parameters_subelement(self: Any, element: ET.Element). It takes 2 parameters." }, { "instruction": "What does the _sanitize_update_parameters() method do in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator._sanitize_update_parameters() method", "output": "The _sanitize_update_parameters() method attempt to convert update parameters to their appropriate types. It's used for weightwindowgenerator operations." }, { "instruction": "How do you call the _sanitize_update_parameters() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator._sanitize_update_parameters() method signature", "output": "To call the _sanitize_update_parameters() method, use: @classmethod def _sanitize_update_parameters(cls: Any, method: str, update_parameters: dict). It takes 3 parameters." }, { "instruction": "What does the method parameter do in the _sanitize_update_parameters() method?", "input": "OpenMC Python API WeightWindowGenerator._sanitize_update_parameters() parameter method", "output": "The method parameter the update method for which these update parameters should comply. It should be a str value." }, { "instruction": "What does the update_parameters parameter do in the _sanitize_update_parameters() method?", "input": "OpenMC Python API WeightWindowGenerator._sanitize_update_parameters() parameter update_parameters", "output": "The update_parameters parameter the update parameters as-read from the xml node (keys: str, values: str). It should be a dict value." }, { "instruction": "What does the to_xml_element() method do in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.to_xml_element() method", "output": "The to_xml_element() method creates a 'weight_window_generator' element to be written to an xml file.. It's used for weightwindowgenerator operations." }, { "instruction": "How do you call the to_xml_element() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.to_xml_element() method signature", "output": "To call the to_xml_element() method, use: def to_xml_element(self: Any). It takes 1 parameters." }, { "instruction": "What does the from_xml_element() method do in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.from_xml_element() method", "output": "The from_xml_element() method create a weight window generation object from an xml element. It's used for weightwindowgenerator operations." }, { "instruction": "How do you call the from_xml_element() method in the WeightWindowGenerator class?", "input": "OpenMC Python API WeightWindowGenerator.from_xml_element() method signature", "output": "To call the from_xml_element() method, use: @classmethod def from_xml_element(cls: Any, elem: ET.Element, meshes: dict). It takes 3 parameters." }, { "instruction": "What does the elem parameter do in the from_xml_element() method?", "input": "OpenMC Python API WeightWindowGenerator.from_xml_element() parameter elem", "output": "The elem parameter xml element. It should be a xml.etree.ElementTree.Element value." }, { "instruction": "What does the meshes parameter do in the from_xml_element() method?", "input": "OpenMC Python API WeightWindowGenerator.from_xml_element() parameter meshes", "output": "The meshes parameter a dictionary with ids as keys and openmc.meshbase instances as values. It should be a dict value." }, { "instruction": "What does the wwinp_to_wws() function do in OpenMC's Python API?", "input": "OpenMC Python API wwinp_to_wws() function", "output": "The wwinp_to_wws() function create weightwindows instances from a wwinp file .. versionadded:: 0.13.1. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the wwinp_to_wws() function in OpenMC's Python API?", "input": "OpenMC Python API wwinp_to_wws() function purpose", "output": "The wwinp_to_wws() function create weightwindows instances from a wwinp file .. versionadded:: 0.13.1. It's part of OpenMC's Python API." }, { "instruction": "How do you call the wwinp_to_wws() function in OpenMC's Python API?", "input": "OpenMC Python API wwinp_to_wws() function signature", "output": "To call the wwinp_to_wws() function, use: def wwinp_to_wws(path: PathLike). It takes 1 parameters." }, { "instruction": "What does the path parameter do in the wwinp_to_wws() function?", "input": "OpenMC Python API wwinp_to_wws() parameter path", "output": "The path parameter path to the wwinp file. It should be a str or pathlib.Path value." }, { "instruction": "What does the hdf5_to_wws() function do in OpenMC's Python API?", "input": "OpenMC Python API hdf5_to_wws() function", "output": "The hdf5_to_wws() function create weightwindows instances from a weight windows hdf5 file .. versionadded:: 0.14.0. It's used for Python operations in OpenMC." }, { "instruction": "What is the purpose of the hdf5_to_wws() function in OpenMC's Python API?", "input": "OpenMC Python API hdf5_to_wws() function purpose", "output": "The hdf5_to_wws() function create weightwindows instances from a weight windows hdf5 file .. versionadded:: 0.14.0. It's part of OpenMC's Python API." }, { "instruction": "How do you call the hdf5_to_wws() function in OpenMC's Python API?", "input": "OpenMC Python API hdf5_to_wws() function signature", "output": "To call the hdf5_to_wws() function, use: def hdf5_to_wws(path: Any). It takes 1 parameters." }, { "instruction": "What does the path parameter do in the hdf5_to_wws() function?", "input": "OpenMC Python API hdf5_to_wws() parameter path", "output": "The path parameter path to the weight windows hdf5 file. It should be a cv.PathLike value." } ]