pyg4ometry.mcnp.Surfaces¶

Classes¶

`P`	Plane (general)
`PX`	Plane (normal to x-axis)
`PY`	Plane (normal to y-axis)
`PZ`	Plane (normal to z-axis)
`SO`	Sphere (centered at origin)
`S`	Sphere (general)
`SX`	Sphere (centered on x-axis)
`SY`	Sphere (centered on y-axis)
`SZ`	Sphere (centered on z-axis)
`C_X`	Cylinder (parallel to x-axis)
`C_Y`	Cylinder (parallel to y-axis)
`C_Z`	Cylinder (parallel to z-axis)
`CX`	Cylinder (on x-axis)
`CY`	Cylinder (on y-axis)
`CZ`	Cylinder (on z-axis)
`K_X`	Cone (parallel to x-axis)
`K_Y`	Cone (parallel to y-axis)
`K_Z`	Cone (parallel to z-axis)
`KX`	Cone (on x-axis)
`KY`	Cone (on y-axis)
`KZ`	Cone (on z-axis)
`SQ`	Ellipsoid, Hyperboloid, Paraboloid
`GQ`	Cylinder, Cone, Ellipsoid, Hyperboloid, Paraboloid
`TX`	Elliptical or Circular Torus
`TY`	Elliptical or Circular Torus
`TZ`	Elliptical or Circular Torus
`BOX`	Macrobody: Box
`RPP`	Macrobody: Rectangular Parallelepiped
`SPH`	Macrobody: Sphere
`RCC`	Macrobody: Right Circular Cylinder
`RHP_HEX`	Macrobody: Right Hexagonal Prism
`REC`	Macrobody: Right Elliptical Cylinder
`TRC`	Macrobody: Truncated Right-Angle Cone
`ELL`	Macrobody: Ellipsoid
`WED`	Macrobody: Wedge
`ARB`	Macrobody: Arbitrary Polyhedron

Module Contents¶

class pyg4ometry.mcnp.Surfaces.P(A, B, C, D, reg=None, surfaceNumber=None)¶

Plane (general)

A¶

B¶

C¶

D¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.PX(D, reg=None, surfaceNumber=None)¶

Plane (normal to x-axis)

D¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.PY(D, reg=None, surfaceNumber=None)¶

Plane (normal to y-axis)

D¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.PZ(D, reg=None, surfaceNumber=None)¶

Plane (normal to z-axis)

D¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.SO(R, reg=None, surfaceNumber=None)¶

Sphere (centered at origin)

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.S(x, y, z, R, reg=None, surfaceNumber=None)¶

Sphere (general)

x¶

y¶

z¶

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.SX(x, R, reg=None, surfaceNumber=None)¶

Sphere (centered on x-axis)

x¶

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.SY(y, R, reg=None, surfaceNumber=None)¶

Sphere (centered on y-axis)

y¶

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.SZ(z, R, reg=None, surfaceNumber=None)¶

Sphere (centered on z-axis)

z¶

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.C_X(y, z, R, reg=None, surfaceNumber=None)¶

Cylinder (parallel to x-axis)

y¶

z¶

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.C_Y(x, z, R, reg=None, surfaceNumber=None)¶

Cylinder (parallel to y-axis)

x¶

z¶

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.C_Z(x, y, R, reg=None, surfaceNumber=None)¶

Cylinder (parallel to z-axis)

x¶

y¶

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.CX(R, reg=None, surfaceNumber=None)¶

Cylinder (on x-axis)

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.CY(R, reg=None, surfaceNumber=None)¶

Cylinder (on y-axis)

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.CZ(R, reg=None, surfaceNumber=None)¶

Cylinder (on z-axis)

R¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.K_X(x, y, z, t_sqr, sign, reg=None, surfaceNumber=None)¶

Cone (parallel to x-axis)

Parameters:

t_sqr – t squared.
sign – Choice positive slope or negative slope.

x¶

y¶

z¶

t_sqr¶

sign¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.K_Y(x, y, z, t_sqr, sign, reg=None, surfaceNumber=None)¶

Cone (parallel to y-axis)

Parameters:

t_sqr – t squared.
sign – Choice positive slope or negative slope.

x¶

y¶

z¶

t_sqr¶

sign¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.K_Z(x, y, z, t_sqr, sign, reg=None, surfaceNumber=None)¶

Cone (parallel to z-axis)

Parameters:

