Reference documentation for deal.II version GIT relicensing-16-gf4f69b3b42 2024-02-27 08:20:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
MGTwoLevelTransferNonNested< dim, LinearAlgebra::distributed::Vector< Number > >::AdditionalData Struct Reference

#include <deal.II/multigrid/mg_transfer_global_coarsening.h>

Public Member Functions

 AdditionalData (const double tolerance=1e-6, const unsigned int rtree_level=0, const bool enforce_all_points_found=true)
 

Public Attributes

double tolerance
 
unsigned int rtree_level
 
bool enforce_all_points_found
 

Detailed Description

template<int dim, typename Number>
struct MGTwoLevelTransferNonNested< dim, LinearAlgebra::distributed::Vector< Number > >::AdditionalData

AdditionalData structure that can be used to tweak parameters related to the search procedure (used internally by RemotePointEvaluation) or, in the future, transfer operators needed by the non-nested multigrid algorithm.

Definition at line 793 of file mg_transfer_global_coarsening.h.

Constructor & Destructor Documentation

◆ AdditionalData()

template<int dim, typename Number >
MGTwoLevelTransferNonNested< dim, LinearAlgebra::distributed::Vector< Number > >::AdditionalData::AdditionalData ( const double  tolerance = 1e-6,
const unsigned int  rtree_level = 0,
const bool  enforce_all_points_found = true 
)
inline

Constructor. By default, the tolerance and rtree_level parameters are set to the default values used in the constructor of RemotePointEvaluation, i.e. 1e-6 and 0, respectively. The last Boolean parameter enforce_all_points_found is true by default and checks that all points submitted internally to RemotePointEvaluation::reinit() have been found.

Definition at line 804 of file mg_transfer_global_coarsening.h.

Member Data Documentation

◆ tolerance

template<int dim, typename Number >
double MGTwoLevelTransferNonNested< dim, LinearAlgebra::distributed::Vector< Number > >::AdditionalData::tolerance

Tolerance parameter. See the constructor of RemotePointEvaluation for more details.

Definition at line 816 of file mg_transfer_global_coarsening.h.

◆ rtree_level

template<int dim, typename Number >
unsigned int MGTwoLevelTransferNonNested< dim, LinearAlgebra::distributed::Vector< Number > >::AdditionalData::rtree_level

RTree level parameter. See the constructor of RemotePointEvaluation for more details.

Definition at line 823 of file mg_transfer_global_coarsening.h.

◆ enforce_all_points_found

template<int dim, typename Number >
bool MGTwoLevelTransferNonNested< dim, LinearAlgebra::distributed::Vector< Number > >::AdditionalData::enforce_all_points_found

If set to true, it checks if RemotePointEvaluation::all_points_found() evaluates to true internally during the each call to reinit() from one level to the next one, ensuring that all submitted points have been found inside the domain.

Definition at line 832 of file mg_transfer_global_coarsening.h.


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