Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::IVerifierService Class Referenceabstract

Interface of the data verification service between two executions. More...

#include <arcane/core/IVerifierService.h>

Public Types

enum class  eCompareMode { Values , HashOnly }
 Comparison mode. More...

Public Member Functions

virtual ~IVerifierService ()=default
 Frees resources.
virtual void writeReferenceFile ()=0
 Writes the reference file.
virtual void doVerifFromReferenceFile (bool parallel_sequential, bool compare_ghost)=0
 Performs the verification from the reference file.
virtual void setFileName (const String &file_name)=0
 Sets the name of the file containing the reference values.
virtual String fileName () const =0
 Name of the file containing the reference values.
virtual void setResultFileName (const String &file_name)=0
 Name of the file containing the results.
virtual String resultfileName () const =0
virtual void setCompareMode (eCompareMode v)=0
 Desired comparison type.
virtual eCompareMode compareMode () const =0
virtual void setSubDir (const String &sub_dir)=0
 Sets the name of the subdirectory containing the reference values.
virtual String subDir () const =0
 Name of the file containing the reference values.
virtual void setComputeDifferenceMethod (eVariableComparerComputeDifferenceMethod v)=0
 Method to use for calculating the difference between two values.
virtual eVariableComparerComputeDifferenceMethod computeDifferenceMethod () const =0

Detailed Description

Interface of the data verification service between two executions.

Definition at line 33 of file IVerifierService.h.

Member Enumeration Documentation

◆ eCompareMode

Comparison mode.

Enumerator
Values 

Compare all values.

HashOnly 

Compares only the hashes of the values.

This mode only allows detecting if two values are different without knowing this difference. However, it is faster than the Values mode and allows limiting the size of the comparison files.

Definition at line 40 of file IVerifierService.h.

Member Function Documentation

◆ doVerifFromReferenceFile()

virtual void Arcane::IVerifierService::doVerifFromReferenceFile ( bool parallel_sequential,
bool compare_ghost )
pure virtual

Performs the verification from the reference file.

Parameters
parallel_sequentialif true, indicates that the result of a parallel execution is compared with that of a sequential execution. This option is inactive if the execution is sequential.
compare_ghostif true, indicates that the results are also compared on ghost entities. It is generally normal for the results to be different on ghost entities, because it is not necessary that all variables are synchronized. This is why it is better generally not to perform verification on ghost entities. This option is inactive if the execution is sequential.

◆ fileName()

virtual String Arcane::IVerifierService::fileName ( ) const
pure virtual

Name of the file containing the reference values.

Implemented in Arcane::VerifierService.

◆ setCompareMode()

virtual void Arcane::IVerifierService::setCompareMode ( eCompareMode v)
pure virtual

Desired comparison type.

Implemented in Arcane::VerifierService.

◆ setComputeDifferenceMethod()

virtual void Arcane::IVerifierService::setComputeDifferenceMethod ( eVariableComparerComputeDifferenceMethod v)
pure virtual

Method to use for calculating the difference between two values.

Implemented in Arcane::VerifierService.

◆ setFileName()

virtual void Arcane::IVerifierService::setFileName ( const String & file_name)
pure virtual

Sets the name of the file containing the reference values.

Implemented in Arcane::VerifierService.

◆ setResultFileName()

virtual void Arcane::IVerifierService::setResultFileName ( const String & file_name)
pure virtual

Name of the file containing the results.

Implemented in Arcane::VerifierService.

◆ setSubDir()

virtual void Arcane::IVerifierService::setSubDir ( const String & sub_dir)
pure virtual

Sets the name of the subdirectory containing the reference values.

Implemented in Arcane::VerifierService.

◆ subDir()

virtual String Arcane::IVerifierService::subDir ( ) const
pure virtual

Name of the file containing the reference values.

Implemented in Arcane::VerifierService.


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