#include <deal.II/base/mpi_remote_point_evaluation.h>

Inheritance diagram for Utilities::MPI::RemotePointEvaluation< dim, spacedim >:

Classes
struct	CellData

Public Member Functions
	RemotePointEvaluation (const double tolerance=1e-6, const bool enforce_unique_mapping=false, const unsigned int rtree_level=0, const std::function< std::vector< bool >()> &marked_vertices={})

	~RemotePointEvaluation ()

void	reinit (const std::vector< Point< spacedim > > &points, const Triangulation< dim, spacedim > &tria, const Mapping< dim, spacedim > &mapping)

void	reinit (const GridTools::internal::DistributedComputePointLocationsInternal< dim, spacedim > &data, const Triangulation< dim, spacedim > &tria, const Mapping< dim, spacedim > &mapping)

const CellData &	get_cell_data () const

template<typename T >
void	evaluate_and_process (std::vector< T > &output, std::vector< T > &buffer, const std::function< void(const ArrayView< T > &, const CellData &)> &evaluation_function) const

template<typename T >
void	process_and_evaluate (const std::vector< T > &input, std::vector< T > &buffer, const std::function< void(const ArrayView< const T > &, const CellData &)> &evaluation_function) const

const std::vector< unsigned int > &	get_point_ptrs () const

bool	is_map_unique () const

bool	all_points_found () const

bool	point_found (const unsigned int i) const

const Triangulation< dim, spacedim > &	get_triangulation () const

const Mapping< dim, spacedim > &	get_mapping () const

bool	is_ready () const

Private Attributes
const double	tolerance

const bool	enforce_unique_mapping

const unsigned int	rtree_level

const std::function< std::vector< bool >()>	marked_vertices

boost::signals2::connection	tria_signal

bool	ready_flag

SmartPointer< const Triangulation< dim, spacedim > >	tria

SmartPointer< const Mapping< dim, spacedim > >	mapping

bool	unique_mapping

bool	all_points_found_flag

std::vector< unsigned int >	point_ptrs

std::vector< unsigned int >	recv_permutation

std::vector< unsigned int >	recv_ptrs

std::vector< unsigned int >	recv_ranks

CellData	cell_data

std::vector< unsigned int >	send_permutation

std::vector< unsigned int >	send_ranks

std::vector< unsigned int >	send_ptrs

Detailed Description

template<int dim, int spacedim = dim>
class Utilities::MPI::RemotePointEvaluation< dim, spacedim >

Helper class to access values on non-matching grids.

Note: The name of the fields are chosen with the method evaluate_and_process() in mind. Here, quantities are computed at specified arbitrary positioned points (and even on remote processes in the MPI universe) cell by cell and these values are sent to requesting processes, which receive the result and resort the result according to the points.

Definition at line 53 of file mpi_remote_point_evaluation.h.

Constructor & Destructor Documentation

◆ RemotePointEvaluation()

template<int dim, int spacedim>

Utilities::MPI::RemotePointEvaluation< dim, spacedim >::RemotePointEvaluation	(	const double	tolerance = `1e-6`,
		const bool	enforce_unique_mapping = `false`,
		const unsigned int	rtree_level = `0`,
		const std::function< std::vector< bool >()> &	marked_vertices = `{}`
	)

Constructor.

Parameters

tolerance	Tolerance in terms of unit cell coordinates for determining all cells around a point passed to the class during reinit(). Depending on the problem, it might be necessary to adjust the tolerance in order to be able to identify a cell. Floating point arithmetic implies that a point will, in general, not lie exactly on a vertex, edge, or face.
enforce_unique_mapping	Enforce unique mapping, i.e., (one-to-one) relation of points and cells.
rtree_level	RTree level to be used during the construction of the bounding boxes.
marked_vertices	Function that marks relevant vertices to make search of active cells around point more efficient.

Definition at line 39 of file mpi_remote_point_evaluation.cc.

◆ ~RemotePointEvaluation()

template<int dim, int spacedim>

Utilities::MPI::RemotePointEvaluation< dim, spacedim >::~RemotePointEvaluation

Destructor.

Definition at line 54 of file mpi_remote_point_evaluation.cc.

Member Function Documentation

◆ reinit() [1/2]

template<int dim, int spacedim>

void Utilities::MPI::RemotePointEvaluation< dim, spacedim >::reinit	(	const std::vector< Point< spacedim > > &	points,
		const Triangulation< dim, spacedim > &	tria,
		const Mapping< dim, spacedim > &	mapping
	)

Set up internal data structures and communication pattern based on a list of points points and mesh description (tria and mapping).

Warning: This is a collective call that needs to be executed by all processors in the communicator.

Note: If you want to be sure that all points have been found, call all_points_found() after calling this function.