t_sqr – t squared.
sign – Choice positive slope or negative slope.

x¶

y¶

z¶

t_sqr¶

sign¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.KX(x, t_sqr, sign, reg=None, surfaceNumber=None)¶

Cone (on x-axis)

Parameters:

t_sqr – t squared.
sign – Choice positive slope or negative slope.

x¶

t_sqr¶

sign¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.KY(y, t_sqr, sign, reg=None, surfaceNumber=None)¶

Cone (on y-axis)

Parameters:

t_sqr – t squared.
sign – Choice positive slope or negative slope.

y¶

t_sqr¶

sign¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.KZ(z, t_sqr, sign, reg=None, surfaceNumber=None)¶

Cone (on z-axis)

Parameters:

t_sqr – t squared.
sign – Choice positive slope or negative slope.

z¶

t_sqr¶

sign¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.SQ(A, B, C, D, E, F, G, x, y, z, reg=None, surfaceNumber=None)¶

Ellipsoid, Hyperboloid, Paraboloid (axes parallel to x-, y-, or z-axis)

A¶

B¶

C¶

D¶

E¶

F¶

G¶

x¶

y¶

z¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.GQ(A, B, C, D, E, F, G, H, J, K, reg=None, surfaceNumber=None)¶

Cylinder, Cone, Ellipsoid, Hyperboloid, Paraboloid (axes not parallel to x-, y-, or z-axis)

A¶

B¶

C¶

D¶

E¶

F¶

G¶

H¶

J¶

K¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.TX(x, y, z, A, B, C, reg=None, surfaceNumber=None)¶

Elliptical or Circular Torus (axis is parallel to x-, y-, or z-axis) rotationally symmetric about axes parallel to the x-axes

x¶

y¶

z¶

A¶

B¶

C¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.TY(x, y, z, A, B, C, reg=None, surfaceNumber=None)¶

Elliptical or Circular Torus (axis is parallel to x-, y-, or z-axis) rotationally symmetric about axes parallel to the y-axes

x¶

y¶

z¶

A¶

B¶

C¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.TZ(x, y, z, A, B, C, reg=None, surfaceNumber=None)¶

Elliptical or Circular Torus (axis is parallel to x-, y-, or z-axis) rotationally symmetric about axes parallel to the z-axes

x¶

y¶

z¶

A¶

B¶

C¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.BOX(vx, vy, vz, a1x, a1y, a1z, a2x, a2y, a2z, a3x, a3y, a3z, reg=None, surfaceNumber=None)¶

Macrobody: Box arbitrarily oriented orthogonal box all corner angels are 90 degrees

Parameters:

vz (vx, vy,) – The x,y,z coordinates of a corner of the box.
a1z (a1x, a1y,) – Vector of 1st side from the specified corner coordinates.
a2z (a2x, a2y,) – Vector of 2nd side from the specified corner coordinates.
a3z (a3x, a3y,) – Vector of 3rd side from the specified corner coordinates.

vx¶

vy¶

vz¶

a1x¶

a1y¶

a1z¶

a2x¶

a2y¶

a2z¶

a3x¶

a3y¶

a3z¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.RPP(xmin, xmax, ymin, ymax, zmin, zmax, reg=None, surfaceNumber=None)¶

Macrobody: Rectangular Parallelepiped RPP surfaces will only be normal to the x-, y-, and z-axes x,y,z values are relative to the origin

Parameters:

xmax (xmin,) – Termini of box sides normal to the x-axis.
ymax (ymin,) – Termini of box sides normal to the y-axis.
zmax (zmin,) – Termini of box sides normal to the z-axis.

xmin¶

xmax¶

ymin¶

ymax¶

zmin¶

zmax¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.SPH(vx, vy, vz, r, reg=None, surfaceNumber=None)¶

Macrobody: Sphere

Parameters:

vz (vx, vy,) – The x,y,z coordinates of the center of the sphere.
r – Radius of sphere.

vx¶

vy¶

vz¶

r¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.RCC(vx, vy, vz, hx, hy, hz, r, reg=None, surfaceNumber=None)¶

Macrobody: Right Circular Cylinder

Parameters:

vz (vx, vy,) – The x,y,z coordinates at the center of the base for the right circular cylinder.
hz (hx, hy,) – Right circular cylinder axis vector, which provides both the orientation and the height of the cylinder.
r – Radius of right circular cylinder.

vx¶

vy¶

vz¶

