PoreMS 0.3
  • API
  • Molecule
  • Pore
  • Workflow
  • Pore shape examples
  • Site
    • Page
        • Cuboid
          • Cuboid
    • Cuboid
      • Cuboid
    Source

    Cuboid¶

    class porems.shape.Cuboid(inp)¶

    This class defines a cuboid shape. Needed inputs are

    • central - Central axis

    • centroid - Centroid of block

    • length - Cuboid length

    • width - Cuboid width

    • height - Cuboid height

    Parameters:
    inpdictionary

    Dictionary of necessary inputs

    Methods

    Phi(x, y, z)

    Surface function of a cuboid.

    convert(data[, to_zero])

    This helper method rotates the given data to match the global central axis and translates it so that the center point is aligned.

    get_inp()

    Return full input dictionary.

    is_in(pos)

    Check if given position is inside of shape.

    normal(pos)

    Calculate unit normal vector on surface for a given position.

    plot([inp, num, vec])

    Plot surface and rim.

    rim(z[, num])

    Return x and y values for given length.

    surf([num])

    Return x, y and z values for the shape.

    surface()

    Calculate inner surface

    volume()

    Calculate volume

    Back to top

    © Copyright 2021, Hamzeh Kraus.
    Created using Sphinx 7.4.6.