montepy.surface_collection module

Classes:

Surfaces([surfaces, problem])

A collection of multiple montepy.surfaces.surface.Surface instances.

class montepy.surface_collection.Surfaces(surfaces: list = None, problem: MCNP_Problem = None)

Bases: NumberedObjectCollection

A collection of multiple montepy.surfaces.surface.Surface instances.

This collection has a generator for every supported type of MCNP surface. These are accessed by the for lower case version of the MCNP mnemonic. For example you can access all planes normal to the z-axis through .pz

This example will shift all PZ surfaces up by 10 cm.

import montepy
problem = montepy.read_input("tests/inputs/test.imcnp")
for surface in problem.surfaces.pz:
    surface.location += 10

Notes

For examples see the NumberedObjectCollection Examples.

Parameters:

• surfaces (list) – the list of surfaces to start with if needed

• problem (montepy.MCNP_Problem)

Methods:

add(obj)	Add the given object to this collection.
append(obj, **kwargs)	Appends the given object to the end of this collection.
append_renumber(obj[, step])	Appends the object, but will renumber the object if collision occurs.
check_number(number)	Checks if the number is already in use, and if so raises an error.
clear()	Removes all objects from this collection.
clone([starting_number, step])	Create a new instance of this collection, with all new independent objects with new numbers.
difference(*others)	Return a new collection with elements from collection, that are not in the others.
difference_update(*others)	Update the new collection removing all elements from others.
discard(obj)	Remove the object from the collection if it is present.
extend(other_list)	Extends this collection with another list.
get(i[, default])	Get i if possible, or else return default.
intersection(*others)	Return a new collection with all elements in common in collection, and all others.
intersection_update(*others)	Update the collection keeping all elements in common in collection, and all others.
isdisjoint(other)	Test if there are no elements in common between the collection, and other.
issubset(other)	Test whether every element in the collection is in other.
issuperset(other)	Test whether every element in other is in the collection.
items()	Get iterator of the collections (number, object) pairs.
keys()	Get iterator of the collection's numbers.
link_to_problem(problem)	Links the card to the parent problem for this card.
next_number([step])	Get the next available number, based on the maximum number.
pop([pos])	Pop the final items off of the collection
remove(delete)	Removes the given object from the collection.
request_number([start_num, step])	Requests a new available number.
symmetric_difference(other)	Return a new collection with elements in either the collection or the other, but not both.
symmetric_difference_update(other)	Update the collection, keeping only elements found in either collection, but not in both.
union(*others)	Return a new collection with all elements from collection, and all others.
update(*objs)	Add the given objects to this collection.
values()	Get iterator of the collection's objects.

Attributes:

