UserErrorChecking.h

Go to the documentation of this file.

/********************************************************************/
/*                  SOFTWARE COPYRIGHT NOTIFICATION                 */
/*                             Cardinal                             */
/*                                                                  */
/*                  (c) 2021 UChicago Argonne, LLC                  */
/*                        ALL RIGHTS RESERVED                       */
/*                                                                  */
/*                 Prepared by UChicago Argonne, LLC                */
/*               Under Contract No. DE-AC02-06CH11357               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*             Prepared by Battelle Energy Alliance, LLC            */
/*               Under Contract No. DE-AC07-05ID14517               */
/*                With the U. S. Department of Energy               */
/*                                                                  */
/*                 See LICENSE for full restrictions                */
/********************************************************************/

#pragma once

#include "InputParameters.h"

void checkUnusedParam(const InputParameters & p,
                      const std::vector<std::string> & names,
                      const std::string & explanation,
                      const bool error = false);

void checkUnusedParam(const InputParameters & p,
                      const std::string & name,
                      const std::string & explanation,
                      const bool error = false);

void checkRequiredParam(const InputParameters & p,
                        const std::vector<std::string> & names,
                        const std::string & explanation);

void checkRequiredParam(const InputParameters & p,
                        const std::string & name,
                        const std::string & explanation);

void checkJointParams(const InputParameters & p,
                      const std::vector<std::string> & name,
                      const std::string & explanation);

void catchOpenMCError(const int & err, const std::string descriptor);