hx¶

hy¶

hz¶

r¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.RHP_HEX(vx, vy, vz, h1, h2, h3, r1, r2, r3, s1, s2, s3, t1, t2, t3, reg=None, surfaceNumber=None)¶

Macrobody: Right Hexagonal Prism

Parameters:

vz (vx, vy,) – The x,y,z coordinates of the bottom of the hexagonal prism.
h3 (h1, h2,) – Vector from the bottom to the top of the hexagonal prism. For a z-hex with height h, h1, h2, and h3= 0 0 h.
r3 (r1, r2,) – Vector from the axis to the center of the 1st facet. For a pitch 2p facet normal to y-axis, r1, r2, and r3= 0 p 0.
s3 (s1, s2,) – Vector to center of the 2nd facet.
t3 (t1, t2,) – Vector to center of the 3rd facet.

vx¶

vy¶

vz¶

h1¶

h2¶

h3¶

r1¶

r2¶

r3¶

s1¶

s2¶

s3¶

t1¶

t2¶

t3¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.REC(vx, vy, vz, hx, hy, hz, v1x, v1y, v1z, v2x, v2y, v2z, reg=None, surfaceNumber=None)¶

Macrobody: Right Elliptical Cylinder

Parameters:

vz (vx, vy,) – The x,y,z coordinates of the cylinder bottom.
hz (hx, hy,) – Cylinder axis height vector.
v1z (v1x, v1y,) – Ellipse major axis vector (normal to hx hy hz).
v1z – Ellipse minor axis vector (orthogonal to vectors h and v1).

vx¶

vy¶

vz¶

hx¶

hy¶

hz¶

v1x¶

v1y¶

v1z¶

v2x¶

v2y¶

v2z¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.TRC(vx, vy, vz, hx, hy, hz, r1, r2, reg=None, surfaceNumber=None)¶

Macrobody: Truncated Right-Angle Cone

Parameters:

vz (vx, vy,) – the x,y,z coordinates of the cone bottom
hz (hx, hy,) – cone axis height vector
r1 – radius of lower cone base
r2 – radius of upper cone base, where r1>r2

vx¶

vy¶

vz¶

hx¶

hy¶

hz¶

r1¶

r2¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.ELL(v1x, v1y, v1z, v2x, v2y, v2z, rm, reg=None, surfaceNumber=None)¶

Macrobody: Ellipsoid

Parameters:

v1z (v1x, v1y,) –
/ if rm>0, the coordinates of the 1st focus / if rm<0, the coordinates of the center of the ellipsoid
v2z (v2x, v2y,) – if rm>0, the coordinates of the 2nd focus / if rm<0, major axis vector (vector from the center of the ellipsoid through a focus to the vertex; / length = major radius)
rm – if rm>0, major radius length / if rm<0, minor radius length

v1x¶

v1y¶

v1z¶

v2x¶

v2y¶

v2z¶

rm¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.WED(vx, vy, vz, v1x, v1y, v1z, v2x, v2y, v2z, v3x, v3y, v3z, reg=None, surfaceNumber=None)¶

Macrobody: Wedge

Parameters:

vz (vx, vy,) – the x,y,z coordinates of wedge vertex
v1z (v1x, v1y,) – vector of 1st side of triangular base
v2z (v2x, v2y,) – vector of 2nd side of triangular base
v3z (v3x, v3y,) – height vector

vx¶

vy¶

vz¶

surfaceNumber¶

__repr__()¶

class pyg4ometry.mcnp.Surfaces.ARB(ax, ay, az, bx, by, bz, cx, cy, cz, dx, dy, dz, ex, ey, ez, fx, fy, fz, gx, gy, gz, hx, hy, hz, n1, n2, n3, n4, n5, n6, surfaceNumber=None, reg=None)¶

Macrobody: Arbitrary Polyhedron

:param ax, ay, az, bx, by, bz, cx, cy, cz, dx, dy, dz, / ex, ey, ez, fx, fy, fz, gx, gy, gz, hx, hy, hz: / The x-, y-, z-coordinates of the 1st through 8th corners of the polyhedron. There must be eight x,y,z triplets to describe the eight corners of the polyhedron. :param n1, n2, n3, n4, n5, n6: / Four-digit numbers describing a side of the polyhedron in terms of its corresponding corners. / E.g., n1=1278 is a plane/side bounded by corners 1, 2, 7, and 8 (a, b, g, and h).