# PLaSK User Manual

#### Page Contents

- Rectangular2D.SmoothGenerator Class
  - `Rectangular2D.SmoothGenerator`
  - Methods
  - Attributes
  - Descriptions
    - Method Details
      - `Rectangular2D.SmoothGenerator.__call__()`
      - `Rectangular2D.SmoothGenerator.add_refinement()`
      - `Rectangular2D.SmoothGenerator.clear_cache()`
      - `Rectangular2D.SmoothGenerator.clear_refinements()`
      - `Rectangular2D.SmoothGenerator.generate()`
      - `Rectangular2D.SmoothGenerator.get_refinements()`
      - `Rectangular2D.SmoothGenerator.remove_refinement()`
      - `Rectangular2D.SmoothGenerator.remove_refinements()`
    - Attribute Details
      - `Rectangular2D.SmoothGenerator.aspect`
      - `Rectangular2D.SmoothGenerator.factor`
      - `Rectangular2D.SmoothGenerator.large`
      - `Rectangular2D.SmoothGenerator.small`

# Rectangular2D.SmoothGenerator Class

class Rectangular2D.SmoothGenerator

  Generator of Rectilinear2D mesh with dense sampling at edges and smooth change of element size.

  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.
`factor` | factor by which element sizes increase along each axis
`large` | maximum size of mesh elements along each axis
`small` | small size of mesh elements near object edges along each axis

## Descriptions

### Method Details

Rectangular2D.SmoothGenerator.__call__(geometry)
Rectangular2D.SmoothGenerator.__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.

Rectangular2D.SmoothGenerator.add_refinement(axis, subtree, at)
Rectangular2D.SmoothGenerator.add_refinement(axis, object, at)
Rectangular2D.SmoothGenerator.add_refinement(axis, path, at)
Rectangular2D.SmoothGenerator.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

Rectangular2D.SmoothGenerator.clear_cache()

  Clear cache of generated meshes

Rectangular2D.SmoothGenerator.clear_refinements(subtree)

  Clear all refining lines

Rectangular2D.SmoothGenerator.generate(geometry)
Rectangular2D.SmoothGenerator.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.

Rectangular2D.SmoothGenerator.get_refinements(axis)

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

Rectangular2D.SmoothGenerator.remove_refinement(axis, subtree, at)
Rectangular2D.SmoothGenerator.remove_refinement(axis, object, at)
Rectangular2D.SmoothGenerator.remove_refinement(axis, path, at)
Rectangular2D.SmoothGenerator.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

Rectangular2D.SmoothGenerator.remove_refinements(path)
Rectangular2D.SmoothGenerator.remove_refinements(subtree)
Rectangular2D.SmoothGenerator.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

Rectangular2D.SmoothGenerator.aspect = <property object>

  Maximum aspect ratio for the elements generated by this generator.

Rectangular2D.SmoothGenerator.factor = <property object>

  factor by which element sizes increase along each axis

Rectangular2D.SmoothGenerator.large = <property object>

  maximum size of mesh elements along each axis

Rectangular2D.SmoothGenerator.small = <property object>

  small size of mesh elements near object edges along each axis