Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
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 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Outputs solution fields during time-stepping.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
37 
38 namespace Nektar
39 {
40 namespace SolverUtils
41 {
42 std::string FilterCheckpoint::className =
44  "Checkpoint", FilterCheckpoint::create);
45 
48  const ParamMap &pParams) :
49  Filter(pSession)
50 {
51  ParamMap::const_iterator it;
52 
53  // OutputFile
54  it = pParams.find("OutputFile");
55  if (it == pParams.end())
56  {
57  m_outputFile = m_session->GetSessionName();
58  }
59  else
60  {
61  ASSERTL0(it->second.length() > 0, "Empty parameter 'OutputFile'.");
62  m_outputFile = it->second;
63  }
64 
65  // OutputFrequency
66  it = pParams.find("OutputFrequency");
67  ASSERTL0(it != pParams.end(), "Missing parameter 'OutputFrequency'.");
68  LibUtilities::Equation equ(m_session, it->second);
69  m_outputFrequency = round(equ.Evaluate());
70 
72 }
73 
75 {
76 
77 }
78 
81  const NekDouble &time)
82 {
83  m_index = 0;
84  m_outputIndex = 0;
85  v_Update(pFields, time);
86 }
87 
90  const NekDouble &time)
91 {
92  if (m_index++ % m_outputFrequency > 0)
93  {
94  return;
95  }
96 
97  std::stringstream vOutputFilename;
98  vOutputFilename << m_outputFile << "_" << m_outputIndex << ".chk";
99 
100  std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef
101  = pFields[0]->GetFieldDefinitions();
102  std::vector<std::vector<NekDouble> > FieldData(FieldDef.size());
103 
104  // copy Data into FieldData and set variable
105  for(int j = 0; j < pFields.num_elements(); ++j)
106  {
107  for(int i = 0; i < FieldDef.size(); ++i)
108  {
109  // Could do a search here to find correct variable
110  FieldDef[i]->m_fields.push_back(m_session->GetVariable(j));
111  pFields[0]->AppendFieldData(FieldDef[i],
112  FieldData[i],
113  pFields[j]->UpdateCoeffs());
114  }
115  }
116  m_fld->Write(vOutputFilename.str(),FieldDef,FieldData);
117  m_outputIndex++;
118 }
119 
122  const NekDouble &time)
123 {
124 
125 }
126 
128 {
129  return true;
130 }
131 }
132 }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
Creates an instance of this class.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
virtual SOLVER_UTILS_EXPORT ~FilterCheckpoint()
SOLVER_UTILS_EXPORT FilterCheckpoint(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
double NekDouble
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
LibUtilities::FieldIOSharedPtr m_fld
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:84
static boost::shared_ptr< FieldIO > CreateDefault(const LibUtilities::SessionReaderSharedPtr session)
Returns an object for the default FieldIO method.
Definition: FieldIO.cpp:181
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
FilterFactory & GetFilterFactory()
Definition: Filter.cpp:42
static std::string className
Name of the class.
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215