arb	Generator for getting all surfaces of type arbitrary polyhedron or ARB
box	Generator for getting all surfaces of type orthogonal box or BOX
c_x	Generator for getting all surfaces of type cylinder parallel to x-axis or C/X
c_y	Generator for getting all surfaces of type cylinder parallel to y-axis or C/Y
c_z	Generator for getting all surfaces of type cylinder parallel to z-axis or C/Z
cx	Generator for getting all surfaces of type cylinder on x-axis or CX
cy	Generator for getting all surfaces of type cylinder on y-axis or CY
cz	Generator for getting all surfaces of type cylinder on z-axis or CZ
ell	Generator for getting all surfaces of type ellipsoid or ELL
gq	Generator for getting all surfaces of type cylinder, cone, ellipsoid hyperboloid, or parabaloid not parallel to an axis or GQ
hex	Generator for getting all surfaces of type right hexagonal prism or HEX
k_x	Generator for getting all surfaces of type cone parallel to x-axis or K/X
k_y	Generator for getting all surfaces of type cone parallel to y-axis or K/Y
k_z	Generator for getting all surfaces of type cone parallel to z-axis or K/Z
kx	Generator for getting all surfaces of type cone on x-axis or KX
ky	Generator for getting all surfaces of type cone on y-axis or KY
kz	Generator for getting all surfaces of type cone on z-axis or KZ
numbers	A generator of the numbers being used.
objects	Returns a shallow copy of the internal objects list.
p	Generator for getting all surfaces of type general plane or P
px	Generator for getting all surfaces of type plane normal to x-axis or PX
py	Generator for getting all surfaces of type plane normal to y-axis or PY
pz	Generator for getting all surfaces of type plane normal to z-axis or PZ
rcc	Generator for getting all surfaces of type right circular cylinder or RCC
rec	Generator for getting all surfaces of type right elliptical cylinder or REC
rhp	Generator for getting all surfaces of type right hexagonal prism or RHP
rpp	Generator for getting all surfaces of type rectangular parallelepiped or RPP
s	Generator for getting all surfaces of type general sphere or S
so	Generator for getting all surfaces of type sphere centered at origin or SO
sph	Generator for getting all surfaces of type sphere or SPH
sq	Generator for getting all surfaces of type ellipsoid, hyperboloid, or paraboloid parallel to an axis or SQ
starting_number	The starting number to use when an object is cloned.
step	The step size to use to find a valid number during cloning.
sx	Generator for getting all surfaces of type sphere centered on x-axis or SX
sy	Generator for getting all surfaces of type sphere centered on y-axis or SY
sz	Generator for getting all surfaces of type sphere centered on z-axis or SZ
trc	Generator for getting all surfaces of type truncated right-angle cone or TRC
tx	Generator for getting all surfaces of type elliptical torus parallel to x-axis or TX
ty	Generator for getting all surfaces of type elliptical torus parallel to y-axis or TY
tz	Generator for getting all surfaces of type elliptical torus parallel to z-axis or TZ
wed	Generator for getting all surfaces of type wedge or WED
x	Generator for getting all surfaces of type axisymmetric surface defined by points or X
y	Generator for getting all surfaces of type axisymmetric surface defined by points or Y
z	Generator for getting all surfaces of type axisymmetric surface defined by points or Z

add(obj: Numbered_MCNP_Object)

Add the given object to this collection.

Parameters:

obj (Numbered_MCNP_Object) – The object to add.

Raises:

• TypeError – if the object is of the wrong type.

• NumberConflictError – if this object’s number is already in use in the collection.

append(obj, **kwargs)

Appends the given object to the end of this collection.

Parameters:

• obj (Numbered_MCNP_Object) – the object to add.

• **kwargs – extra arguments that are used internally.

Raises:

NumberConflictError – if this object has a number that is already in use.

append_renumber(obj, step=1)

Appends the object, but will renumber the object if collision occurs.

This behaves like append, except if there is a number collision the object will be renumbered to an available number. The number will be incremented by step until an available number is found.

Parameters:

• obj (Numbered_MCNP_Object) – The MCNP object being added to the collection.

• step (int) – the incrementing step to use to find a new number.

Returns:

the number for the object.

Return type:

int

check_number(number)

Checks if the number is already in use, and if so raises an error.

Parameters:

number (int) – The number to check.

Raises:

NumberConflictError – if this number is in use.

clear()

Removes all objects from this collection.

clone(starting_number=None, step=None)

Create a new instance of this collection, with all new independent objects with new numbers.

This relies mostly on copy.deepcopy.

Notes

If starting_number, or step are not specified starting_number(), and step() are used as default values.

Added in version 0.5.0.

Parameters:

• starting_number (int) – The starting number to request for a new object numbers.

• step (int) – the step size to use to find a new valid number.

Returns:

a cloned copy of this object.

Return type:

type(self)

difference(*others: Self)

Return a new collection with elements from collection, that are not in the others.

collection - other - ...

Added in version 1.0.0.

Parameters:

*others (Self) – the other collections to compare to.

Return type:

Self

difference_update(*others: Self)

Update the new collection removing all elements from others.

collection -= other | ...

Added in version 1.0.0.

Parameters:

