Nektar::FieldUtils::OutputInfo Class Reference

#include <OutputInfo.h>

Inheritance diagram for Nektar::FieldUtils::OutputInfo:

Public Member Functions
	OutputInfo (FieldSharedPtr f)
	~OutputInfo () override
Public Member Functions inherited from Nektar::FieldUtils::OutputModule
	OutputModule (FieldSharedPtr p_f)
FIELD_UTILS_EXPORT void	OpenStream ()
	Open a file for output. More...
Public Member Functions inherited from Nektar::FieldUtils::Module
FIELD_UTILS_EXPORT	Module (FieldSharedPtr p_f)
virtual	~Module ()=default
void	Process (po::variables_map &vm)
std::string	GetModuleName ()
std::string	GetModuleDescription ()
const ConfigOption &	GetConfigOption (const std::string &key) const
ModulePriority	GetModulePriority ()
std::vector< ModuleKey >	GetModulePrerequisites ()
FIELD_UTILS_EXPORT void	RegisterConfig (std::string key, std::string value="")
	Register a configuration option with a module. More...
FIELD_UTILS_EXPORT void	PrintConfig ()
	Print out all configuration options for a module. More...
FIELD_UTILS_EXPORT void	SetDefaults ()
	Sets default configuration options for those which have not been set. More...
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)

Static Public Member Functions
static std::shared_ptr< Module >	create (FieldSharedPtr f)
	Creates an instance of this class. More...

Static Public Attributes
static ModuleKey	m_className

Protected Member Functions
void	v_Process (po::variables_map &vm) override
	Write fld to output file. More...
std::string	v_GetModuleName () override
std::string	v_GetModuleDescription () override
ModulePriority	v_GetModulePriority () override
Protected Member Functions inherited from Nektar::FieldUtils::Module
	Module ()
virtual void	v_Process (po::variables_map &vm)
virtual std::string	v_GetModuleName ()
virtual std::string	v_GetModuleDescription ()
virtual ModulePriority	v_GetModulePriority ()
virtual std::vector< ModuleKey >	v_GetModulePrerequisites ()

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
Protected Attributes inherited from Nektar::FieldUtils::OutputModule
std::ofstream	m_fldFile
	Output stream. More...
Protected Attributes inherited from Nektar::FieldUtils::Module
std::map< std::string, ConfigOption >	m_config
	List of configuration values. More...
std::set< std::string >	m_allowedFiles
	List of allowed file formats. More...

Detailed Description

Definition at line 44 of file OutputInfo.h.

Constructor & Destructor Documentation

OutputInfo()

Nektar::FieldUtils::OutputInfo::OutputInfo

(

FieldSharedPtr

f

)

Definition at line 53 of file OutputInfo.cpp.

                                       : OutputModule(f)
{
    m_config["nparts"] =
        ConfigOption(false, "NotSet",
                     "Number of partitions over which to create the info file");
}

References Nektar::FieldUtils::Module::m_config.

~OutputInfo()

Nektar::FieldUtils::OutputInfo::~OutputInfo ( )

override

Definition at line 60 of file OutputInfo.cpp.

{
}

Member Function Documentation

create()

static std::shared_ptr< Module > Nektar::FieldUtils::OutputInfo::create ( FieldSharedPtr  f )

inlinestatic

Creates an instance of this class.

Definition at line 48 of file OutputInfo.h.

    {
        return MemoryManager<OutputInfo>::AllocateSharedPtr(f);
    }

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

v_GetModuleDescription()

std::string Nektar::FieldUtils::OutputInfo::v_GetModuleDescription ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 66 of file OutputInfo.h.

    {
        return "Writing Info file";
    }

v_GetModuleName()

std::string Nektar::FieldUtils::OutputInfo::v_GetModuleName ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 61 of file OutputInfo.h.

    {
        return "OutputInfo";
    }

v_GetModulePriority()

ModulePriority Nektar::FieldUtils::OutputInfo::v_GetModulePriority ( )

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 71 of file OutputInfo.h.

    {
        return eOutput;
    }

References Nektar::FieldUtils::eOutput.

v_Process()

void Nektar::FieldUtils::OutputInfo::v_Process ( po::variables_map &  vm )

overrideprotectedvirtual

Write fld to output file.

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 64 of file OutputInfo.cpp.

{
    // Extract the output filename and extension
    string filename = m_config["outfile"].as<string>();
 
    // partition mesh
    ASSERTL0(m_config["nparts"].as<string>().compare("NotSet") != 0,
             "Need to specify nparts for info output");
    int nparts = m_config["nparts"].as<int>();
 
    // Input/output file
    LibUtilities::CommSharedPtr c = m_f->m_comm;
    std::shared_ptr<LibUtilities::FieldIOXml> fldXml =
        std::static_pointer_cast<LibUtilities::FieldIOXml>(
            LibUtilities::GetFieldIOFactory().CreateInstance("Xml", c, true));
 
    // open file and setup meta data.
    fs::path pinfilename(filename);
    std::vector<std::string> filenames;
    std::vector<std::vector<unsigned int>> ElementIDs;
 
    for (int p = 0; p < nparts; ++p)
    {
        boost::format pad("P%1$07d.%2$s");
        pad % p % "fld";
        std::string s = pad.str();
 
        fs::path fullpath = pinfilename / s;
        string fname      = LibUtilities::PortablePath(fullpath);
        if (!fs::exists(fname))
        {
            continue;
        }
        LibUtilities::DataSourceSharedPtr dataSource =
            LibUtilities::XmlDataSource::create(fname);
 
        std::vector<LibUtilities::FieldDefinitionsSharedPtr> fielddefs;
        std::vector<unsigned int> PartElmtIDs;
 
        // read in header of partition if it exists
        fldXml->ImportFieldDefs(dataSource, fielddefs, false);
 
        // create ElmenetIDs list then use
        for (int i = 0; i < fielddefs.size(); ++i)
        {
            for (int j = 0; j < fielddefs[i]->m_elementIDs.size(); ++j)
            {
                PartElmtIDs.push_back(fielddefs[i]->m_elementIDs[j]);
            }
        }
 
        ElementIDs.push_back(PartElmtIDs);
        filenames.push_back(s);
    }
 
    // Write the Info.xml file
    string infofile =
        LibUtilities::PortablePath(pinfilename / fs::path("Info.xml"));
 
    fldXml->WriteMultiFldFileIDs(infofile, filenames, ElementIDs);
}

References ASSERTL0, Nektar::LibUtilities::XmlDataSource::create(), CellMLToNektar.pycml::format, Nektar::LibUtilities::GetFieldIOFactory(), Nektar::FieldUtils::Module::m_config, Nektar::FieldUtils::Module::m_f, CellMLToNektar.cellml_metadata::p, and Nektar::LibUtilities::PortablePath().

Member Data Documentation

m_className

ModuleKey Nektar::FieldUtils::OutputInfo::m_className

static

Initial value:

= GetModuleFactory().RegisterCreatorFunction(
    ModuleKey(eOutputModule, "info"), OutputInfo::create,
    "Writes an Info file.")

Definition at line 52 of file OutputInfo.h.