The whole predicted ladder: what predictPressureLadder returns and what peclet.amr.predict_hierarchy hands to Python as a dict. More...

#include <mg_predict.hpp>

Public Member Functions
bool	hasStage () const
	Whether any stage fires — compare against `DistributedFlowMultigrid::hasStage()`.

std::size_t	numInPlace () const
	The levels ABOVE the first stage (kinds `Octree` and `Lifted`); compare against `DistributedFlowMultigrid::numInPlaceLevels()`.

std::string	bottomName () const
	`"jacobi"` / `"amg"`, suffixed by every stage innermost first (§6.7's spelling: `"+tail"`, `"+sibling"`, `"+repartition"`) — what `DistributedFlowMultigrid::bottomName` reports.

Public Attributes
std::vector< MgLevelPrediction< Dim > >	levels
	Finest first; each stage's levels appended after the ladder it continues.

std::vector< MgLevelKind >	stages
	The stages met on the way down, outermost first (`Tail`, `Sibling`, `Repartition`).

bool	tail = false
	a replicated tail engages (at any depth)

IVec< Dim >	tailFrom {}
	the grid the (first) stage moves

MgBottomKind	bottom = MgBottomKind::Jacobi
	what solves the coarsest level under `auto`

Detailed Description

template<int Dim>
struct peclet::amr::MgLadderPrediction< Dim >

The whole predicted ladder: what predictPressureLadder returns and what peclet.amr.predict_hierarchy hands to Python as a dict.

The built ladder is compared against it level by level (AmrFlow::pressureMgLevels, DistributedFlowMultigrid).

Definition at line 122 of file mg_predict.hpp.

Member Function Documentation

◆ hasStage()

template<int Dim>

bool peclet::amr::MgLadderPrediction< Dim >::hasStage ( ) const

inline

Whether any stage fires — compare against DistributedFlowMultigrid::hasStage().

Definition at line 134 of file mg_predict.hpp.

References peclet::amr::MgLadderPrediction< Dim >::stages.

◆ numInPlace()

template<int Dim>

std::size_t peclet::amr::MgLadderPrediction< Dim >::numInPlace ( ) const

inline

The levels ABOVE the first stage (kinds Octree and Lifted); compare against DistributedFlowMultigrid::numInPlaceLevels().

Definition at line 137 of file mg_predict.hpp.

References peclet::amr::MgLadderPrediction< Dim >::levels, peclet::amr::Lifted, and peclet::amr::Octree.

◆ bottomName()

template<int Dim>

std::string peclet::amr::MgLadderPrediction< Dim >::bottomName ( ) const

inline

"jacobi" / "amg", suffixed by every stage innermost first (§6.7's spelling: "+tail", "+sibling", "+repartition") — what DistributedFlowMultigrid::bottomName reports.

Definition at line 147 of file mg_predict.hpp.

References peclet::amr::MgLadderPrediction< Dim >::bottom, peclet::amr::MgLadderPrediction< Dim >::stages, peclet::amr::toString(), and peclet::amr::transferFieldGradients().

Member Data Documentation

◆ levels

template<int Dim>

std::vector<MgLevelPrediction<Dim> > peclet::amr::MgLadderPrediction< Dim >::levels

Finest first; each stage's levels appended after the ladder it continues.

A stage's first level is the SAME grid as the last level above it (moved, not coarsened), as AmrFlow::pressureMgLevels also lists it; its kind is the stage's.

Definition at line 126 of file mg_predict.hpp.

Referenced by peclet::amr::MgLadderPrediction< Dim >::numInPlace().