pymcnp.inp.surface Subpackage

Warning

The following surface visualizations are not currently supported:

  • Arb (3.2.2.4.10)

  • Gq (3.2.2.1)

  • Sq (3.2.2.1)

  • X (3.2.2.2)

  • Y (3.2.2.2)

  • Z (3.2.2.2)

AST Classes

Arb Class

class pymcnp.inp.surface.Arb(ax: str | int | float | Real, ay: str | int | float | Real, az: str | int | float | Real, bx: str | int | float | Real, by: str | int | float | Real, bz: str | int | float | Real, cx: str | int | float | Real, cy: str | int | float | Real, cz: str | int | float | Real, dx: str | int | float | Real, dy: str | int | float | Real, dz: str | int | float | Real, ex: str | int | float | Real, ey: str | int | float | Real, ez: str | int | float | Real, fx: str | int | float | Real, fy: str | int | float | Real, fz: str | int | float | Real, gx: str | int | float | Real, gy: str | int | float | Real, gz: str | int | float | Real, hx: str | int | float | Real, hy: str | int | float | Real, hz: str | int | float | Real, n1: str | int | float | Real, n2: str | int | float | Real, n3: str | int | float | Real, n4: str | int | float | Real, n5: str | int | float | Real, n6: str | int | float | Real)

Represents INP arb elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property ax: Real

Polyhedron corner #1 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property ay: Real

Polyhedron corner #1 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property az: Real

Polyhedron corner #1 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property bx: Real

Polyhedron corner #2 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property by: Real

Polyhedron corner #2 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property bz: Real

Polyhedron corner #2 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property cx: Real

Polyhedron corner #3 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property cy: Real

Polyhedron corner #3 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property cz: Real

Polyhedron corner #3 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property dx: Real

Polyhedron corner #4 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property dy: Real

Polyhedron corner #4 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property dz: Real

Polyhedron corner #4 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property ex: Real

Polyhedron corner #5 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property ey: Real

Polyhedron corner #5 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property ez: Real

Polyhedron corner #5 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property fx: Real

Polyhedron corner #6 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property fy: Real

Polyhedron corner #6 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property fz: Real

Polyhedron corner #6 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property gx: Real

Polyhedron corner #7 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property gy: Real

Polyhedron corner #7 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property gz: Real

Polyhedron corner #7 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hx: Real

Polyhedron corner #8 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hy: Real

Polyhedron corner #8 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hz: Real

Polyhedron corner #8 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property n1: Real

Polyhedron four-digit side specificer #1

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property n2: Real

Polyhedron four-digit side specificer #2

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property n3: Real

Polyhedron four-digit side specificer #3

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property n4: Real

Polyhedron four-digit side specificer #4

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property n5: Real

Polyhedron four-digit side specificer #5

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property n6: Real

Polyhedron four-digit side specificer #6

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Box Class

class pymcnp.inp.surface.Box(vx: str | int | float | Real, vy: str | int | float | Real, vz: str | int | float | Real, a1x: str | int | float | Real, a1y: str | int | float | Real, a1z: str | int | float | Real, a2x: str | int | float | Real, a2y: str | int | float | Real, a2z: str | int | float | Real, a3x: str | int | float | Real, a3y: str | int | float | Real, a3z: str | int | float | Real)

Represents INP box elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Box.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Box.

property a1x: Real

Box macrobody vector #1 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a1y: Real

Box macrobody vector #1 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a1z: Real

Box macrobody vector #1 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a2x: Real

Box macrobody vector #2 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a2y: Real

Box macrobody vector #2 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a2z: Real

Box macrobody vector #2 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a3x: Real

Box macrobody vector #3 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a3y: Real

Box macrobody vector #3 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property a3z: Real

Box macrobody vector #3 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vx: Real

Box macrobody position vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vy: Real

Box macrobody position vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vz: Real

Box macrobody position vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

C_x Class

class pymcnp.inp.surface.C_x(y: str | int | float | Real, z: str | int | float | Real, r: str | int | float | Real)

Represents INP c/x elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from C_x.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for C_x.

property r: Real

Parallel-to-x-axis cylinder radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-x-axis cylinder center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-x-axis cylinder center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

C_y Class

class pymcnp.inp.surface.C_y(x: str | int | float | Real, z: str | int | float | Real, r: str | int | float | Real)

Represents INP c/y elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from C_y.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for C_y.

property r: Real

Parallel-to-y-axis cylinder radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-y-axis cylinder center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-y-axis cylinder center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

C_z Class

