g3d.mesh.geo.region package

Submodules

g3d.mesh.geo.region.block_region module

BlockRegion class definition

class g3d.mesh.geo.region.block_region.BlockRegion(*args: Any, **kwargs: Any)[source]

Bases: PrismRegion

Attributes:
alpha
return:

beta
return:

ialt
return:

length
return:

tag

tag (string) used for identification

width
return:

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: BlockRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

property width: float

return:

g3d.mesh.geo.region.box_region module

BoxRegion class definition

class g3d.mesh.geo.region.box_region.BoxRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
dx
return:

dy
return:

dz
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: BoxRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property dx: float

return:

property dy: float

return:

property dz: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

g3d.mesh.geo.region.cylinder_region module

CylinderRegion class definition

class g3d.mesh.geo.region.cylinder_region.CylinderRegion(*args: Any, **kwargs: Any)[source]

Bases: PrismRegion

Attributes:
alpha
return:

beta
return:

ialt
return:

length
return:

radius
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: CylinderRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property radius: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

g3d.mesh.geo.region.ijk_region module

IJKRegion class definition

class g3d.mesh.geo.region.ijk_region.IJKRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
i1
return:

i2
return:

im
return:

it
return:

j1
return:

j2
return:

k1
return:

k2
return:

nc
return:

ni
return:

nj
return:

nk
return:

np
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

get_def()

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_def(im, i1, i2, j1, j2, k1, k2[, it])

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: IJKRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

get_def() → Tuple[int, ...][source]
Returns:

property i1: int

return:

property i2: int

return:

property im: int

return:

property it: int

return:

property j1: int

return:

property j2: int

return:

property k1: int

return:

property k2: int

return:

property nc: int

return:

property ni: int

return:

property nj: int

return:

property nk: int

return:

property np: int

return:

set_def(im, i1, i2, j1, j2, k1, k2, it=0)[source]
Parameters:

  • im

  • i1

  • i2

  • j1

  • j2

  • k1

  • k2

  • it

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

g3d.mesh.geo.region.prism_region module

PrismRegion class definition

class g3d.mesh.geo.region.prism_region.PrismRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
alpha
return:

beta
return:

ialt
return:

length
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
property alpha

return:

property beta

return:

coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: PrismRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property ialt

return:

property length

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

g3d.mesh.geo.region.region module

Region class definition (base class - generic region placeholder)

class g3d.mesh.geo.region.region.Region(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: Region) → None[source]

copies data from specified entity input: entity example: copy(e)

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

g3d.mesh.geo.region.sphere_region module

SphereRegion class definition

class g3d.mesh.geo.region.sphere_region.SphereRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
radius
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: SphereRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property radius: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

g3d.mesh.geo.region.xyz_region module

XYZRegion class definition

class g3d.mesh.geo.region.xyz_region.XYZRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
tag

tag (string) used for identification

x1
return:

x2
return:

y1
return:

y2
return:

z1
return:

z2
return:

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: XYZRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

print() → None[source]

prints entity data

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

property x1: float

return:

property x2: float

return:

property y1: float

return:

property y2: float

return:

property z1: float

return:

property z2: float

return:

Module contents

g3d/mesh/geo/region sub library

class g3d.mesh.geo.region.BlockRegion(*args: Any, **kwargs: Any)[source]

Bases: PrismRegion

Attributes:
alpha
return:

beta
return:

ialt
return:

length
return:

tag

tag (string) used for identification

width
return:

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: BlockRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

property width: float

return:

class g3d.mesh.geo.region.BoxRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
dx
return:

dy
return:

dz
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: BoxRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property dx: float

return:

property dy: float

return:

property dz: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

class g3d.mesh.geo.region.CylinderRegion(*args: Any, **kwargs: Any)[source]

Bases: PrismRegion

Attributes:
alpha
return:

beta
return:

ialt
return:

length
return:

radius
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: CylinderRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property radius: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

class g3d.mesh.geo.region.IJKRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
i1
return:

i2
return:

im
return:

it
return:

j1
return:

j2
return:

k1
return:

k2
return:

nc
return:

ni
return:

nj
return:

nk
return:

np
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

get_def()

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_def(im, i1, i2, j1, j2, k1, k2[, it])

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: IJKRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

get_def() → Tuple[int, ...][source]
Returns:

property i1: int

return:

property i2: int

return:

property im: int

return:

property it: int

return:

property j1: int

return:

property j2: int

return:

property k1: int

return:

property k2: int

return:

property nc: int

return:

property ni: int

return:

property nj: int

return:

property nk: int

return:

property np: int

return:

set_def(im, i1, i2, j1, j2, k1, k2, it=0)[source]
Parameters:

  • im

  • i1

  • i2

  • j1

  • j2

  • k1

  • k2

  • it

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

class g3d.mesh.geo.region.PrismRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
alpha
return:

beta
return:

ialt
return:

length
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
property alpha

return:

property beta

return:

coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: PrismRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property ialt

return:

property length

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

class g3d.mesh.geo.region.Region(*args: Any, **kwargs: Any)[source]

Bases: G3DEntity

Attributes:
tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: Region) → None[source]

copies data from specified entity input: entity example: copy(e)

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

class g3d.mesh.geo.region.SphereRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
radius
return:

tag

tag (string) used for identification

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: SphereRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

property radius: float

return:

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

class g3d.mesh.geo.region.XYZRegion(*args: Any, **kwargs: Any)[source]

Bases: Region

Attributes:
tag

tag (string) used for identification

x1
return:

x2
return:

y1
return:

y2
return:

z1
return:

z2
return:

Methods

coord_is_in_region(c)

copy(r)

copies data from specified entity input: entity example: copy(e)

print()

prints entity data

set(*args, **kwargs)

sets entity parameters according to specifications input: args, kwargs example: set(args, kwargs)

set_from_key_value(key, value)

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: 'tag' example: set_from_key_value(key, value)
coord_is_in_region(c: Coord) → bool[source]
Parameters:

c

Returns:

copy(r: XYZRegion) → None[source]

copies data from specified entity input: entity example: copy(e)

print() → None[source]

prints entity data

set_from_key_value(key: str, value: Any) → bool[source]

sets entity parameters from specified key => value data input: key, value valid keys for G3DCode base class: ‘tag’ example: set_from_key_value(key, value)

property x1: float

return:

property x2: float

return:

property y1: float

return:

property y2: float

return:

property z1: float

return:

property z2: float

return: