pymcnp.inp.bfld Subpackage

AST Classes

Axs Class

class pymcnp.inp.bfld.Axs(vector: list[str] | list[float] | list[Real])

Represents INP axs elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

sourceOption for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property vector: _Tuple

Direction of the cosines of the quadropole beam axis

Raises:
  • InpError – SEMANTICS_OPTION.

  • TypeError

Ffedges Class

class pymcnp.inp.bfld.Ffedges(numbers: list[str] | list[float] | list[Real])

Represents INP ffedges elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

sourceOption for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property numbers: _Tuple

Surface numbers to apply field fringe edges

Raises:
  • InpError – SEMANTICS_OPTION.

  • TypeError

Field Class

class pymcnp.inp.bfld.Field(strength_gradient: str | int | float | Real)

Represents INP field elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

sourceOption for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property strength_gradient: Real

Magnetic field strength/gradient

Raises:
  • InpError – SEMANTICS_OPTION.

  • TypeError

Maxdeflc Class

class pymcnp.inp.bfld.Maxdeflc(angle: str | int | float | Real)

Represents INP maxdeflc elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

sourceOption for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property angle: Real

Maximum deflection angles

Raises:
  • InpError – SEMANTICS_OPTION.

  • TypeError

Maxstep Class

class pymcnp.inp.bfld.Maxstep(size: str | int | float | Real)

Represents INP maxstep elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

sourceOption for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property size: Real

Maximum step size

Raises:
  • InpError – SEMANTICS_OPTION.

  • TypeError

Refpnt Class

class pymcnp.inp.bfld.Refpnt(point: list[str] | list[float] | list[Real])

Represents INP refpnt elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

sourceOption for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property point: _Tuple

Point anywhere on the quadrapole beam

Raises:
  • InpError – SEMANTICS_OPTION.

  • TypeError

Vec Class

class pymcnp.inp.bfld.Vec(vector: list[str] | list[float] | list[Real])

Represents INP vec elements.

classmethod from_mcnp(source: str)

Generates Option from INP.

Parameters:

sourceOption for INP.

Returns:

Option.

Raises:

InpError – SYNTAX_OPTION.

to_mcnp()

Generates INP from Option.

Returns:

INP for Option.

property vector: _Tuple

Direction of mangentic field or plane corresponding to the x-axis of the quadrapole

Raises:
  • InpError – SEMANTICS_OPTION.

  • TypeError