Data Types
type	mod_shape_basic::t_shape_circle
	Circle/sphere shape. More...

type	mod_shape_basic::t_shape_rectangle
	Rectangle/rectangular cuboid shape. More...

type	mod_shape_basic::t_shape_halfspace
	Half-space shape. More...

type	mod_shape_basic::t_shape_cylinder
	Cylinder shape (3D only) More...

type	mod_shape_basic::t_shape_torus
	Torus shape around Z-axis (3D only) More...

type	mod_shape_basic::t_shape_universe
	Represents the whole space. More...

Functions/Subroutines
subroutine	mod_shape_basic::initialize_shape_circle (shape)
	Initialize the circle/sphere. More...

subroutine	mod_shape_basic::copy_shape_circle (shape, copy)
	Copy the circle/sphere. More...

logical pure function	mod_shape_basic::shape_circle_is_inside (shape, point)
	Check if a point lies inside the circle/sphere. More...

subroutine	mod_shape_basic::shape_circle_get_samples_inside (shape, i, j, k, n, n_samples, samples)
	Check if a given number of point lies in a circle/sphere. More...

pure subroutine	mod_shape_basic::shape_circle_get_distance (shape, point, distance, direction)
	Compute the signed distance and the signed direction from a point to the circle/sphere. More...

subroutine	mod_shape_basic::initialize_shape_rectangle (shape)
	Initialize the rectangle/rectangular cuboid. More...

subroutine	mod_shape_basic::copy_shape_rectangle (shape, copy)
	Copy the rectangle. More...

logical pure function	mod_shape_basic::shape_rectangle_is_inside (shape, point)
	Check if a point lies inside the rectangle/rectangular cuboid. More...

subroutine	mod_shape_basic::shape_rectangle_get_samples_inside (shape, i, j, k, n, n_samples, samples)
	Check if a given number of point lies in a rectrangle/rectangular cuboid. More...

pure subroutine	mod_shape_basic::shape_rectangle_get_distance (shape, point, distance, direction)
	Compute the signed distance and the signed direction from a point to the rectangle/rectangular cuboid. More...

subroutine	mod_shape_basic::initialize_shape_halfspace (shape)
	Initialize the half-space. More...

subroutine	mod_shape_basic::copy_shape_halfspace (shape, copy)
	Copy the half-space. More...

logical pure function	mod_shape_basic::shape_halfspace_is_inside (shape, point)
	Check if a point lies inside the half-space. More...

subroutine	mod_shape_basic::shape_halfspace_get_samples_inside (shape, i, j, k, n, n_samples, samples)
	Check if a given number of point lies in a half-space. More...

pure subroutine	mod_shape_basic::shape_halfspace_get_distance (shape, point, distance, direction)
	Compute the signed distance and the signed direction from a point to the half-space. More...

subroutine	mod_shape_basic::initialize_shape_cylinder (shape)
	Initialize the cylinder. More...

subroutine	mod_shape_basic::copy_shape_cylinder (shape, copy)
	Copy the cylinder. More...

logical pure function	mod_shape_basic::shape_cylinder_is_inside (shape, point)
	Check if a point lies inside the cylinder (3D only) More...

subroutine	mod_shape_basic::shape_cylinder_get_samples_inside (shape, i, j, k, n, n_samples, samples)
	Check if a given number of point lies in a cylinder. More...

pure subroutine	mod_shape_basic::shape_cylinder_get_distance (shape, point, distance, direction)
	Compute the signed distance and the signed direction from a point to the cylinder. More...

subroutine	mod_shape_basic::initialize_shape_torus (shape)
	Initialize the torus. More...

subroutine	mod_shape_basic::copy_shape_torus (shape, copy)
	Copy the torus. More...

logical pure function	mod_shape_basic::shape_torus_is_inside (shape, point)
	Check if a point lies inside the torus (3D only) More...

subroutine	mod_shape_basic::shape_torus_get_samples_inside (shape, i, j, k, n, n_samples, samples)
	Check if a given number of point lies in a torus. More...

pure subroutine	mod_shape_basic::shape_torus_get_distance (shape, point, distance, direction)
	Compute the signed distance and the signed direction from a point to the torus. More...

subroutine	mod_shape_basic::initialize_shape_universe (shape)
	Initialize the universe. More...

subroutine	mod_shape_basic::copy_shape_universe (shape, copy)
	Copy the universe. More...

logical pure function	mod_shape_basic::shape_universe_is_inside (shape, point)
	Check if a point lies inside the universe (always true) More...

subroutine	mod_shape_basic::shape_universe_get_samples_inside (shape, i, j, k, n, n_samples, samples)
	Check if a given number of point lies in the universe (yes, they do!) More...

