ArcaneCeaVerifierModule.cc

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ArcaneVerifierModule.cc                                     (C) 2000-2026 */
/*                                                                           */
/* Verification module.                                                      */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/PlatformUtils.h"
#include "arcane/utils/ScopedPtr.h"
 
#include "arcane/core/EntryPoint.h"
#include "arcane/core/ISubDomain.h"
#include "arcane/core/ModuleFactory.h"
#include "arcane/core/IVerifierService.h"
#include "arcane/core/ServiceUtils.h"
#include "arcane/core/IVariableMng.h"
#include "arcane/core/IParallelMng.h"
#include "arcane/core/IMesh.h"
#include "arcane/core/IItemFamily.h"
#include "arcane/core/ITimeLoopMng.h"
#include "arcane/core/ServiceBuilder.h"
#include "arcane/core/ObserverPool.h"
#include "arcane/core/ICheckpointMng.h"
#include "arcane/core/MeshVisitor.h"
#include "arcane/core/IDirectory.h"
 
#include "arcane/std/ArcaneCeaVerifier_axl.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
class ArcaneVerifierModule
: public ArcaneArcaneCeaVerifierObject
{
 public:
 
  explicit ArcaneVerifierModule(const ModuleBuildInfo& mb);
 
 public:
 
  VersionInfo versionInfo() const override { return VersionInfo(0, 0, 1); }
 
 public:
 
  void onExit() override;
  void onInit() override;
 
 private:
 
  ObserverPool m_observers;
 
 private:
 
  void _checkSortedGroups();
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ArcaneVerifierModule::
ArcaneVerifierModule(const ModuleBuildInfo& mb)
: ArcaneArcaneCeaVerifierObject(mb)
{
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void ArcaneVerifierModule::
onInit()
{
  if (options()->trace.size() != 0)
    this->pwarning() << "The option 'trace' is no longer used and should be removed";
 
  if (!platform::getEnvironmentVariable("ARCANE_VERIFY_SORTEDGROUP").null()) {
    info() << "Add observer to check sorted groups before checkpoint";
    // Adds an observer signaling unsorted groups.
    m_observers.addObserver(this,
                            &ArcaneVerifierModule::_checkSortedGroups,
                            subDomain()->checkpointMng()->writeObservable());
  }
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void ArcaneVerifierModule::
_checkSortedGroups()
{
  // Displays the list of unsorted groups.
  Integer nb_sorted_group = 0;
  Integer nb_group = 0;
  auto check_sorted_func = [&](ItemGroup& g) {
    ++nb_group;
    if (g.checkIsSorted())
      ++nb_sorted_group;
    else
      info() << "VerifierModule: group not sorted name=" << g.name();
  };
  meshvisitor::visitGroups(this->mesh(), check_sorted_func);
  info() << "VerifierModule: nb_unsorted_group=" << (nb_group - nb_sorted_group)
         << "/" << nb_group;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void ArcaneVerifierModule::
onExit()
{
  if (!options()->verify())
    return;
  if (!platform::getEnvironmentVariable("ARCANE_NO_VERIFY").null())
    return;
 
  IParallelMng* pm = subDomain()->parallelMng();
  bool is_parallel = pm->isParallel();
 
  Ref<IVerifierService> verifier_service;
 
  {
    ServiceBuilder<IVerifierService> sf(subDomain());
 
    String verifier_service_name = options()->verifierServiceName();
    // Allows an environment variable for overriding the service for testing
    String env_service_name = platform::getEnvironmentVariable("ARCANE_VERIFIER_SERVICE");
    if (!env_service_name.null())
      verifier_service_name = env_service_name;
    info() << "Verification Module using service=" << verifier_service_name;
    verifier_service = sf.createReference(verifier_service_name);
  }
 
  bool compare_from_sequential = options()->compareParallelSequential();
  if (!is_parallel)
    compare_from_sequential = false;
 
  String result_file_name = options()->resultFile();
  String reference_file_name = options()->referenceFile();
 
  if (options()->filesInOutputDir()) {
    if (result_file_name.empty()) {
      result_file_name = subDomain()->exportDirectory().file("compare.xml");
    }
    else {
      result_file_name = subDomain()->exportDirectory().file(result_file_name);
    }
 
    if (reference_file_name.empty()) {
      reference_file_name = subDomain()->exportDirectory().file("check");
    }
    else {
      reference_file_name = subDomain()->exportDirectory().file(reference_file_name);
    }
  }
  else {
    if (result_file_name.empty()) {
      result_file_name = "compare.xml";
    }
 
    if (reference_file_name.empty()) {
      reference_file_name = "check";
    }
  }
 
  verifier_service->setResultFileName(result_file_name);
 
  info() << "Verification check is_parallel?=" << is_parallel << " compare_from_sequential?=" << compare_from_sequential;
  verifier_service->setFileName(reference_file_name);
 
  if (options()->generate()) {
    info() << "Writing check file '" << reference_file_name << "'";
    verifier_service->writeReferenceFile();
  }
  else {
    info() << "Comparing reference file '" << reference_file_name << "'";
    verifier_service->doVerifFromReferenceFile(compare_from_sequential, false);
  }
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ARCANE_REGISTER_MODULE_ARCANECEAVERIFIER(ArcaneVerifierModule);
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/