Module.h

Go to the documentation of this file.

////////////////////////////////////////////////////////////////////////////////
//
//  File: Module.h
//
//  For more information, please see: http://www.nektar.info/
//
//  The MIT License
//
//  Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
//  Department of Aeronautics, Imperial College London (UK), and Scientific
//  Computing and Imaging Institute, University of Utah (USA).
//
//  Permission is hereby granted, free of charge, to any person obtaining a
//  copy of this software and associated documentation files (the "Software"),
//  to deal in the Software without restriction, including without limitation
//  the rights to use, copy, modify, merge, publish, distribute, sublicense,
//  and/or sell copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included
//  in all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
//  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//  DEALINGS IN THE SOFTWARE.
//
//  Description: Field converter module base classes.
//
////////////////////////////////////////////////////////////////////////////////
 
#ifndef FIELDUTILS_MODULE
#define FIELDUTILS_MODULE
 
#include <fstream>
#include <iomanip>
#include <iostream>
#include <map>
#include <set>
#include <string>
#include <typeinfo>
#include <vector>
 
#include <FieldUtils/FieldConvertComm.hpp>
#include <LibUtilities/BasicUtils/NekFactory.hpp>
#include <LibUtilities/Communication/CommSerial.h>
#include <StdRegions/StdNodalTriExp.h>
 
#include "Field.hpp"
 
#include "FieldUtilsDeclspec.h"
 
namespace po = boost::program_options;
 
namespace Nektar::FieldUtils
{
/**
 * Denotes different types of mesh converter modules: so far only
 * input, output and process modules are defined.
 */
enum ModuleType
{
    eInputModule,
    eProcessModule,
    eOutputModule,
    SIZE_ModuleType
};
 
const std::string ModuleTypeMap[] = {"Input", "Process", "Output"};
 
enum ModulePriority
{
    eCreateGraph,
    eCreateFieldData,
    eModifyFieldData,
    eCreateExp,
    eFillExp,
    eModifyExp,
    eBndExtraction,
    eCreatePts,
    eConvertExpToPts,
    eModifyPts,
    eOutput,
    SIZE_ModulePriority
};
 
const char *const ModulePriorityMap[] = {
    "CreateGraph",     "CreateFieldData", "ModifyFieldData", "CreateExp",
    "FillExp",         "ModifyExp",       "BndExtraction",   "CreatePts",
    "ConvertExpToPts", "ModifyPts",       "Output"};
 
/**
 * @brief Swap endian ordering of the input variable.
 */
template <typename T> void swap_endian(T &u)
{
    union
    {
        T u;
        unsigned char u8[sizeof(T)];
    } source, dest;
 
    source.u = u;
 
    for (size_t k = 0; k < sizeof(T); k++)
    {
        dest.u8[k] = source.u8[sizeof(T) - k - 1];
    }
 
    u = dest.u;
}
 
template <typename T> void swap_endian(std::vector<T> &u)
{
    size_t vecSize = u.size();
    for (size_t i = 0; i < vecSize; ++i)
    {
        swap_endian(u[i]);
    }
}
 
/**
 * @brief Represents a command-line configuration option.
 */
struct ConfigOption
{
    /**
     * @brief Construct a new configuration option.
     *
     * @param isBool    True if the option is boolean type.
     * @param defValue  Default value of the option.
     * @param desc      Description of the option.
     */
    ConfigOption(bool isBool, std::string defValue, std::string desc)
        : m_isBool(isBool), m_beenSet(false), m_value(), m_defValue(defValue),
          m_desc(desc)
    {
    }
    ConfigOption()
        : m_isBool(false), m_beenSet(false), m_value(), m_defValue(), m_desc()
    {
    }
 
    /**
     * @brief Re-interpret the value stored in #value as some type using
     * boost::lexical_cast.
     */
    template <typename T> T as() const
    {
        try
        {
            return boost::lexical_cast<T>(m_value);
        }
        catch (const std::exception &e)
        {
            std::cerr << "We are not able to cast m_value " << m_value << " to "
                      << typeid(T).name() << std::endl
                      << e.what() << std::endl;
            abort();
        }
    }
 