pure subroutine	mod_shape_basic::shape_universe_get_distance (shape, point, distance, direction)
	Compute the signed distance and the signed direction from a point to the universe. More...

Detailed Description

Function/Subroutine Documentation

◆ copy_shape_circle()

subroutine mod_shape_basic::copy_shape_circle	(	class(t_shape_circle), intent(in)	shape,
		class(t_shape), allocatable	copy
	)

Parameters

[in]	shape	circle/sphere shape
[out]	copy	copied circle/sphere

◆ copy_shape_cylinder()

subroutine mod_shape_basic::copy_shape_cylinder	(	class(t_shape_cylinder), intent(in)	shape,
		class(t_shape), allocatable	copy
	)

Parameters

[in]	shape	cylinder shape
[out]	copy	copied cylinder

◆ copy_shape_halfspace()

subroutine mod_shape_basic::copy_shape_halfspace	(	class(t_shape_halfspace), intent(in)	shape,
		class(t_shape), allocatable	copy
	)

Parameters

[in]	shape	half-space shape
[out]	copy	copied half-space

◆ copy_shape_rectangle()

subroutine mod_shape_basic::copy_shape_rectangle	(	class(t_shape_rectangle), intent(in)	shape,
		class(t_shape), allocatable	copy
	)

Parameters

[in]	shape	rectangle shape
[out]	copy	copied rectangle

◆ copy_shape_torus()

subroutine mod_shape_basic::copy_shape_torus	(	class(t_shape_torus), intent(in)	shape,
		class(t_shape), allocatable	copy
	)

Parameters

[in]	shape	torus shape
[out]	copy	copied torus

◆ copy_shape_universe()

subroutine mod_shape_basic::copy_shape_universe	(	class(t_shape_universe), intent(in)	shape,
		class(t_shape), allocatable	copy
	)

Parameters

[in]	shape	universe shape
[out]	copy	copied universe

◆ initialize_shape_circle()

subroutine mod_shape_basic::initialize_shape_circle ( class(t_shape_circle), intent(inout) shape )

Parameters

[in,out] shape circle/sphere shape

◆ initialize_shape_cylinder()

subroutine mod_shape_basic::initialize_shape_cylinder ( class(t_shape_cylinder), intent(inout) shape )

Parameters

[in,out] shape cylinder shape

◆ initialize_shape_halfspace()

subroutine mod_shape_basic::initialize_shape_halfspace ( class(t_shape_halfspace), intent(inout) shape )

Parameters

[in,out] shape half-space shape

◆ initialize_shape_rectangle()

subroutine mod_shape_basic::initialize_shape_rectangle ( class(t_shape_rectangle), intent(inout) shape )

Parameters

[in,out] shape rectangle shape

◆ initialize_shape_torus()

subroutine mod_shape_basic::initialize_shape_torus ( class(t_shape_torus), intent(inout) shape )

Parameters

[in,out] shape torus shape

◆ initialize_shape_universe()

subroutine mod_shape_basic::initialize_shape_universe ( class(t_shape_universe), intent(inout) shape )

Parameters

[in,out] shape universe shape

◆ shape_circle_get_distance()

pure subroutine mod_shape_basic::shape_circle_get_distance	(	class(t_shape_circle), intent(in)	shape,
		double precision, dimension(3), intent(in)	point,
		double precision, intent(out)	distance,
		double precision, dimension(3), intent(out)	direction
	)

If the point lies inside the circle/sphere, the distance is negative and the direction points to the closest point on the circle/sphere. If the point lies outiside the circle/sphere, the distance is positive and the direction points in the opposite direction to the closest point on the circle/sphere.

Parameters

[in]	shape	circle/sphere shape
[in]	point	any point
[out]	distance	signed closest distance from the point to the circle/sphere
[out]	direction	signed direction from the point to the closest point on the circle/sphere

◆ shape_circle_get_samples_inside()

subroutine mod_shape_basic::shape_circle_get_samples_inside	(	class(t_shape_circle), intent(inout)	shape,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	n,
		integer, intent(in)	n_samples,
		integer, dimension(:,:,:), intent(inout)	samples
	)

Sample a cell of coordinates (i,j,k) with (2*n_samples+1)^d samples, where d denotes the dimension of the cell. Return a integer array samples containing the value n where the sample is inside the shape.

n_samples is called the sampling level and can take its value in range [0,∞].

