Nektar::FieldUtils::OutputFld Class Reference

Output to fld format. More...

#include <OutputFld.h>

Inheritance diagram for Nektar::FieldUtils::OutputFld:

Public Member Functions
	OutputFld (FieldSharedPtr f)
	~OutputFld () override
Public Member Functions inherited from Nektar::FieldUtils::OutputFileBase
	OutputFileBase (FieldSharedPtr f)
	~OutputFileBase () 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
std::string	v_GetModuleName () override
void	v_OutputFromPts (po::variables_map &vm) override
	Write from pts to output file. More...
void	v_OutputFromExp (po::variables_map &vm) override
	Write from m_exp to output file. More...
void	v_OutputFromData (po::variables_map &vm) override
	Write from data to output file. More...
fs::path	v_GetPath (std::string &filename, po::variables_map &vm) override
fs::path	v_GetFullOutName (std::string &filename, po::variables_map &vm) override
Protected Member Functions inherited from Nektar::FieldUtils::OutputFileBase
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
virtual void	v_OutputFromPts (po::variables_map &vm)=0
	Write from pts to output file. More...
virtual void	v_OutputFromExp (po::variables_map &vm)=0
	Write from m_exp to output file. More...
virtual void	v_OutputFromData (po::variables_map &vm)=0
	Write from data to output file. More...
virtual fs::path	v_GetPath (std::string &filename, po::variables_map &vm)
fs::path	GetPath (std::string &filename, po::variables_map &vm)
virtual fs::path	v_GetFullOutName (std::string &filename, po::variables_map &vm)
fs::path	GetFullOutName (std::string &filename, po::variables_map &vm)
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 ()

Private Member Functions
std::string	GetIOFormat ()

Additional Inherited Members
Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr	m_f
	Field object. More...
Protected Attributes inherited from Nektar::FieldUtils::OutputFileBase
bool	m_requireEquiSpaced
bool	m_prohibitWrite = false
bool	m_equispacedSetup = false
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

Output to fld format.

Definition at line 45 of file OutputFld.h.

Constructor & Destructor Documentation

OutputFld()

Nektar::FieldUtils::OutputFld::OutputFld

(

FieldSharedPtr

f

)

Definition at line 57 of file OutputFld.cpp.

                                     : OutputFileBase(f)
{
    m_config["format"] =
        ConfigOption(false, "Xml", "Output format of field file");
}

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

~OutputFld()

Nektar::FieldUtils::OutputFld::~OutputFld ( )

override

Definition at line 63 of file OutputFld.cpp.

{
}

Member Function Documentation

create()

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

inlinestatic

Creates an instance of this class.

Definition at line 49 of file OutputFld.h.

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

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

GetIOFormat()

std::string Nektar::FieldUtils::OutputFld::GetIOFormat ( )

private

Definition at line 162 of file OutputFld.cpp.

{
    std::string iofmt("Xml");
    if (m_f->m_session)
    {
        if (m_f->m_session->DefinesSolverInfo("IOFormat"))
        {
            iofmt = m_f->m_session->GetSolverInfo("IOFormat");
        }
        if (m_f->m_session->DefinesCmdLineArgument("io-format"))
        {
            iofmt =
                m_f->m_session->GetCmdLineArgument<std::string>("io-format");
        }
    }
    if (m_config["format"].m_beenSet)
    {
        iofmt = m_config["format"].as<string>();
    }
    return iofmt;
}

References Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

Referenced by v_OutputFromData(), and v_OutputFromExp().

v_GetFullOutName()

fs::path Nektar::FieldUtils::OutputFld::v_GetFullOutName ( std::string &  filename, po::variables_map &  vm  )

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::OutputFileBase.

Definition at line 140 of file OutputFld.cpp.

{
    int nprocs = m_f->m_comm->GetSpaceComm()->GetSize();
    fs::path specPath(filename), fulloutname;
    if (nprocs == 1)
    {
        fulloutname = specPath;
    }
    else
    {
        // Guess at filename that might belong to this process.
        boost::format pad("P%1$07d.%2$s");
        pad % m_f->m_comm->GetSpaceComm()->GetRank() % "fld";
 
        // Generate full path name
        fs::path poutfile(pad.str());
        fulloutname = specPath / poutfile;
    }
    return fulloutname;
}

References CellMLToNektar.pycml::format, and Nektar::FieldUtils::Module::m_f.

v_GetModuleName()

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

inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::OutputFileBase.

