OptimalTransportPlanSpace::MapApproximationStrategy< spacedim > Class Template Reference

Abstract base class for map approximation strategies. More...

#include <OptimalTransportPlan.h>

Inheritance diagram for OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >:

Public Member Functions
virtual	~MapApproximationStrategy ()=default
virtual void	compute_map (const std::function< double(const Point< spacedim > &, const Point< spacedim > &)> distance_function, const std::vector< Point< spacedim > > &source_points, const std::vector< double > &source_density, const std::vector< Point< spacedim > > &target_points, const std::vector< double > &target_density, const Vector< double > &potential, const double regularization_param, const double truncation_radius)=0
	Computes the transport map.
virtual void	save_results (const std::string &output_dir) const =0
	Saves the results to a file.

Protected Attributes
std::vector< Point< spacedim > >	source_points
	The source points.
std::vector< Point< spacedim > >	mapped_points
	The mapped points.
std::vector< double >	transport_density
	The transported density.

Detailed Description

template<int spacedim>
class OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >

Abstract base class for map approximation strategies.

Template Parameters

spacedim

The dimension of the space the mesh is embedded in.

Definition at line 148 of file OptimalTransportPlan.h.

Constructor & Destructor Documentation

~MapApproximationStrategy()

template<int spacedim>

virtual OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >::~MapApproximationStrategy ( )

virtualdefault

Member Function Documentation

compute_map()

template<int spacedim>

virtual void OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >::compute_map ( const std::function< double(const Point< spacedim > &, const Point< spacedim > &)>  distance_function, const std::vector< Point< spacedim > > &  source_points, const std::vector< double > &  source_density, const std::vector< Point< spacedim > > &  target_points, const std::vector< double > &  target_density, const Vector< double > &  potential, const double  regularization_param, const double  truncation_radius  )

pure virtual

Computes the transport map.

Parameters

distance_function	The distance function.
source_points	The source points.
source_density	The source density.
target_points	The target points.
target_density	The target density.
potential	The optimal transport potential.
regularization_param	The regularization parameter.
truncation_radius	The truncation radius.

Implemented in OptimalTransportPlanSpace::ModalStrategy< spacedim >, and OptimalTransportPlanSpace::BarycentricStrategy< spacedim >.

save_results()

template<int spacedim>

virtual void OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >::save_results ( const std::string &  output_dir ) const

pure virtual

Saves the results to a file.

Parameters

output_dir

The directory to save the results to.

Implemented in OptimalTransportPlanSpace::ModalStrategy< spacedim >, and OptimalTransportPlanSpace::BarycentricStrategy< spacedim >.

Member Data Documentation

source_points

template<int spacedim>

std::vector<Point<spacedim> > OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >::source_points

protected

The source points.

Definition at line 180 of file OptimalTransportPlan.h.

mapped_points

template<int spacedim>

std::vector<Point<spacedim> > OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >::mapped_points

protected

The mapped points.

Definition at line 181 of file OptimalTransportPlan.h.

transport_density

template<int spacedim>

std::vector<double> OptimalTransportPlanSpace::MapApproximationStrategy< spacedim >::transport_density

protected

The transported density.

Definition at line 182 of file OptimalTransportPlan.h.

---

The documentation for this class was generated from the following file:

• include/SemiDiscreteOT/core/OptimalTransportPlan.h