Example of sampling for various sampling level:

    n_samples = 0   n_samples = 1   n_samples = 2
      ┏━━━━━━━┓       ×━━━×━━━×       ×━×━×━×━×
      ┃       ┃       ┃       ┃       × × × × ×
      ┃   ×   ┃       ×   ×   ×       × × × × ×    ...
      ┃       ┃       ┃       ┃       × × × × ×
      ┗━━━━━━━┛       ×━━━×━━━×       ×━×━×━×━×

Parameters

[in,out]	shape	circle/sphere shape
[in]	i,j,k	coordinates of the cell
[in]	n	value to put where the sample is inside the circle/sphere
[in]	n_samples	sampling level (see description)
[in,out]	samples	array of the (2*n_samples+1)^d samples

◆ shape_circle_is_inside()

logical pure function mod_shape_basic::shape_circle_is_inside	(	class(t_shape_circle), intent(in)	shape,
		double precision, dimension(3), intent(in)	point
	)

Parameters

[in]	shape	circle/sphere shape
[in]	point	any point

◆ shape_cylinder_get_distance()

pure subroutine mod_shape_basic::shape_cylinder_get_distance	(	class(t_shape_cylinder), intent(in)	shape,
		double precision, dimension(3), intent(in)	point,
		double precision, intent(out)	distance,
		double precision, dimension(3), intent(out)	direction
	)

If the point lies inside the cylinder, the distance is negative and the direction points to the closest point on the cylinder. If the point lies outiside the cylinder, the distance is positive and the direction points in the opposite direction to the closest point on the cylinder.

Parameters

[in]	shape	cylinder shape
[in]	point	any point
[out]	distance	signed closest distance from the point to the cylinder
[out]	direction	signed direction from the point to the closest point on the cylinder

◆ shape_cylinder_get_samples_inside()

subroutine mod_shape_basic::shape_cylinder_get_samples_inside	(	class(t_shape_cylinder), intent(inout)	shape,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	n,
		integer, intent(in)	n_samples,
		integer, dimension(:,:,:), intent(inout)	samples
	)

Sample a cell of coordinates (i,j,k) with (2*n_samples+1)^d samples, where d denotes the dimension of the cell. Return a integer array samples containing the value n where the sample is inside the shape.

n_samples is called the sampling level and can take its value in range [0,∞].

Example of sampling for various sampling level:

    n_samples = 0   n_samples = 1   n_samples = 2
      ┏━━━━━━━┓       ×━━━×━━━×       ×━×━×━×━×
      ┃       ┃       ┃       ┃       × × × × ×
      ┃   ×   ┃       ×   ×   ×       × × × × ×    ...
      ┃       ┃       ┃       ┃       × × × × ×
      ┗━━━━━━━┛       ×━━━×━━━×       ×━×━×━×━×

Parameters

[in,out]	shape	cylinder shape
[in]	i,j,k	coordinates of the cell
[in]	n	value to put where the sample is inside the cylinder
[in]	n_samples	sampling level (see description)
[in,out]	samples	array of the (2*n_samples+1)^d samples

◆ shape_cylinder_is_inside()

logical pure function mod_shape_basic::shape_cylinder_is_inside	(	class(t_shape_cylinder), intent(in)	shape,
		double precision, dimension(3), intent(in)	point
	)

Parameters

[in]	shape	cylinder shape
[in]	point	any point

◆ shape_halfspace_get_distance()

pure subroutine mod_shape_basic::shape_halfspace_get_distance	(	class(t_shape_halfspace), intent(in)	shape,
		double precision, dimension(3), intent(in)	point,
		double precision, intent(out)	distance,
		double precision, dimension(3), intent(out)	direction
	)

If the point lies inside the half-space, the distance is negative and the direction points to the closest point on the half-space. If the point lies outiside the half-space, the distance is positive and the direction points in the opposite direction to the closest point on the half-space.

Parameters

[in]	shape	half-space shape
[in]	point	any point
[out]	distance	signed closest distance from the point to the half-space
[out]	direction	signed direction from the point to the closest point on the half-space

◆ shape_halfspace_get_samples_inside()

subroutine mod_shape_basic::shape_halfspace_get_samples_inside	(	class(t_shape_halfspace), intent(inout)	shape,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	n,
		integer, intent(in)	n_samples,
		integer, dimension(:,:,:), intent(inout)	samples
	)

Sample a cell of coordinates (i,j,k) with (2*n_samples+1)^d samples, where d denotes the dimension of the cell. Return a integer array samples containing the value n where the sample is inside the shape.

n_samples is called the sampling level and can take its value in range [0,∞].