class pymcnp.inp.surface.C_z(x: str | int | float | Real, y: str | int | float | Real, r: str | int | float | Real)

Represents INP c/z elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from C_z.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for C_z.

property r: Real

Parallel-to-z-axis cylinder radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-z-axis cylinder center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-z-axis cylinder center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Cx Class

class pymcnp.inp.surface.Cx(r: str | int | float | Real)

Represents INP cx elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Cx.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Cx.

property r: Real

On-x-axis cylinder radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Cy Class

class pymcnp.inp.surface.Cy(r: str | int | float | Real)

Represents INP cy elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Cy.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Cy.

property r: Real

On-y-axis cylinder radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Cz Class

class pymcnp.inp.surface.Cz(r: str | int | float | Real)

Represents INP cz elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Cz.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Cz.

property r: Real

On-z-axis cylinder radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Ell Class

class pymcnp.inp.surface.Ell(v1x: str | int | float | Real, v1y: str | int | float | Real, v1z: str | int | float | Real, v2x: str | int | float | Real, v2y: str | int | float | Real, v2z: str | int | float | Real, rm: str | int | float | Real)

Represents INP ell elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Ell.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Ell.

property rm: Real

Ellipsoid major/minor axis radius length

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1x: Real

Ellipsoid focus #1 or center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1y: Real

Ellipsoid focus #1 or center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1z: Real

Ellipsoid focus #1 or center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2x: Real

Ellipsoid focus #2 or major axis x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2y: Real

Ellipsoid focus #2 or major axis y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2z: Real

Ellipsoid focus #2 or major axis z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Gq Class

class pymcnp.inp.surface.Gq(a: str | int | float | Real, b: str | int | float | Real, c: str | int | float | Real, d: str | int | float | Real, e: str | int | float | Real, f: str | int | float | Real, g: str | int | float | Real, h: str | int | float | Real, j: str | int | float | Real, k: str | int | float | Real)

Represents INP gq elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property a: Real

Oblique special quadratic A coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property b: Real

Oblique special quadratic B coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property c: Real

Oblique special quadratic C coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property d: Real

Oblique special quadratic D coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property e: Real

Oblique special quadratic E coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property f: Real

Oblique special quadratic F coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property g: Real

Oblique special quadratic G coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property h: Real

Oblique special quadratic H coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property j: Real

Oblique special quadratic J coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property k: Real

Oblique special quadratic K coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

K_x Class

class pymcnp.inp.surface.K_x(x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real, t_squared: str | int | float | Real, plusminus_1: str | int | float | Real)

Represents INP k/x elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from K_x.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for K_x.

property plusminus_1: Real

Parallel-to-x-axis cone sheet selector

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t_squared: Real

Parallel-to-x-axis cone t^2 coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-x-axis cone center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-x-axis cone center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-x-axis cone center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

K_y Class

class pymcnp.inp.surface.K_y(x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real, t_squared: str | int | float | Real, plusminus_1: str | int | float | Real)

Represents INP k/y elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from K_y.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for K_y.

property plusminus_1: Real

Parallel-to-y-axis cone sheet selector

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t_squared: Real

Parallel-to-y-axis cone t^2 coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-y-axis cone center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-y-axis cone center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-y-axis cone center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

K_z Class

class pymcnp.inp.surface.K_z(x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real, t_squared: str | int | float | Real, plusminus_1: str | int | float | Real)

Represents INP k/z elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from K_z.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for K_z.

property plusminus_1: Real

Parallel-to-z-axis cone sheet selector

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t_squared: Real

Parallel-to-z-axis cone t^2 coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-z-axis cone center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-z-axis cone center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-z-axis cone center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Kx Class

class pymcnp.inp.surface.Kx(x: str | int | float | Real, t_squared: str | int | float | Real, plusminus_1: str | int | float | Real)

Represents INP kx elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Kx.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Kx.

property plusminus_1: Real

On-x-axis cone sheet selector

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t_squared: Real

On-x-axis cone t^2 coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

On-x-axis cone center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Ky Class

class pymcnp.inp.surface.Ky(y: str | int | float | Real, t_squared: str | int | float | Real, plusminus_1: str | int | float | Real)

Represents INP ky elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Ky.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Ky.

property plusminus_1: Real

On-y-axis cone sheet selector

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t_squared: Real

On-y-axis cone t^2 coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

On-y-axis cone center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Kz Class

class pymcnp.inp.surface.Kz(z: str | int | float | Real, t_squared: str | int | float | Real, plusminus_1: str | int | float | Real)

Represents INP kz elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Kz.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Kz.

