mod_grid_physical_points Module Reference

Functions to manage physical points in/out the mesh. More...

Functions/Subroutines
logical function	is_inside_domain_within_nghosts (position, nghost_cells)
	Test if a point is inside the domain, within N ghost cells.
logical function	is_inside_cells_domain_within_nghosts (position, nghost_cells)
	Test if a point is inside the cells' domain, within N ghost cells The cells domain encompass only the box between the first and the last cells center.
logical function	is_inside_cells_real_domain_within_nghosts (position, nghost_cells)
	Very similar to the is_inside_cells_domain_within_Nghosts function. However, the function returns true if outside but the node is on the physical boundary.
subroutine	place_point_in_physical_domain (x)
	Project the point into the physical domain.
subroutine	place_point_in_physical_domain_noper (x)
	Similar to place_point_in_physical_domain. But here, do not apply periodic principle if present.
subroutine	place_point_in_local_domain (x, nghosts_allowed)
	Project the point into the local domain.
double precision function	compute_physical_domain_distance (x1, x2)
	Return the Euclidian distance between two points with possible periodic boundaries.
logical function	is_point_in_physical_domain (x)
	Is the given point within the physical domain ?
logical function	is_point_in_physical_domain_threshold (x, threshold)
	Is the given point within the physical domain ? (within a positive threshold)

Detailed Description

Functions to manage physical points in/out the mesh.

Function/Subroutine Documentation

compute_physical_domain_distance()

double precision function mod_grid_physical_points::compute_physical_domain_distance	(	double precision, dimension(:), intent(in)	x1,
		double precision, dimension(:), intent(in)	x2 )

Return the Euclidian distance between two points with possible periodic boundaries.

Parameters

[in]	X1	the first point
[in]	X2	the second point

is_inside_cells_domain_within_nghosts()

logical function mod_grid_physical_points::is_inside_cells_domain_within_nghosts	(	double precision, dimension(:)	position,
		integer, intent(in)	nghost_cells )

Test if a point is inside the cells' domain, within N ghost cells The cells domain encompass only the box between the first and the last cells center.

Parameters

[in]	position	The position of the point
[in]	nghost_cells	The (positive) number of ghosts cells 0<nghost_cells<nghost

is_inside_cells_real_domain_within_nghosts()

logical function mod_grid_physical_points::is_inside_cells_real_domain_within_nghosts	(	double precision, dimension(:)	position,
		integer, intent(in)	nghost_cells )

Very similar to the is_inside_cells_domain_within_Nghosts function. However, the function returns true if outside but the node is on the physical boundary.

Parameters

[in]	position	The position of the point
[in]	nghost_cells	The (positive) number of ghosts cells 0<nghost_cells<nghost

is_inside_domain_within_nghosts()

logical function mod_grid_physical_points::is_inside_domain_within_nghosts	(	double precision, dimension(:)	position,
		integer, intent(in)	nghost_cells )

Test if a point is inside the domain, within N ghost cells.

Parameters

[in]	position	The position of the point
[in]	nghost_cells	The (positive) number of ghosts cells 0<nghost_cells<nghost

is_point_in_physical_domain()

logical function mod_grid_physical_points::is_point_in_physical_domain

(

double precision, dimension(:), intent(in)

x

)

Is the given point within the physical domain ?

Note

The physical domain is defined by the physical boundaries, not to be confounded with the processor's/node's domain.

is_point_in_physical_domain_threshold()

logical function mod_grid_physical_points::is_point_in_physical_domain_threshold	(	double precision, dimension(:), intent(in)	x,
		double precision, intent(in)	threshold )

Is the given point within the physical domain ? (within a positive threshold)

Note

The physical domain is defined by the physical boundaries, not to be confounded with the processor's/node's domain.

place_point_in_local_domain()

subroutine mod_grid_physical_points::place_point_in_local_domain	(	double precision, dimension(:), intent(inout)	x,
		integer, intent(in)	nghosts_allowed )

Project the point into the local domain.

Parameters

[in,out]	X	the local point
[in,out]	nghosts_allowed	the number of ghosts allowed

place_point_in_physical_domain()

subroutine mod_grid_physical_points::place_point_in_physical_domain

(

double precision, dimension(:), intent(inout)

x

)

Project the point into the physical domain.

Parameters

[in,out]

X

the physical point

place_point_in_physical_domain_noper()

subroutine mod_grid_physical_points::place_point_in_physical_domain_noper

(

double precision, dimension(:), intent(inout)

x

)

Similar to place_point_in_physical_domain. But here, do not apply periodic principle if present.

Parameters

[in,out]

X

the physical point