Nektar++
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
Nektar::FieldUtils::InputFld Class Reference

#include <InputFld.h>

Inheritance diagram for Nektar::FieldUtils::InputFld:
[legend]

Public Member Functions

 InputFld (FieldSharedPtr f)
 Set up InputFld object. More...
 
virtual ~InputFld ()
 
- Public Member Functions inherited from Nektar::FieldUtils::InputModule
 InputModule (FieldSharedPtr p_m)
 
void PrintSummary ()
 Print a brief summary of information. 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 ConfigOptionGetConfigOption (const std::string &key) const
 
ModulePriority GetModulePriority ()
 
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 ModuleSharedPtr create (FieldSharedPtr f)
 Creates an instance of this class. More...
 
- Static Public Member Functions inherited from Nektar::FieldUtils::InputModule
static FIELD_UTILS_EXPORT std::string GuessFormat (std::string fileName)
 Tries to guess the format of the input file. More...
 

Static Public Attributes

static ModuleKey m_className []
 ModuleKey for class. More...
 

Protected Member Functions

virtual void v_Process (po::variables_map &vm) override
 
virtual std::string v_GetModuleName () override
 
virtual std::string v_GetModuleDescription () override
 
virtual 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 ()
 

Additional Inherited Members

- Public Attributes inherited from Nektar::FieldUtils::Module
FieldSharedPtr m_f
 Field object. More...
 
- Protected Attributes inherited from Nektar::FieldUtils::Module
std::map< std::string, ConfigOptionm_config
 List of configuration values. More...
 
std::set< std::string > m_allowedFiles
 List of allowed file formats. More...
 

Detailed Description

Converter for Fld files.

Definition at line 48 of file InputFld.h.

Constructor & Destructor Documentation

◆ InputFld()

Nektar::FieldUtils::InputFld::InputFld ( FieldSharedPtr  f)

Set up InputFld object.

Definition at line 66 of file InputFld.cpp.

66 : InputModule(f)
67{
68 m_allowedFiles.insert("fld");
69 m_allowedFiles.insert("chk");
70 m_allowedFiles.insert("rst");
71 m_allowedFiles.insert("bse");
72}
InputModule(FieldSharedPtr p_m)
Definition: Module.cpp:63
std::set< std::string > m_allowedFiles
List of allowed file formats.
Definition: Module.h:265

References Nektar::FieldUtils::Module::m_allowedFiles.

◆ ~InputFld()

Nektar::FieldUtils::InputFld::~InputFld ( )
virtual

Definition at line 77 of file InputFld.cpp.

78{
79}

Member Function Documentation

◆ create()

static ModuleSharedPtr Nektar::FieldUtils::InputFld::create ( FieldSharedPtr  f)
inlinestatic

Creates an instance of this class.

Definition at line 55 of file InputFld.h.

56 {
58 }
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.

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

◆ v_GetModuleDescription()

virtual std::string Nektar::FieldUtils::InputFld::v_GetModuleDescription ( )
inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 70 of file InputFld.h.

71 {
72 return "Processing input fld file";
73 }

◆ v_GetModuleName()

virtual std::string Nektar::FieldUtils::InputFld::v_GetModuleName ( )
inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 65 of file InputFld.h.

66 {
67 return "InputFld";
68 }

◆ v_GetModulePriority()

virtual ModulePriority Nektar::FieldUtils::InputFld::v_GetModulePriority ( )
inlineoverrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 75 of file InputFld.h.

76 {
77 return eCreateFieldData;
78 }

References Nektar::FieldUtils::eCreateFieldData.

◆ v_Process()

void Nektar::FieldUtils::InputFld::v_Process ( po::variables_map &  vm)
overrideprotectedvirtual

Reimplemented from Nektar::FieldUtils::Module.

Definition at line 84 of file InputFld.cpp.

85{
86 boost::ignore_unused(vm);
87
88 int i;
89 string fileName = m_config["infile"].as<string>();
90
91 LibUtilities::FieldIOSharedPtr fld = m_f->FieldIOForFile(fileName);
92
93 int oldSize = m_f->m_fielddef.size();
94 if (m_f->m_graph)
95 {
96 // Determine IDs of elements in the domain
97 vector<int> IDs;
98 auto domain = m_f->m_graph->GetDomain();
99 for (int d = 0; d < domain.size(); ++d)
100 {
101 for (auto &compIter : domain[d])
102 {
103 for (auto &x : compIter.second->m_geomVec)
104 {
105 IDs.push_back(x->GetGlobalID());
106 }
107 }
108 }
109
110 if (!IDs.size())
111 {
112 return;
113 }
114
115 // Move to an array to match FieldIO interface
116 Array<OneD, int> ElementGIDs(IDs.size(), IDs.data());
117
118 fld->Import(fileName, m_f->m_fielddef, m_f->m_data,
119 m_f->m_fieldMetaDataMap, ElementGIDs);
120 }
121 else // load all data.
122 {
123 fld->Import(fileName, m_f->m_fielddef, m_f->m_data,
124 m_f->m_fieldMetaDataMap);
125 }
126
127 // save field names
128 for (i = 0; i < m_f->m_fielddef[oldSize]->m_fields.size(); ++i)
129 {
130 // check for multiple fld files
131 auto it = find(m_f->m_variables.begin(), m_f->m_variables.end(),
132 m_f->m_fielddef[oldSize]->m_fields[i]);
133
134 if (it == m_f->m_variables.end())
135 {
136 m_f->m_variables.push_back(m_f->m_fielddef[oldSize]->m_fields[i]);
137 }
138 }
139}
FieldSharedPtr m_f
Field object.
Definition: Module.h:234
std::map< std::string, ConfigOption > m_config
List of configuration values.
Definition: Module.h:263
std::shared_ptr< FieldIO > FieldIOSharedPtr
Definition: FieldIO.h:327
InputIterator find(InputIterator first, InputIterator last, InputIterator startingpoint, const EqualityComparable &value)
Definition: StdRegions.hpp:453
std::vector< double > d(NPUPPER *NPUPPER)

References Nektar::UnitTests::d(), Nektar::StdRegions::find(), Nektar::FieldUtils::Module::m_config, and Nektar::FieldUtils::Module::m_f.

Member Data Documentation

◆ m_className

ModuleKey Nektar::FieldUtils::InputFld::m_className
static
Initial value:
= {
ModuleKey(eInputModule, "fld"), InputFld::create, "Reads Fld file."),
"Reads checkpoint file."),
"Reads restart file."),
"Reads stability base-flow file.")}
static ModuleSharedPtr create(FieldSharedPtr f)
Creates an instance of this class.
Definition: InputFld.h:55
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
std::pair< ModuleType, std::string > ModuleKey
Definition: Module.h:317
ModuleFactory & GetModuleFactory()
Definition: Module.cpp:49

ModuleKey for class.

Definition at line 60 of file InputFld.h.