PoreMS 0.2
  • API
  • Process
  • Molecule
  • Pore
  • Workflow
  • Site
    • Page
        • Cuboid

    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:
    inp : dictionary

    Dictionary of necessary inputs

    Surface Function

    Phi(self, x, y, z) Surface function of a cuboid.

    Shape

    rim(self, z[, num]) Return x and y values for given length.
    surf(self[, num]) Return x, y and z values for the shape.

    Properties

    is_in(self, pos) Check if given position is inside of shape.
    normal(self, pos) Calculate unit normal vector on surface for a given position.
    surface(self) Calculate inner surface
    volume(self) Calculate volume

    Back to top

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