Definition at line 64 of file mpi_remote_point_evaluation.cc.

◆ reinit() [2/2]

template<int dim, int spacedim>

void Utilities::MPI::RemotePointEvaluation< dim, spacedim >::reinit	(	const GridTools::internal::DistributedComputePointLocationsInternal< dim, spacedim > &	data,
		const Triangulation< dim, spacedim > &	tria,
		const Mapping< dim, spacedim > &	mapping
	)

Set up internal data structures and communication pattern based on GridTools::internal::DistributedComputePointLocationsInternal.

This function is called internally by the reinit() function above. Having it as a separate function makes it possible to set up the class if it is known in which cells corresponding reference points are located (e.g. if intersections of cells are known).

Definition at line 113 of file mpi_remote_point_evaluation.cc.

◆ get_cell_data()

template<int dim, int spacedim>

const RemotePointEvaluation< dim, spacedim >::CellData & Utilities::MPI::RemotePointEvaluation< dim, spacedim >::get_cell_data

Return internal data structure storing the data of points positioned in cells.

Definition at line 219 of file mpi_remote_point_evaluation.cc.

◆ evaluate_and_process()

template<int dim, int spacedim>

template<typename T >

void Utilities::MPI::RemotePointEvaluation< dim, spacedim >::evaluate_and_process	(	std::vector< T > &	output,
		std::vector< T > &	buffer,
		const std::function< void(const ArrayView< T > &, const CellData &)> &	evaluation_function
	)		const

Evaluate function evaluation_function in the given points and triangulation. The result is stored in output.

Note: If the map of points to cells is not a one-to-one relation (is_map_unique()==false), the result needs to be processed with the help of get_point_ptrs(). This might be the case if a point coincides with a geometric entity (e.g., vertex) that is shared by multiple cells or a point is outside of the computational domain.

Warning: This is a collective call that needs to be executed by all processors in the communicator.

Definition at line 334 of file mpi_remote_point_evaluation.h.

◆ process_and_evaluate()

template<int dim, int spacedim>

template<typename T >

void Utilities::MPI::RemotePointEvaluation< dim, spacedim >::process_and_evaluate	(	const std::vector< T > &	input,
		std::vector< T > &	buffer,
		const std::function< void(const ArrayView< const T > &, const CellData &)> &	evaluation_function
	)		const

This method is the inverse of the method evaluate_and_process(). It makes the data at the points, provided by input, available in the function evaluation_function.

Warning: This is a collective call that needs to be executed by all processors in the communicator.

Definition at line 490 of file mpi_remote_point_evaluation.h.

◆ get_point_ptrs()

template<int dim, int spacedim>

const std::vector< unsigned int > & Utilities::MPI::RemotePointEvaluation< dim, spacedim >::get_point_ptrs

Return a CRS-like data structure to determine the position of the result corresponding a point and the amount.

Definition at line 228 of file mpi_remote_point_evaluation.cc.

◆ is_map_unique()

template<int dim, int spacedim>

bool Utilities::MPI::RemotePointEvaluation< dim, spacedim >::is_map_unique

Return if points and cells have a one-to-one relation. This is not the case if a point is not owned by any cell (the point is outside of the domain) or if multiple cells own the point (the point is positioned on a geometric entity shared by neighboring cells).

Definition at line 237 of file mpi_remote_point_evaluation.cc.

◆ all_points_found()

template<int dim, int spacedim>

bool Utilities::MPI::RemotePointEvaluation< dim, spacedim >::all_points_found

Return if all points could be found in the domain.

Definition at line 246 of file mpi_remote_point_evaluation.cc.

◆ point_found()

template<int dim, int spacedim>

bool Utilities::MPI::RemotePointEvaluation< dim, spacedim >::point_found ( const unsigned int i ) const

Return if point i could be found in the domain.

Definition at line 255 of file mpi_remote_point_evaluation.cc.

◆ get_triangulation()

template<int dim, int spacedim>

const Triangulation< dim, spacedim > & Utilities::MPI::RemotePointEvaluation< dim, spacedim >::get_triangulation

Return the Triangulation object used during reinit().

Definition at line 270 of file mpi_remote_point_evaluation.cc.

◆ get_mapping()

template<int dim, int spacedim>

const Mapping< dim, spacedim > & Utilities::MPI::RemotePointEvaluation< dim, spacedim >::get_mapping

Return the Mapping object used during reinit().

Definition at line 279 of file mpi_remote_point_evaluation.cc.

◆ is_ready()

template<int dim, int spacedim>

bool Utilities::MPI::RemotePointEvaluation< dim, spacedim >::is_ready

Return if the internal data structures have been set up and if yes whether they are still valid (and not invalidated due to changes of the Triangulation).

Definition at line 288 of file mpi_remote_point_evaluation.cc.