property plusminus_1: Real

On-z-axis cone sheet selector

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t_squared: Real

On-z-axis cone t^2 coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

On-z-axis cone center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

P_0 Class

class pymcnp.inp.surface.P_0(a: str | int | float | Real, b: str | int | float | Real, c: str | int | float | Real, d: str | int | float | Real)

Represents INP p elements variation #0.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Px.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Px

property a: Real

Equation-defined general plane A coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property b: Real

Equation-defined general plane B coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property c: Real

Equation-defined general plane C coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property d: Real

Equation-defined general plane D coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

P_1 Class

class pymcnp.inp.surface.P_1(x1: str | int | float | Real, y1: str | int | float | Real, z1: str | int | float | Real, x2: str | int | float | Real, y2: str | int | float | Real, z2: str | int | float | Real, x3: str | int | float | Real, y3: str | int | float | Real, z3: str | int | float | Real)

Represents INP p elements variation #1.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from P_1.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for P_1

property x1: Real

Point-defined general plane x-coordinate #1

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x2: Real

Point-defined general plane x-coordinate #2

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x3: Real

Point-defined general plane x-coordinate #3

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y1: Real

Point-defined general plane y-coordinate #1

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y2: Real

Point-defined general plane y-coordinate #2

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y3: Real

Point-defined general plane y-coordinate #3

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z1: Real

Point-defined general plane z-coordinate #1

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z2: Real

Point-defined general plane z-coordinate #2

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z3: Real

Point-defined general plane z-coordinate #3

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Px Class

class pymcnp.inp.surface.Px(d: str | int | float | Real)

Represents INP px elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Px.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Px

property d: Real

Normal-to-the-x-axis plane D coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Py Class

class pymcnp.inp.surface.Py(d: str | int | float | Real)

Represents INP py elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Py.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Py

property d: Real

Normal-to-the-y-axis plane D coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Pz Class

class pymcnp.inp.surface.Pz(d: str | int | float | Real)

Represents INP pz elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Pz.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Pz

property d: Real

Normal-to-the-z-axis plane D coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Rcc Class

class pymcnp.inp.surface.Rcc(vx: str | int | float | Real, vy: str | int | float | Real, vz: str | int | float | Real, hx: str | int | float | Real, hy: str | int | float | Real, hz: str | int | float | Real, r: str | int | float | Real)

Represents INP rcc elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Rcc.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Rcc

property hx: Real

Circular cylinder macrobody height vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hy: Real

Circular cylinder macrobody height vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hz: Real

Circular cylinder macrobody height vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r: Real

Circular cylinder macrobody radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vx: Real

Circular cylinder macrobody position vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vy: Real

Circular cylinder macrobody position vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vz: Real

Circular cylinder macrobody position vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Rec Class

class pymcnp.inp.surface.Rec(vx: str | int | float | Real, vy: str | int | float | Real, vz: str | int | float | Real, hx: str | int | float | Real, hy: str | int | float | Real, hz: str | int | float | Real, v1x: str | int | float | Real, v1y: str | int | float | Real, v1z: str | int | float | Real, v2x: str | int | float | Real, v2y: str | int | float | Real = None, v2z: str | int | float | Real = None)

Represents INP rec elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Rec.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Rec

property hx: Real

Elliptical cylinder height vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hy: Real

Elliptical cylinder height vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hz: Real

Elliptical cylinder height vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1x: Real

Elliptical cylinder major axis vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1y: Real

Elliptical cylinder major axis vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1z: Real

Elliptical cylinder major axis vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2x: Real

Elliptical cylinder minor axis vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2y: Real

Elliptical cylinder minor axis vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2z: Real

Elliptical cylinder minor axis vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vx: Real

Elliptical cylinder position vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vy: Real

Elliptical cylinder position vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vz: Real

Elliptical cylinder position vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Rhp Class

class pymcnp.inp.surface.Rhp(vx: str | int | float | Real, vy: str | int | float | Real, vz: str | int | float | Real, hx: str | int | float | Real, hy: str | int | float | Real, hz: str | int | float | Real, r1: str | int | float | Real, r2: str | int | float | Real, r3: str | int | float | Real, s1: str | int | float | Real = None, s2: str | int | float | Real = None, s3: str | int | float | Real = None, t1: str | int | float | Real = None, t2: str | int | float | Real = None, t3: str | int | float | Real = None)

Represents INP rhp elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Rhp.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Rhp

property hx: Real

Hexagonal prism height vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hy: Real

Hexagonal prism height vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hz: Real

Hexagonal prism height vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r1: Real