Definition at line 59 of file OutputFld.h.

    {
        return "OutputFld";
    }

v_GetPath()

fs::path Nektar::FieldUtils::OutputFld::v_GetPath ( std::string &  filename, po::variables_map &  vm  )

overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::OutputFileBase.

Definition at line 134 of file OutputFld.cpp.

{
    return fs::path(filename);
}

v_OutputFromData()

void Nektar::FieldUtils::OutputFld::v_OutputFromData ( po::variables_map &  vm )

overrideprotectedvirtual

Write from data to output file.

Implements Nektar::FieldUtils::OutputFileBase.

Definition at line 122 of file OutputFld.cpp.

{
    // Extract the output filename and extension
    string filename = m_config["outfile"].as<string>();
    // Set up FieldIO object.
    LibUtilities::FieldIOSharedPtr fld =
        LibUtilities::GetFieldIOFactory().CreateInstance(GetIOFormat(),
                                                         m_f->m_comm, true);
 
    fld->Write(filename, m_f->m_fielddef, m_f->m_data, m_f->m_fieldMetaDataMap);
}

References Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::LibUtilities::GetFieldIOFactory(), GetIOFormat(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

v_OutputFromExp()

void Nektar::FieldUtils::OutputFld::v_OutputFromExp ( po::variables_map &  vm )

overrideprotectedvirtual

Write from m_exp to output file.

Implements Nektar::FieldUtils::OutputFileBase.

Definition at line 72 of file OutputFld.cpp.

{
    ASSERTL0(m_f->m_variables.size(), "OutputFld: need input data.")
 
    // Extract the output filename and extension
    string filename = m_config["outfile"].as<string>();
 
    // Set up FieldIO object.
    LibUtilities::FieldIOSharedPtr fld =
        LibUtilities::GetFieldIOFactory().CreateInstance(GetIOFormat(),
                                                         m_f->m_comm, true);
 
    int i, j, s;
    int nfields = m_f->m_variables.size();
    int nstrips;
    m_f->m_session->LoadParameter("Strip_Z", nstrips, 1);
 
    if (m_f->m_exp[0]->GetNumElmts() != 0)
    {
        std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
            m_f->m_exp[0]->GetFieldDefinitions();
        std::vector<std::vector<NekDouble>> FieldData(FieldDef.size());
        for (s = 0; s < nstrips; ++s)
        {
            for (j = 0; j < nfields; ++j)
            {
                for (i = 0; i < FieldDef.size() / nstrips; ++i)
                {
                    int n = s * FieldDef.size() / nstrips + i;
 
                    FieldDef[n]->m_fields.push_back(m_f->m_variables[j]);
                    m_f->m_exp[s * nfields + j]->AppendFieldData(
                        FieldDef[n], FieldData[n],
                        m_f->m_exp[s * nfields + j]->UpdateCoeffs());
                }
            }
        }
        fld->Write(filename, FieldDef, FieldData, m_f->m_fieldMetaDataMap,
                   false);
    }
    else
    {
        std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
            std::vector<LibUtilities::FieldDefinitionsSharedPtr>();
        std::vector<std::vector<NekDouble>> FieldData =
            std::vector<std::vector<NekDouble>>();
        fld->Write(filename, FieldDef, FieldData, m_f->m_fieldMetaDataMap);
    }
}

References ASSERTL0, Nektar::LibUtilities::NekFactory< tKey, tBase, tParam >::CreateInstance(), Nektar::LibUtilities::GetFieldIOFactory(), GetIOFormat(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

v_OutputFromPts()

void Nektar::FieldUtils::OutputFld::v_OutputFromPts ( po::variables_map &  vm )

overrideprotectedvirtual

Write from pts to output file.

Implements Nektar::FieldUtils::OutputFileBase.

Definition at line 67 of file OutputFld.cpp.

{
    NEKERROR(ErrorUtil::efatal, "OutputFld can't write using Pts information.");
}

References Nektar::ErrorUtil::efatal, and NEKERROR.

Member Data Documentation

m_className

ModuleKey Nektar::FieldUtils::OutputFld::m_className

static

Initial value:

= {
    GetModuleFactory().RegisterCreatorFunction(ModuleKey(eOutputModule, "fld"),
                                               OutputFld::create,
                                               "Writes a Fld file."),
    GetModuleFactory().RegisterCreatorFunction(ModuleKey(eOutputModule, "chk"),
                                               OutputFld::create,
                                               "Writes a Fld file."),
}

Definition at line 53 of file OutputFld.h.