*others (Self) – the other collections to compare to.

discard(obj: Numbered_MCNP_Object)

Remove the object from the collection if it is present.

Added in version 1.0.0.

Parameters:

obj (Numbered_MCNP_Object) – the object to remove.

extend(other_list)

Extends this collection with another list.

Parameters:

other_list (list) – the list of objects to add.

Raises:

NumberConflictError – if these items conflict with existing elements.

get(i, default=None)

Get i if possible, or else return default.

Parameters:

• i (int) – number of the object to get, not it’s location in the internal list

• default (object) – value to return if not found

Return type:

Numbered_MCNP_Object

intersection(*others: Self)

Return a new collection with all elements in common in collection, and all others.

collection & other & ...

Added in version 1.0.0.

Parameters:

*others (Self) – the other collections to compare to.

Return type:

Self

intersection_update(*others: Self)

Update the collection keeping all elements in common in collection, and all others.

collection &= other & ...

Added in version 1.0.0.

Parameters:

*others (Self) – the other collections to compare to.

isdisjoint(other: Self)

Test if there are no elements in common between the collection, and other.

Collections are disjoint if and only if their intersection is the empty set.

Added in version 1.0.0.

Parameters:

other (Self) – the set to compare to.

Return type:

bool

issubset(other: Self)

Test whether every element in the collection is in other.

collection <= other

Added in version 1.0.0.

Parameters:

other (Self) – the set to compare to.

Return type:

bool

issuperset(other: Self)

Test whether every element in other is in the collection.

collection >= other

Added in version 1.0.0.

Parameters:

other (Self) – the set to compare to.

Return type:

bool

items() → Generator[Tuple[int, Numbered_MCNP_Object], None, None]

Get iterator of the collections (number, object) pairs.

Return type:

tuple(int, MCNP_Object)

keys() → Generator[int, None, None]

Get iterator of the collection’s numbers.

Return type:

int

link_to_problem(problem)

Links the card to the parent problem for this card.

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

Parameters:

problem (MCNP_Problem) – The problem to link this card to.

next_number(step=1)

Get the next available number, based on the maximum number.

This works by finding the current maximum number, and then adding the stepsize to it.

Parameters:

step (int) – how much to increase the last number by

pop(pos=-1)

Pop the final items off of the collection

Parameters:

pos (int) – The index of the element to pop from the internal list.

Returns:

the final elements

Return type:

Numbered_MCNP_Object

remove(delete)

Removes the given object from the collection.

Parameters:

delete (Numbered_MCNP_Object) – the object to delete

request_number(start_num=None, step=None)

Requests a new available number.

This method does not “reserve” this number. Objects should be immediately added to avoid possible collisions caused by shifting numbers of other objects in the collection.

Notes

If starting_number, or step are not specified starting_number(), and step() are used as default values.

Changed in version 0.5.0: In 0.5.0 the default values were changed to reference starting_number() and step().

Parameters:

• start_num (int) – the starting number to check.

• step (int) – the increment to jump by to find new numbers.

Returns:

an available number

Return type:

int

symmetric_difference(other: Self)

Return a new collection with elements in either the collection or the other, but not both.

collection ^ other

Added in version 1.0.0.

Parameters:

• others (Self) – the other collections to compare to.

• other (Self)

Return type:

Self

symmetric_difference_update(other: Self)

Update the collection, keeping only elements found in either collection, but not in both.

collection ^= other

Added in version 1.0.0.

Parameters:

• others (Self) – the other collections to compare to.

• other (Self)

union(*others: Self)

Return a new collection with all elements from collection, and all others.

collection | other | ...

Added in version 1.0.0.

Parameters:

*others (Self) – the other collections to compare to.

Return type:

Self

update(*objs: Self)

Add the given objects to this collection.

Notes

This is not a thread-safe method.

Changed in version 1.0.0: Changed to be more set like. Accepts multiple arguments. If there is a number conflict, the current object will be kept.