Hexagonal prism facet #1 vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r2: Real

Hexagonal prism facet #1 vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r3: Real

Hexagonal prism facet #1 vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property s1: Real

Hexagonal prism facet #2 vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property s2: Real

Hexagonal prism facet #2 vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property s3: Real

Hexagonal prism facet #2 vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t1: Real

Hexagonal prism facet #3 vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t2: Real

Hexagonal prism facet #3 vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property t3: Real

Hexagonal prism facet #3 vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vx: Real

Hexagonal prism position vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vy: Real

Hexagonal prism position vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vz: Real

Hexagonal prism position vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Rpp Class

class pymcnp.inp.surface.Rpp(xmin: str | int | float | Real, xmax: str | int | float | Real, ymin: str | int | float | Real, ymax: str | int | float | Real, zmin: str | int | float | Real = None, zmax: str | int | float | Real = None)

Represents INP rpp elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Rpp.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Rpp

property xmax: Real

Parallelepiped x termini maximum

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property xmin: Real

Parallelepiped x termini minimum

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property ymax: Real

Parallelepiped y termini maximum

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property ymin: Real

Parallelepiped y termini minimum

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property zmax: Real

Parallelepiped z termini maximum

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property zmin: Real

Parallelepiped z termini minimum

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

S Class

class pymcnp.inp.surface.S(x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real, r: str | int | float | Real)

Represents INP s elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from S.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for S

property r: Real

General sphere radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

General sphere center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

General sphere center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

General sphere center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

So Class

class pymcnp.inp.surface.So(r: str | int | float | Real)

Represents INP so elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from So.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for So

property r: Real

Origin-centered sphere radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Sph Class

class pymcnp.inp.surface.Sph(vx: str | int | float | Real, vy: str | int | float | Real, vz: str | int | float | Real, r: str | int | float | Real)

Represents INP sph elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Sph.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Sph

property r: Real

Sphere macrobody radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vx: Real

Sphere macrobody position vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vy: Real

Sphere macrobody position vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vz: Real

Sphere macrobody position vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Sq Class

class pymcnp.inp.surface.Sq(a: str | int | float | Real, b: str | int | float | Real, c: str | int | float | Real, d: str | int | float | Real, e: str | int | float | Real, f: str | int | float | Real, g: str | int | float | Real, x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real)

Represents INP sq elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property a: Real

Oblique special quadratic A coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property b: Real

Oblique special quadratic B coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property c: Real

Oblique special quadratic C coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property d: Real

Oblique special quadratic D coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property e: Real

Oblique special quadratic E coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property f: Real

Oblique special quadratic F coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property g: Real

Oblique special quadratic G coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Oblique special quadratic center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Oblique special quadratic center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Oblique special quadratic center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Sx Class

class pymcnp.inp.surface.Sx(x: str | int | float | Real, r: str | int | float | Real)

Represents INP sx elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Sx.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Sx

property r: Real

On-x-axis sphere radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

On-x-axis sphere center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Sy Class

class pymcnp.inp.surface.Sy(y: str | int | float | Real, r: str | int | float | Real)

Represents INP sy elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Sy.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Sy

property r: Real

On-y-axis sphere radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

On-y-axis sphere center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Sz Class

class pymcnp.inp.surface.Sz(z: str | int | float | Real, r: str | int | float | Real)

Represents INP sz elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Sz.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Sz

property r: Real

On-z-axis sphere radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

On-z-axis sphere center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Trc Class

class pymcnp.inp.surface.Trc(vx: str | int | float | Real, vy: str | int | float | Real, vz: str | int | float | Real, hx: str | int | float | Real, hy: str | int | float | Real, hz: str | int | float | Real, r1: str | int | float | Real, r2: str | int | float | Real)

Represents INP trc elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Trc.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Trc

property hx: Real

Truncated cone height vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hy: Real

Truncated cone height vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property hz: Real

Truncated cone height vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r1: Real

Truncated cone lower cone radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r2: Real

Truncated cone upper cone radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vx: Real

Truncated cone position vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vy: Real

Truncated cone position vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vz: Real

Truncated cone position vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Tx Class

class pymcnp.inp.surface.Tx(x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real, a: str | int | float | Real, b: str | int | float | Real, c: str | int | float | Real)

Represents INP tx elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Tx.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Tx

property a: Real

Parallel-to-x-axis tori A coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property b: Real

Parallel-to-x-axis tori B coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property c: Real

Parallel-to-x-axis tori C coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-x-axis tori center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-x-axis tori center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-x-axis tori center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Ty Class

