Functions to manage physical points in/out the mesh.

Functions/Subroutines
logical function	is_inside_domain_within_nghosts (position, nghost_cells)
	Test if a point is inside the domain, within N ghost cells. More...

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. More...

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. More...

subroutine	place_point_in_physical_domain (X)
	Project the point into the physical domain. More...

subroutine	place_point_in_physical_domain_noper (X)
	Similar to place_point_in_physical_domain. But here, do not apply periodic principle if present. More...

subroutine	place_point_in_local_domain (X, nghosts_allowed)
	Project the point into the local domain. More...

double precision function	compute_physical_domain_distance (X1, X2)
	Return the Euclidian distance between two points with possible periodic boundaries. More...

logical function	is_point_in_physical_domain (X)
	Is the given point within the physical domain ? More...

logical function	is_point_in_physical_domain_threshold (X, threshold)
	Is the given point within the physical domain ? (within a positive threshold) More...

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
	)

Parameters

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

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

Parameters

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

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

Parameters

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

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

Parameters

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

logical function mod_grid_physical_points::is_point_in_physical_domain ( double precision, dimension(:), intent(in) X )

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

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

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

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

Parameters

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

subroutine mod_grid_physical_points::place_point_in_physical_domain ( double precision, dimension(:), intent(inout) X )

Parameters

[in,out] X the physical point

subroutine mod_grid_physical_points::place_point_in_physical_domain_noper ( double precision, dimension(:), intent(inout) X )

Parameters

[in,out] X the physical point