# PLaSK User Manual

#### Page Contents

- Ordered.DivideGenerator Class
  - `Ordered.DivideGenerator`
  - Methods
  - Attributes
  - Descriptions
    - Method Details
      - `Ordered.DivideGenerator.__call__()`
      - `Ordered.DivideGenerator.add_refinement()`
      - `Ordered.DivideGenerator.clear_cache()`
      - `Ordered.DivideGenerator.clear_refinements()`
      - `Ordered.DivideGenerator.generate()`
      - `Ordered.DivideGenerator.get_refinements()`
      - `Ordered.DivideGenerator.remove_refinement()`
      - `Ordered.DivideGenerator.remove_refinements()`
    - Attribute Details
      - `Ordered.DivideGenerator.aspect`
      - `Ordered.DivideGenerator.gradual`
      - `Ordered.DivideGenerator.postdiv`
      - `Ordered.DivideGenerator.prediv`

# Ordered.DivideGenerator Class

class Ordered.DivideGenerator

  Generator of Rectilinear1D mesh by simple division of the geometry.

  create generator without initial division of geometry objects

## Methods

`__call__`(...) | Generate mesh for given geometry object or load it from the cache.
`add_refinement`(...) | Add a refining line inside the object
`clear_cache`() | Clear cache of generated meshes
`clear_refinements`(subtree) | Clear all refining lines
`generate`(...) | Generate mesh for given geometry object omitting the cache.
`get_refinements`(axis) | Get list of all the refinements defined for this generator for specified axis
`remove_refinement`(...) | Remove the refining line from the object
`remove_refinements`(...) | Remove the all refining lines from the object

## Attributes

`aspect` | Maximum aspect ratio for the elements generated by this generator.
`gradual` | Limit maximum adjacent objects size change to the factor of two.
`postdiv` | final division of all geometry objects
`prediv` | initial division of all geometry objects

## Descriptions

### Method Details

Ordered.DivideGenerator.__call__(geometry)
Ordered.DivideGenerator.__call__(object)

  Generate mesh for given geometry object or load it from the cache.

  Parameters:

    - geometry – Geometry to generate mesh at.

    - object – Geometry object to generate mesh at.

Ordered.DivideGenerator.add_refinement(axis, subtree, at)
Ordered.DivideGenerator.add_refinement(axis, object, at)
Ordered.DivideGenerator.add_refinement(axis, path, at)
Ordered.DivideGenerator.add_refinement(axis, object, path, at)

  Add a refining line inside the object

  Add a refining line inside the object

  Add a refining line inside the object

  Add a refining line inside the object

Ordered.DivideGenerator.clear_cache()

  Clear cache of generated meshes

Ordered.DivideGenerator.clear_refinements(subtree)

  Clear all refining lines

Ordered.DivideGenerator.generate(geometry)
Ordered.DivideGenerator.generate(object)

  Generate mesh for given geometry object omitting the cache.

  Parameters:

    - geometry – Geometry to generate mesh at.

    - object – Geometry object to generate mesh at.

Ordered.DivideGenerator.get_refinements(axis)

  Get list of all the refinements defined for this generator for specified axis

Ordered.DivideGenerator.remove_refinement(axis, subtree, at)
Ordered.DivideGenerator.remove_refinement(axis, object, at)
Ordered.DivideGenerator.remove_refinement(axis, path, at)
Ordered.DivideGenerator.remove_refinement(axis, object, path, at)

  Remove the refining line from the object

  Remove the refining line from the object

  Remove the refining line from the object

  Remove the refining line from the object

Ordered.DivideGenerator.remove_refinements(path)
Ordered.DivideGenerator.remove_refinements(subtree)
Ordered.DivideGenerator.remove_refinements(object, path=None)

  Remove the all refining lines from the object

  Remove the all refining lines from the object

  Remove the all refining lines from the object

### Attribute Details

Ordered.DivideGenerator.aspect = <property object>

  Maximum aspect ratio for the elements generated by this generator.

Ordered.DivideGenerator.gradual = <property object>

  Limit maximum adjacent objects size change to the factor of two.

Ordered.DivideGenerator.postdiv = <property object>

  final division of all geometry objects

Ordered.DivideGenerator.prediv = <property object>

  initial division of all geometry objects