class pymcnp.inp.surface.Ty(x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real, a: str | int | float | Real, b: str | int | float | Real, c: str | int | float | Real)

Represents INP ty elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Ty.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Ty

property a: Real

Parallel-to-y-axis tori A coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property b: Real

Parallel-to-y-axis tori B coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property c: Real

Parallel-to-y-axis tori C coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-y-axis tori center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-y-axis tori center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-y-axis tori center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Tz Class

class pymcnp.inp.surface.Tz(x: str | int | float | Real, y: str | int | float | Real, z: str | int | float | Real, a: str | int | float | Real, b: str | int | float | Real, c: str | int | float | Real)

Represents INP tz elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Tz.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Tz

property a: Real

Parallel-to-z-axis tori A coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property b: Real

Parallel-to-z-axis tori B coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property c: Real

Parallel-to-z-axis tori C coefficent

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x: Real

Parallel-to-z-axis tori center x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y: Real

Parallel-to-z-axis tori center y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z: Real

Parallel-to-z-axis tori center z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Wed Class

class pymcnp.inp.surface.Wed(vx: str | int | float | Real, vy: str | int | float | Real, vz: str | int | float | Real, v1x: str | int | float | Real, v1y: str | int | float | Real, v1z: str | int | float | Real, v2x: str | int | float | Real, v2y: str | int | float | Real, v2z: str | int | float | Real, v3x: str | int | float | Real, v3y: str | int | float | Real, v3z: str | int | float | Real)

Represents INP wed elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

to_show(shapes: ~types.ModuleType = <module 'pymcnp._show.pyvista' from '/home/docs/checkouts/readthedocs.org/user_builds/pymcnp/envs/stable/lib/python3.12/site-packages/pymcnp/_show/pyvista/__init__.py'>) → Shape

Generates Visualization from Wed.

Parameters:

shapes – Collection of shapes.

Returns:

_show.Shape for Wed

property v1x: Real

Wedge side vector #1 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1y: Real

Wedge side vector #1 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v1z: Real

Wedge side vector #1 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2x: Real

Wedge side vector #2 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2y: Real

Wedge side vector #2 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v2z: Real

Wedge side vector #2 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v3x: Real

Wedge height vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v3y: Real

Wedge height vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property v3z: Real

Wedge height vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vx: Real

Wedge position vector x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vy: Real

Wedge position vector y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property vz: Real

Wedge position vector z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

X Class

class pymcnp.inp.surface.X(x1: str | int | float | Real, r1: str | int | float | Real, x2: str | int | float | Real = None, r2: str | int | float | Real = None, x3: str | int | float | Real = None, r3: str | int | float | Real = None)

Represents INP x elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property r1: Real

X-axisymmetric point-defined surface point #1 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r2: Real

X-axisymmetric point-defined surface point #2 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r3: Real

X-axisymmetric point-defined surface point #3 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x1: Real

X-axisymmetric point-defined surface point #1 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x2: Real

X-axisymmetric point-defined surface point #2 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property x3: Real

X-axisymmetric point-defined surface point #3 x component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Y Class

class pymcnp.inp.surface.Y(y1: str | int | float | Real, r1: str | int | float | Real, y2: str | int | float | Real = None, r2: str | int | float | Real = None, y3: str | int | float | Real = None, r3: str | int | float | Real = None)

Represents INP y elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property r1: Real

Y-axisymmetric point-defined surface point #1 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r2: Real

Y-axisymmetric point-defined surface point #2 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r3: Real

Y-axisymmetric point-defined surface point #3 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y1: Real

Y-axisymmetric point-defined surface point #1 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y2: Real

Y-axisymmetric point-defined surface point #2 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property y3: Real

Y-axisymmetric point-defined surface point #3 y component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

Z Class

class pymcnp.inp.surface.Z(z1: str | int | float | Real, r1: str | int | float | Real, z2: str | int | float | Real = None, r2: str | int | float | Real = None, z3: str | int | float | Real = None, r3: str | int | float | Real = None)

Represents INP z elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

source – Option for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property r1: Real

Z-axisymmetric point-defined surface point #1 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r2: Real

Z-axisymmetric point-defined surface point #2 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property r3: Real

Z-axisymmetric point-defined surface point #3 radius

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z1: Real

Z-axisymmetric point-defined surface point #1 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z2: Real

Z-axisymmetric point-defined surface point #2 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –

property z3: Real

Z-axisymmetric point-defined surface point #3 z component

Raises:

  • InpError – SEMANTICS_OPTION.

  • TypeError –