ogs5py.fileclasses.gli.generator

Generators for the ogs GEOMETRY file.

Generators

These generators can be called with GLI.generate

rectangular([dim, ori, size, name]) Generate a rectangular boundary for a grid in 2D or 3D as gli.
radial([dim, ori, angles, rad_out, rad_in, …]) Generate a radial boundary for a grid in 2D or 3D.

radial(dim=3, ori=(0.0, 0.0, 0.0), angles=16, rad_out=10.0, rad_in=None, z_size=-1.0, name_out='boundary', name_in='well')[source]

Generate a radial boundary for a grid in 2D or 3D.

Parameters:
  • dim (int, optional) – Dimension of the resulting mesh, either 2 or 3. Default: 3
  • ori (list of float, optional) – Origin of the mesh Default: [0.0, 0.0, 0.0]
  • angles (int, optional) – Number of angles. Default: 16
  • rad_out (float or None, optional) – Radius of the outer boundary, Default: 10.
  • rad_out – Radius of the inner boundary if needed. (i.e. the well)
  • z_size (float, optional) – size of the mesh in z-direction
  • name_out (str, optional) – Name of the outer boundary. In 3D there will be as many surfaces as angles are given. Their names are generated by adding the angle number: “_0”, “_1”, … Default: “boundary”
  • name_in (str, optional) – Name of the inner boundary. In 3D there will be as many surfaces as angles are given. Their names are generated by adding the angle number: “_0”, “_1”, … Default: “well”
Returns:

result

Return type:

gli

rectangular(dim=2, ori=(0.0, 0.0, 0.0), size=(10.0, 10.0, 10.0), name='boundary')[source]

Generate a rectangular boundary for a grid in 2D or 3D as gli.

Parameters:
  • dim (int, optional) – Dimension of the resulting mesh, either 2 or 3. Default: 3
  • ori (list of float, optional) – Origin of the mesh Default: [0.0, 0.0, 0.0]
  • size (list of float, optional) – Size of the mesh Default: [10.0, 10.0, 10.0]
  • name (str, optional) – Name of the boundary. In 3D there will be 4 surfaces where the names are generated by adding an ID: “_0”, “_1”, “_2”, “_3” Default: “boundary”
Returns:

result

Return type:

gli