Parameters:

*objs (list[Numbered_MCNP_Object]) – The objects to add.

Raises:

• TypeError – if the object is of the wrong type.

• NumberConflictError – if this object’s number is already in use in the collection.

values() → Generator[Numbered_MCNP_Object, None, None]

Get iterator of the collection’s objects.

Return type:

Numbered_MCNP_Object

property arb

Generator for getting all surfaces of type arbitrary polyhedron or ARB

property box

Generator for getting all surfaces of type orthogonal box or BOX

property c_x

Generator for getting all surfaces of type cylinder parallel to x-axis or C/X

property c_y

Generator for getting all surfaces of type cylinder parallel to y-axis or C/Y

property c_z

Generator for getting all surfaces of type cylinder parallel to z-axis or C/Z

property cx

Generator for getting all surfaces of type cylinder on x-axis or CX

property cy

Generator for getting all surfaces of type cylinder on y-axis or CY

property cz

Generator for getting all surfaces of type cylinder on z-axis or CZ

property ell

Generator for getting all surfaces of type ellipsoid or ELL

property gq

Generator for getting all surfaces of type cylinder, cone, ellipsoid hyperboloid, or parabaloid not parallel to an axis or GQ

property hex

Generator for getting all surfaces of type right hexagonal prism or HEX

property k_x

Generator for getting all surfaces of type cone parallel to x-axis or K/X

property k_y

Generator for getting all surfaces of type cone parallel to y-axis or K/Y

property k_z

Generator for getting all surfaces of type cone parallel to z-axis or K/Z

property kx

Generator for getting all surfaces of type cone on x-axis or KX

property ky

Generator for getting all surfaces of type cone on y-axis or KY

property kz

Generator for getting all surfaces of type cone on z-axis or KZ

property numbers

A generator of the numbers being used.

Return type:

generator

property objects

Returns a shallow copy of the internal objects list.

The list object is a new instance, but the underlying objects are the same.

Return type:

list

property p

Generator for getting all surfaces of type general plane or P

property px

Generator for getting all surfaces of type plane normal to x-axis or PX

property py

Generator for getting all surfaces of type plane normal to y-axis or PY

property pz

Generator for getting all surfaces of type plane normal to z-axis or PZ

property rcc

Generator for getting all surfaces of type right circular cylinder or RCC

property rec

Generator for getting all surfaces of type right elliptical cylinder or REC

property rhp

Generator for getting all surfaces of type right hexagonal prism or RHP

property rpp

Generator for getting all surfaces of type rectangular parallelepiped or RPP

property s

Generator for getting all surfaces of type general sphere or S

property so

Generator for getting all surfaces of type sphere centered at origin or SO

property sph

Generator for getting all surfaces of type sphere or SPH

property sq

Generator for getting all surfaces of type ellipsoid, hyperboloid, or paraboloid parallel to an axis or SQ

property starting_number

The starting number to use when an object is cloned.

Returns:

the starting number

Return type:

int

property step

The step size to use to find a valid number during cloning.

Returns:

the step size

Return type:

int

property sx

Generator for getting all surfaces of type sphere centered on x-axis or SX

property sy

Generator for getting all surfaces of type sphere centered on y-axis or SY

property sz

Generator for getting all surfaces of type sphere centered on z-axis or SZ

property trc

Generator for getting all surfaces of type truncated right-angle cone or TRC

property tx

Generator for getting all surfaces of type elliptical torus parallel to x-axis or TX

property ty

Generator for getting all surfaces of type elliptical torus parallel to y-axis or TY

property tz

Generator for getting all surfaces of type elliptical torus parallel to z-axis or TZ

property wed

Generator for getting all surfaces of type wedge or WED

property x

Generator for getting all surfaces of type axisymmetric surface defined by points or X

property y

Generator for getting all surfaces of type axisymmetric surface defined by points or Y

property z

Generator for getting all surfaces of type axisymmetric surface defined by points or Z