Nektar++
FilterCheckpoint.cpp
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: FilterCheckpoint.cpp
4//
5// For more information, please see: http://www.nektar.info
6//
7// The MIT License
8//
9// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10// Department of Aeronautics, Imperial College London (UK), and Scientific
11// Computing and Imaging Institute, University of Utah (USA).
12//
13// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice shall be included
21// in all copies or substantial portions of the Software.
22//
23// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29// DEALINGS IN THE SOFTWARE.
30//
31// Description: Outputs solution fields during time-stepping.
32//
33///////////////////////////////////////////////////////////////////////////////
34
36
37namespace Nektar::SolverUtils
38{
42
45 const std::shared_ptr<EquationSystem> &pEquation, const ParamMap &pParams)
46 : Filter(pSession, pEquation)
47{
48 // OutputFile
49 std::string ext = ".chk";
50 m_outputFile = Filter::SetupOutput(ext, pParams);
51
52 // OutputFrequency
53 auto it = pParams.find("OutputFrequency");
54 ASSERTL0(it != pParams.end(), "Missing parameter 'OutputFrequency'.");
55 LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
56 m_outputFrequency = round(equ.Evaluate());
57
58 // Time after which we need to write checkfiles
59 it = pParams.find("OutputStartTime");
60 if (it == pParams.end())
61 {
63 }
64 else
65 {
66 LibUtilities::Equation equ(m_session->GetInterpreter(), it->second);
68 }
69
71}
72
74{
75}
76
79 &pFields,
80 [[maybe_unused]] const NekDouble &time)
81{
82 m_index = 0;
83 m_outputIndex = 0;
84
86 {
87 v_Update(pFields, time);
88 }
89}
90
93 const NekDouble &time)
94{
95
96 if (m_index++ % m_outputFrequency > 0 ||
97 (time - m_outputStartTime) < -1.0e-07)
98 {
99 return;
100 }
101
102 // get the extension of file name
103 std::string ext = fs::path(m_outputFile).extension().string();
104
105 std::stringstream vTmpFilename;
106 std::string vOutputFilename;
107 vTmpFilename << fs::path(m_outputFile).replace_extension("").string() << "_"
108 << m_outputIndex << ".chk";
109 vOutputFilename = Filter::SetupOutput(ext, vTmpFilename.str());
110
111 std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef =
112 pFields[0]->GetFieldDefinitions();
113 std::vector<std::vector<NekDouble>> FieldData(FieldDef.size());
114
115 // copy Data into FieldData and set variable
116 for (int j = 0; j < pFields.size(); ++j)
117 {
118 for (int i = 0; i < FieldDef.size(); ++i)
119 {
120 // Could do a search here to find correct variable
121 FieldDef[i]->m_fields.push_back(m_session->GetVariable(j));
122 pFields[0]->AppendFieldData(FieldDef[i], FieldData[i],
123 pFields[j]->UpdateCoeffs());
124 }
125 }
126 m_fld->Write(vOutputFilename, FieldDef, FieldData);
128}
129
132 &pFields,
133 [[maybe_unused]] const NekDouble &time)
134{
135}
136
138{
139 return true;
140}
141} // namespace Nektar::SolverUtils
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:208
static std::shared_ptr< FieldIO > CreateDefault(const LibUtilities::SessionReaderSharedPtr session)
Returns an object for the default FieldIO method.
Definition: FieldIO.cpp:194
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
SOLVER_UTILS_EXPORT ~FilterCheckpoint() override
SOLVER_UTILS_EXPORT FilterCheckpoint(const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation, const ParamMap &pParams)
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::shared_ptr< EquationSystem > &pEquation, const std::map< std::string, std::string > &pParams)
Creates an instance of this class.
void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
LibUtilities::FieldIOSharedPtr m_fld
void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time) override
static std::string className
Name of the class.
SOLVER_UTILS_EXPORT std::string SetupOutput(const std::string ext, const ParamMap &pParams)
Definition: Filter.h:139
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:93
std::map< std::string, std::string > ParamMap
Definition: Filter.h:66
std::shared_ptr< SessionReader > SessionReaderSharedPtr
FilterFactory & GetFilterFactory()
double NekDouble