A class to report elements collected by the solver. More...

#include <SolutionCheckHelpers.hpp>

Public Types
using	ElementCount = ElementsReporterCollector::ElementCount
	Type alias for elements count (e.g., localIndex, globalIndex).

Public Member Functions
	ElementsReporterOutput (ElementsReporterBuffer const &buffer)
	Construct a preallocated buffer for collecting element ids in kernels. More...

ElementCount	getRanksSignaledIdsCount () const

ElementCount	getRanksCollectedIdsCount () const

void	outputTooLowValues (string_view linesPrefix, string_view valueNaming, real64 minValue, units::Unit valueUnit) const
	Report elements with values below a specified threshold in the log: Outputs lines indicating which variables have collected element ids whose corresponding solution components are too low, potentially signaling underflow or numerical instability. More...

Detailed Description

A class to report elements collected by the solver.

Definition at line 32 of file SolutionCheckHelpers.hpp.

Constructor & Destructor Documentation

◆ ElementsReporterOutput()

geos::ElementsReporterOutput::ElementsReporterOutput ( ElementsReporterBuffer const & buffer )

Construct a preallocated buffer for collecting element ids in kernels.

Parameters

buffer The buffer that will be utilized for counting & collecting elements IDs during kernel execution.

Member Function Documentation

◆ getRanksCollectedIdsCount()

ElementCount geos::ElementsReporterOutput::getRanksCollectedIdsCount ( ) const

inline

Returns: The total count of collected elements across all ranks for signaling ids.

Definition at line 54 of file SolutionCheckHelpers.hpp.

◆ getRanksSignaledIdsCount()

ElementCount geos::ElementsReporterOutput::getRanksSignaledIdsCount ( ) const

inline

Returns: The number of ranks that have signaled an id.

Definition at line 48 of file SolutionCheckHelpers.hpp.

◆ outputTooLowValues()

void geos::ElementsReporterOutput::outputTooLowValues	(	string_view	linesPrefix,
		string_view	valueNaming,
		real64	minValue,
		units::Unit	valueUnit
	)		const

Report elements with values below a specified threshold in the log: Outputs lines indicating which variables have collected element ids whose corresponding solution components are too low, potentially signaling underflow or numerical instability.