Example of sampling for various sampling level:

    n_samples = 0   n_samples = 1   n_samples = 2
      ┏━━━━━━━┓       ×━━━×━━━×       ×━×━×━×━×
      ┃       ┃       ┃       ┃       × × × × ×
      ┃   ×   ┃       ×   ×   ×       × × × × ×    ...
      ┃       ┃       ┃       ┃       × × × × ×
      ┗━━━━━━━┛       ×━━━×━━━×       ×━×━×━×━×

Parameters

[in,out]	shape	half-space shape
[in]	i,j,k	coordinates of the cell
[in]	n	value to put where the sample is inside the half-space
[in]	n_samples	sampling level (see description)
[in,out]	samples	array of the (2*n_samples+1)^d samples

◆ shape_halfspace_is_inside()

logical pure function mod_shape_basic::shape_halfspace_is_inside	(	class(t_shape_halfspace), intent(in)	shape,
		double precision, dimension(3), intent(in)	point
	)

Parameters

[in]	shape	half-space shape
[in]	point	any point

◆ shape_rectangle_get_distance()

pure subroutine mod_shape_basic::shape_rectangle_get_distance	(	class(t_shape_rectangle), intent(in)	shape,
		double precision, dimension(3), intent(in)	point,
		double precision, intent(out)	distance,
		double precision, dimension(3), intent(out)	direction
	)

If the point lies inside the rectangle/rectangular cuboid, the distance is negative and the direction points to the closest point on the rectangle/rectangular cuboid. If the point lies outside the rectangle/rectangular cuboid, the distance is positive and the direction points in the opposite direction to the closest point on the rectangle/rectangular cuboid.

Parameters

[in]	shape	rectangle/rectangular cuboid shape
[in]	point	any point
[out]	distance	signed closest distance from the point to the rectangle/rectangular cuboid
[out]	direction	signed direction from the point to the closest point on the rectangle/rectangular cuboid

◆ shape_rectangle_get_samples_inside()

subroutine mod_shape_basic::shape_rectangle_get_samples_inside	(	class(t_shape_rectangle), intent(inout)	shape,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	n,
		integer, intent(in)	n_samples,
		integer, dimension(:,:,:), intent(inout)	samples
	)

Sample a cell of coordinates (i,j,k) with (2*n_samples+1)^d samples, where d denotes the dimension of the cell. Return a integer array samples containing the value n where the sample is inside the shape.

n_samples is called the sampling level and can take its value in range [0,∞].

Example of sampling for various sampling level:

    n_samples = 0   n_samples = 1   n_samples = 2
      ┏━━━━━━━┓       ×━━━×━━━×       ×━×━×━×━×
      ┃       ┃       ┃       ┃       × × × × ×
      ┃   ×   ┃       ×   ×   ×       × × × × ×    ...
      ┃       ┃       ┃       ┃       × × × × ×
      ┗━━━━━━━┛       ×━━━×━━━×       ×━×━×━×━×

Parameters

[in,out]	shape	rectangle/rectangular cuboid shape
[in]	i,j,k	coordinates of the cell
[in]	n	value to put where the sample is inside the rectangle/rectangular cuboid
[in]	n_samples	sampling level (see description)
[in,out]	samples	array of the (2*n_samples+1)^d samples

◆ shape_rectangle_is_inside()

logical pure function mod_shape_basic::shape_rectangle_is_inside	(	class(t_shape_rectangle), intent(in)	shape,
		double precision, dimension(3), intent(in)	point
	)

Parameters

[in]	shape	rectangle/rectangular cuboid shape
[in]	point	any point

◆ shape_torus_get_distance()

pure subroutine mod_shape_basic::shape_torus_get_distance	(	class(t_shape_torus), intent(in)	shape,
		double precision, dimension(3), intent(in)	point,
		double precision, intent(out)	distance,
		double precision, dimension(3), intent(out)	direction
	)

If the point lies inside the torus, the distance is negative and the direction points to the closest point on the torus. If the point lies outiside the torus, the distance is positive and the direction points in the opposite direction to the closest point on the torus.

Parameters

[in]	shape	torus shape
[in]	point	any point
[out]	distance	signed closest distance from the point to the torus
[out]	direction	signed direction from the point to the closest point on the torus

◆ shape_torus_get_samples_inside()

subroutine mod_shape_basic::shape_torus_get_samples_inside	(	class(t_shape_torus), intent(inout)	shape,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	n,
		integer, intent(in)	n_samples,
		integer, dimension(:,:,:), intent(inout)	samples
	)

Sample a cell of coordinates (i,j,k) with (2*n_samples+1)^d samples, where d denotes the dimension of the cell. Return a integer array samples containing the value n where the sample is inside the shape.

n_samples is called the sampling level and can take its value in range [0,∞].

