Octopus
stencil_oct_m Module Reference

This module defines stencils used in Octopus. More...

Detailed Description

This module defines stencils used in Octopus.

Stencils are a fundamental concept in finite difference methods. In general, semi-local operations, such as derivatives, can be extressed as a weighed sum over a neighbourhood of points, relative to the point for which the operation is performed.

The set of points which are used in this sum is called the stencil. Stencils can differ by their shape (e.g. a n-dimensional cross, a star, etc.) and their order, i.e. the number of points in a given direction.

Various specific stencils are defined in the modules:

These differ in the ways the stencils are constructed, but are all represented by stencil_oct_m::stencil_t.

Data Types

type  stargeneral_arms_t
 
type  stencil_t
 The class representing the stencil, which is used for non-local mesh operations. More...
 

Functions/Subroutines

subroutine, public stencil_allocate (this, dim, size)
 
subroutine, public stencil_copy (input, output)
 
subroutine, public stencil_end (this)
 
subroutine, public stencil_union (st1, st2, stu)
 
subroutine, public stencil_init_center (this)
 

Function/Subroutine Documentation

◆ stencil_allocate()

subroutine, public stencil_oct_m::stencil_allocate ( type(stencil_t), intent(inout)  this,
integer, intent(in)  dim,
integer, intent(in)  size 
)

Definition at line 177 of file stencil.F90.

◆ stencil_copy()

subroutine, public stencil_oct_m::stencil_copy ( type(stencil_t), intent(in)  input,
type(stencil_t), intent(out)  output 
)

Definition at line 195 of file stencil.F90.

◆ stencil_end()

subroutine, public stencil_oct_m::stencil_end ( type(stencil_t), intent(inout)  this)

Definition at line 213 of file stencil.F90.

◆ stencil_union()

subroutine, public stencil_oct_m::stencil_union ( type(stencil_t), intent(inout)  st1,
type(stencil_t), intent(inout)  st2,
type(stencil_t), intent(inout)  stu 
)

Definition at line 225 of file stencil.F90.

◆ stencil_init_center()

subroutine, public stencil_oct_m::stencil_init_center ( type(stencil_t), intent(inout)  this)

Definition at line 274 of file stencil.F90.