check_input_file.hpp

Go to the documentation of this file.

#ifndef CHECK_INPUT_FILE_HPP
#define CHECK_INPUT_FILE_HPP

#include "NamelistReader.hpp"
#include "globals.hpp"

struct CheckerEntry{
    std::string name;
    std::string msg;

    CheckerEntry(std::string name, std::string msg) : name(name), msg(msg) {}
};

class InputChecker{
    NLReader::NamelistReader* nlr;
    std::vector<CheckerEntry> deprecated;
    std::vector<CheckerEntry> removed;
    bool found_deprecated;
    bool found_removed;

    public:

    InputChecker(NLReader::NamelistReader& nlr) : nlr(&nlr), found_deprecated(false), found_removed(false) {
        // Include a file that contains all the deprecated and removed inputs
        #include "deprecated_and_removed_inputs.hpp"
        announce_all();
    }

    void deprecate(std::string list, std::string name, std::string msg){
        if(nlr->namelist_present(list)){
            nlr->use_namelist(list);
            if(nlr->present(name)){
                deprecated.push_back(CheckerEntry(name, msg));
                found_deprecated = true;
            }
        }
    }

    void remove(std::string list, std::string name, std::string msg){
        if(nlr->namelist_present(list)){
            nlr->use_namelist(list);
            if(nlr->present(name)){
                removed.push_back(CheckerEntry(name, msg));
                found_removed = true;
            }
        }
    }

    void announce_all(){
        if(is_rank_zero()){
            if(found_deprecated){
                printf("\n\n\n******** WARNING: Deprecated input detected *********\n");
                for(int i=0; i<deprecated.size(); i++){
                    printf("\n  Input parameter: %s", deprecated[i].name.c_str());
                    printf("\n     Suggestion: %s\n", deprecated[i].msg.c_str());
                }
            }

            if(found_removed){
                printf("\n\n\n******** ERROR: Removed input detected *********\n");
                for(int i=0; i<removed.size(); i++){
                    printf("\n  Input parameter: %s", removed[i].name.c_str());
                    printf("\n     Suggestion: %s\n", removed[i].msg.c_str());
                }
            }

            if(!nlr->namelist_present("diff_param")){
                printf("\n\n\n******** ERROR: Missing namelist detected *********\n");
                printf("\n  Add diff_param to input file\n");
            }

            if (found_deprecated || found_removed){
                printf("\nIf this input file is in an official example, please let the XGC team know so we can update the example.\n");
                printf("\n****************************************************\n\n");
            }
        }

        if(found_removed){
            exit_XGC("\nExiting XGC\n");
        }
    }
};

/* Checks input file for deprecated or removed inputs. Provide a specific instruction to the user!
 * */
inline void check_input_file(NLReader::NamelistReader& nlr){
    InputChecker ic(nlr);
}

#endif