GeometricObjects

Within GeometricObjects classes for different geometric objects used in the GmshModel are defined. The geometric objects are used within the geometry generation to create Gmsh model from basic geometry entities.

Class Definitions

GeometricObject

class gmshModel.Geometry.GeometricObjects.GeometricObject(dimension=None, group='default')[source]

Bases: object

Definition of a generic geometric object

This class is the parent class of all geometric objects and provides general information that all objects should have

Attributes:

dimension: int

dimension of the RVE

group: string

string defining which group the geometric object belongs to

addToGmshModel(gmshModel)[source]

Add a representation of the geometric object to the Gmsh model

Parameters:

gmshModel: class object

model class of the Gmsh-Python-API that holds the Gmsh-specific current model information

Box

class gmshModel.Geometry.GeometricObjects.Box(size=None, origin=[0, 0, 0], group='default')[source]

Bases: GeometricObject

Definition of a Box object

This class is a child class of geometricObject and provides additional information for objetcs of type Box

Attributes:

dimension: int

dimension of the box object

origin: array/list

origin of the domain object -> origin=[Ox, Oy, (Oz)]

size: array/list

size of the domain object -> size=[Lx, Ly, (Lz)]

group: string

group the box object belongs to

Rectangle

class gmshModel.Geometry.GeometricObjects.Rectangle(size=None, origin=[0, 0, 0], group='default')[source]

Bases: GeometricObject

Definition of a Rectangle object

This class is a child class of geometricObject and provides additional information for objetcs of type Rectangle

Attributes:

dimension: int

dimension of the box object

origin: array/list

origin of the domain object -> origin=[Ox, Oy, (Oz)]

size: array/list

size of the domain object -> size=[Lx, Ly, (Lz)]

group: string

group the box object belongs to

Sphere

class gmshModel.Geometry.GeometricObjects.Sphere(center=None, radius=None, group='default')[source]

Bases: GeometricObject

Definition of a Sphere object

This class is a child class of geometricObject and provides additional information for objetcs of type Sphere

Attributes:

center: array/list

array that defines the center of the Sphere object -> center=[Cx, Cy, (Cz)]

radius: float

radius of the Sphere object

Cylinder

class gmshModel.Geometry.GeometricObjects.Cylinder(center=None, radius=None, axis=None, group='default')[source]

Bases: GeometricObject

Definition of a Cylinder object

This class is a child class of geometricObject and provides additional information for objetcs of type Cylinder

Attributes:

center: array/list

array that defines the center of the Cylinder object -> center=[Cx, Cy, Cz]

axis: array/list

array that defines the axis (direction and length) of the Cylinder object -> axis=[Ax, Ay, Az]

radius: float

radius of the Cylinder object

Circle

class gmshModel.Geometry.GeometricObjects.Circle(center=None, radius=None, group='default')[source]

Bases: GeometricObject

Definition of an Circle object

This class is a child class of geometricObject and provides additional information for objetcs of type Circle

Attributes:

center: array/list

array that defines the center of the Circle object -> center=[Cx, Cy, (Cz)]

radius: float

radius of the Circle object