NEM::DRV::AutoVerificationDriver Class Reference

This class drives the automatic verification (AV) in Nemosys. More...

Detailed Description

Three successively refined meshes of a given geometry are required to evaluate whether the coarsest mesh is within the asymptotic range. The grid convergence index (GCI) of each component of each selected field is evaluated: if they are all approximately equal to 1 then the coarse mesh is sufficiently refined for an accurate solution (and is within asymptotic range).

Definition at line 48 of file AutoVerificationDriver.H.

Classes
struct	Files
struct	Opts

Public Member Functions
	AutoVerificationDriver (Files files, Opts opts)
const Files &	getFiles () const
void	setFiles (Files files)
const Opts &	getOpts () const
void	setOpts (Opts opts)
void	execute () const override
	Run the workflow represented by the driver. More...

Static Public Member Functions
static std::unique_ptr< NemDriver >	readJSON (const jsoncons::json &inputjson)
	Factory method for all drivers. More...

Private Member Functions
	AutoVerificationDriver ()
jsoncons::string_view	getProgramType () const override

Private Attributes
Files	files_
Opts	opts_

Static Private Attributes
static constexpr const char *	programType = "Verification"

Inherits NEM::DRV::NemDriver.

Constructor & Destructor Documentation

AutoVerificationDriver() [1/2]

NEM::DRV::AutoVerificationDriver::AutoVerificationDriver	(	Files	files,
		Opts	opts
	)

Definition at line 51 of file AutoVerificationDriver.C.

    : files_(std::move(files)), opts_(std::move(opts)) {}

AutoVerificationDriver() [2/2]

NEM::DRV::AutoVerificationDriver::AutoVerificationDriver ( )

private

Definition at line 54 of file AutoVerificationDriver.C.

    : AutoVerificationDriver({{}, {}, {}}, Opts{{}}) {}

Member Function Documentation

execute()

void NEM::DRV::AutoVerificationDriver::execute ( ) const

overridevirtual

Implements NEM::DRV::NemDriver.

Definition at line 77 of file AutoVerificationDriver.C.

References NEM::DRV::AutoVerificationDriver::Opts::arrayIds, NEM::DRV::AutoVerificationDriver::Files::coarseMeshFile, meshBase::CreateShared(), files_, NEM::DRV::AutoVerificationDriver::Files::fineMeshFile, NEM::DRV::AutoVerificationDriver::Files::finerMeshFile, NEM::DRV::AutoVerificationDriver::Opts::numThreads, opts_, NEM::DRV::AutoVerificationDriver::Opts::targetGCI, and NEM::DRV::AutoVerificationDriver::Opts::transferType.

                                           {
  auto coarseMesh = meshBase::CreateShared(this->files_.coarseMeshFile);
  auto fineMesh = meshBase::CreateShared(this->files_.fineMeshFile);
  auto finerMesh = meshBase::CreateShared(this->files_.finerMeshFile);
#ifdef HAVE_OPENMP
  auto threads = this->opts_.numThreads.value_or(omp_get_max_threads());
  omp_set_num_threads(threads);
  std::cout << "Number of threads set to : " << threads << std::endl;
#else
  if (this->opts_.numThreads) {
    std::cerr << "OpenMP is not enabled. Verification will continue in serial."
              << std::endl;
  }
#endif
  std::cout << "Running verification." << std::endl;
  auto oac = std::make_shared<OrderOfAccuracy>(
      coarseMesh.get(), fineMesh.get(), finerMesh.get(), this->opts_.arrayIds,
      this->opts_.transferType, this->opts_.targetGCI);
  std::cout << "Checking if in asymptotic range." << std::endl;
  std::cout << "Target GCI is set to : " << oac->getTargetGCI() << std::endl;
  auto asymp = oac->checkAsymptoticRange();
  bool inRange = true;
  for (int i = 0; i < asymp.size(); ++i) {
    for (int j = 0; j < asymp[0].size(); ++j) {
      double gci = asymp[i][j];
      if (gci > oac->getTargetGCI()) {
        std::cout << "GCI of " << gci;
        std::cout << " exceeds target GCI of " << oac->getTargetGCI()
                  << std::endl;
        std::cout << "at array " << i << ", component " << j << std::endl;
        inRange = false;
      }
    }
  }
  if (inRange) {
    std::cout << "Grid is in target asymptotic range." << std::endl;
  } else {
    std::cout << "Grid is not in target asymptotic range." << std::endl;
  }
}

getFiles()

const AutoVerificationDriver::Files & NEM::DRV::AutoVerificationDriver::getFiles

(

)

const

Definition at line 57 of file AutoVerificationDriver.C.

References files_.

                                                                          {
  return files_;
}

getOpts()

const AutoVerificationDriver::Opts & NEM::DRV::AutoVerificationDriver::getOpts

(

)

const

Definition at line 65 of file AutoVerificationDriver.C.

References opts_.

                                                                        {
  return opts_;
}

getProgramType()

jsoncons::string_view NEM::DRV::AutoVerificationDriver::getProgramType ( ) const

overrideprivatevirtual

Implements NEM::DRV::NemDriver.

Definition at line 73 of file AutoVerificationDriver.C.

References programType.

                                                                 {
  return programType;
}

readJSON()

std::unique_ptr< NemDriver > NEM::DRV::NemDriver::readJSON ( const jsoncons::json &  inputjson )

staticinherited

Parameters

inputjson

json input with "Program Type" key

Returns

pointer to base NemDriver class

Definition at line 37 of file NemDriver.C.

Referenced by NEM::DRV::MeshGenDriver::MeshGenDriver().

                                                                          {
  return inputjson.as<std::unique_ptr<NemDriver>>();
}

setFiles()

void NEM::DRV::AutoVerificationDriver::setFiles

(

Files

files

)

Definition at line 61 of file AutoVerificationDriver.C.

References files_.

                                                 {
  this->files_ = std::move(files);
}

setOpts()

void NEM::DRV::AutoVerificationDriver::setOpts

(

Opts

opts

)

Definition at line 69 of file AutoVerificationDriver.C.

References opts_.

                                              {
  this->opts_ = std::move(opts);
}

Member Data Documentation

files_

Files NEM::DRV::AutoVerificationDriver::files_

private

Definition at line 115 of file AutoVerificationDriver.H.

Referenced by execute(), getFiles(), and setFiles().

opts_

Opts NEM::DRV::AutoVerificationDriver::opts_

private

Definition at line 116 of file AutoVerificationDriver.H.

Referenced by execute(), getOpts(), and setOpts().

programType

constexpr const char* NEM::DRV::AutoVerificationDriver::programType = "Verification"

staticprivate

Definition at line 112 of file AutoVerificationDriver.H.

Referenced by getProgramType().

---

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

• AutoVerificationDriver.H
• AutoVerificationDriver.C