Example of sampling for various sampling level:

    n_samples = 0   n_samples = 1   n_samples = 2
      ┏━━━━━━━┓       ×━━━×━━━×       ×━×━×━×━×
      ┃       ┃       ┃       ┃       × × × × ×
      ┃   ×   ┃       ×   ×   ×       × × × × ×    ...
      ┃       ┃       ┃       ┃       × × × × ×
      ┗━━━━━━━┛       ×━━━×━━━×       ×━×━×━×━×

Parameters

[in,out]	shape	torus shape
[in]	i,j,k	coordinates of the cell
[in]	n	value to put where the sample is inside the torus
[in]	n_samples	sampling level (see description)
[in,out]	samples	array of the (2*n_samples+1)^d samples

◆ shape_torus_is_inside()

logical pure function mod_shape_basic::shape_torus_is_inside	(	class(t_shape_torus), intent(in)	shape,
		double precision, dimension(3), intent(in)	point
	)

Parameters

[in]	shape	torus shape
[in]	point	any point

◆ shape_universe_get_distance()

pure subroutine mod_shape_basic::shape_universe_get_distance	(	class(t_shape_universe), intent(in)	shape,
		double precision, dimension(3), intent(in)	point,
		double precision, intent(out)	distance,
		double precision, dimension(3), intent(out)	direction
	)

If the point lies inside the universe, the distance is negative and the direction points to the closest point on the universe. If the point lies outside the universe (Wait, what?), the distance is positive and the direction points in the opposite direction to the closest point on the universe.

Parameters

[in]	shape	universe shape
[in]	point	any point
[out]	distance	signed closest distance from the point to the universe
[out]	direction	signed direction from the point to the closest point on the universe

◆ shape_universe_get_samples_inside()

subroutine mod_shape_basic::shape_universe_get_samples_inside	(	class(t_shape_universe), intent(inout)	shape,
		integer, intent(in)	i,
		integer, intent(in)	j,
		integer, intent(in)	k,
		integer, intent(in)	n,
		integer, intent(in)	n_samples,
		integer, dimension(:,:,:), intent(inout)	samples
	)

Sample a cell of coordinates (i,j,k) with (2*n_samples+1)^d samples, where d denotes the dimension of the cell. Return a integer array samples containing the value n where the sample is inside the shape.

n_samples is called the sampling level and can take its value in range [0,∞].

Example of sampling for various sampling level:

    n_samples = 0   n_samples = 1   n_samples = 2
      ┏━━━━━━━┓       ×━━━×━━━×       ×━×━×━×━×
      ┃       ┃       ┃       ┃       × × × × ×
      ┃   ×   ┃       ×   ×   ×       × × × × ×    ...
      ┃       ┃       ┃       ┃       × × × × ×
      ┗━━━━━━━┛       ×━━━×━━━×       ×━×━×━×━×

Parameters

[in,out]	shape	universe shape
[in]	i,j,k	coordinates of the cell
[in]	n	value to put where the sample is inside the universe
[in]	n_samples	sampling level (see description)
[in,out]	samples	array of the (2*n_samples+1)^d samples

◆ shape_universe_is_inside()

logical pure function mod_shape_basic::shape_universe_is_inside	(	class(t_shape_universe), intent(in)	shape,
		double precision, dimension(3), intent(in)	point
	)

Parameters

[in]	shape	universe shape
[in]	point	any point

Data Types

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ copy_shape_circle()

◆ copy_shape_cylinder()

◆ copy_shape_halfspace()

◆ copy_shape_rectangle()

◆ copy_shape_torus()

◆ copy_shape_universe()

◆ initialize_shape_circle()

◆ initialize_shape_cylinder()

◆ initialize_shape_halfspace()

◆ initialize_shape_rectangle()

◆ initialize_shape_torus()

◆ initialize_shape_universe()

◆ shape_circle_get_distance()

◆ shape_circle_get_samples_inside()

◆ shape_circle_is_inside()

◆ shape_cylinder_get_distance()

◆ shape_cylinder_get_samples_inside()

◆ shape_cylinder_is_inside()

◆ shape_halfspace_get_distance()

◆ shape_halfspace_get_samples_inside()

◆ shape_halfspace_is_inside()

◆ shape_rectangle_get_distance()

◆ shape_rectangle_get_samples_inside()

◆ shape_rectangle_is_inside()

◆ shape_torus_get_distance()

◆ shape_torus_get_samples_inside()

◆ shape_torus_is_inside()

◆ shape_universe_get_distance()

◆ shape_universe_get_samples_inside()

◆ shape_universe_is_inside()