    /// True if the configuration option is a boolean (thus does not
    /// need additional arguments).
    bool m_isBool;
    /// True if the configuration option has been set at command
    /// line. If false, the default value will be put into #value.
    bool m_beenSet;
    /// The value of the configuration option.
    std::string m_value;
    /// Default value of the configuration option.
    std::string m_defValue;
    /// Description of the configuration option.
    std::string m_desc;
};
 
typedef std::pair<ModuleType, std::string> ModuleKey;
 
/**
 * Abstract base class for mesh converter modules. Each subclass
 * implements the Process() function, which in some way alters the
 * mesh #m.
 */
class Module
{
public:
    FIELD_UTILS_EXPORT Module(FieldSharedPtr p_f) : m_f(p_f)
    {
    }
    virtual ~Module() = default;
 
    void Process(po::variables_map &vm)
    {
        v_Process(vm);
    }
 
    std::string GetModuleName()
    {
        return v_GetModuleName();
    }
 
    std::string GetModuleDescription()
    {
        return v_GetModuleDescription();
    }
 
    const ConfigOption &GetConfigOption(const std::string &key) const
    {
        auto it = m_config.find(key);
        ASSERTL0(it != m_config.end(), "Configuration key not found!");
        return it->second;
    }
 
    ModulePriority GetModulePriority()
    {
        return v_GetModulePriority();
    }
 
    std::vector<ModuleKey> GetModulePrerequisites()
    {
        return v_GetModulePrerequisites();
    }
 
    FIELD_UTILS_EXPORT void RegisterConfig(std::string key,
                                           std::string value = "");
    FIELD_UTILS_EXPORT void PrintConfig();
    FIELD_UTILS_EXPORT void SetDefaults();
    FIELD_UTILS_EXPORT void AddFile(std::string fileType, std::string fileName);
 
    FIELD_UTILS_EXPORT void EvaluateTriFieldAtEquiSpacedPts(
        LocalRegions::ExpansionSharedPtr &exp,
        const Array<OneD, const NekDouble> &infield,
        Array<OneD, NekDouble> &outfield);
 
    /// Field object
    FieldSharedPtr m_f;
 
protected:
    Module(){};
 
    virtual void v_Process([[maybe_unused]] po::variables_map &vm)
    {
        NEKERROR(ErrorUtil::efatal, "v_Process not coded");
    }
 
    virtual std::string v_GetModuleName()
    {
        NEKERROR(ErrorUtil::efatal, "v_GetModuleName not coded");
        return " ";
    }
 
    virtual std::string v_GetModuleDescription()
    {
        return " ";
    }
 
    virtual ModulePriority v_GetModulePriority()
    {
        NEKERROR(ErrorUtil::efatal, "v_GetModulePriority not coded");
        return SIZE_ModulePriority;
    }
 
    virtual std::vector<ModuleKey> v_GetModulePrerequisites()
    {
        return std::vector<ModuleKey>();
    }
 
    /// List of configuration values.
    std::map<std::string, ConfigOption> m_config;
    /// List of allowed file formats.
    std::set<std::string> m_allowedFiles;
};
 
/**
 * @brief Abstract base class for input modules.
 *
 * Input modules should read the contents of #fldFile in the Process()
 * function and populate the members of #m. Typically any given module
 * should populate Mesh::expDim, Mesh::spaceDim, Mesh::node and
 * Mesh::element, then call the protected ProcessX functions to
 * generate edges, faces, etc.
 */
class InputModule : public Module
{
public:
    InputModule(FieldSharedPtr p_m);
    FIELD_UTILS_EXPORT static std::string GuessFormat(std::string fileName);
    void PrintSummary();
};
 
typedef std::shared_ptr<InputModule> InputModuleSharedPtr;
 
/**
 * @brief Abstract base class for processing modules.
 *
 */
class ProcessModule : public Module
{
public:
    ProcessModule(){};
    ProcessModule(FieldSharedPtr p_f) : Module(p_f)
    {
    }
};
 
/**
 * @brief Abstract base class for output modules.
 *
 * Output modules take the mesh #m and write to the file specified by
 * the stream.
 */
class OutputModule : public Module
{
public:
    OutputModule(FieldSharedPtr p_f);
    FIELD_UTILS_EXPORT void OpenStream();
 
protected:
    /// Output stream
    std::ofstream m_fldFile;
};
 
FIELD_UTILS_EXPORT std::ostream &operator<<(std::ostream &os,
                                            const ModuleKey &rhs);
 
typedef std::shared_ptr<Module> ModuleSharedPtr;
typedef LibUtilities::NekFactory<ModuleKey, Module, FieldSharedPtr>
    ModuleFactory;
 
FIELD_UTILS_EXPORT ModuleFactory &GetModuleFactory();
 
} // namespace Nektar::FieldUtils
 
#endif