Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
FilterThresholdMin.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FilterThresholdMin.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 time when solution first drops below a threshold value.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
37 
38 using namespace std;
39 
40 namespace Nektar
41 {
42 namespace SolverUtils
43 {
44 
45 std::string FilterThresholdMin::className =
47  "ThresholdMin", FilterThresholdMin::create);
48 
49 
50 /**
51  *
52  */
53 FilterThresholdMin::FilterThresholdMin(
55  const ParamMap &pParams)
56  : Filter(pSession)
57 {
58  ParamMap::const_iterator it;
59 
60  // ThresholdValue
61  it = pParams.find("ThresholdValue");
62  ASSERTL0(it != pParams.end(), "Missing parameter 'ThresholdValue'.");
63  LibUtilities::Equation equ1(m_session, it->second);
64  m_thresholdValue = equ1.Evaluate();
65 
66  // InitialValue
67  it = pParams.find("InitialValue");
68  ASSERTL0(it != pParams.end(), "Missing parameter 'InitialValue'.");
69  LibUtilities::Equation equ2(m_session, it->second);
70  m_initialValue = equ2.Evaluate();
71 
72  // StartTime
73  it = pParams.find("StartTime");
74  m_startTime = 0.0;
75  if (it != pParams.end())
76  {
77  LibUtilities::Equation equ(m_session, it->second);
78  m_startTime = equ.Evaluate();
79  }
80 
81  // OutputFile
82  it = pParams.find("OutputFile");
83  m_outputFile = pSession->GetSessionName() + "_max.fld";
84  if (it != pParams.end())
85  {
86  m_outputFile = it->second;
87  }
88 
89  // ThresholdVar
90  it = pParams.find("ThresholdVar");
91  m_thresholdVar = 0;
92  if (it != pParams.end())
93  {
94  std::string var = it->second.c_str();
95  std::vector<string> varlist = pSession->GetVariables();
96  std::vector<string>::const_iterator x;
97  ASSERTL0((x=std::find(varlist.begin(), varlist.end(), var))
98  != varlist.end(),
99  "Specified variable " + var +
100  " in ThresholdMin filter is not available.");
101  m_thresholdVar = x - varlist.begin();
102  }
103 
105 }
106 
107 
108 /**
109  *
110  */
112 {
113 
114 }
115 
116 
117 /**
118  *
119  */
122  const NekDouble &time)
123 {
125  pFields[m_thresholdVar]->GetNpoints(), m_initialValue);
126 }
127 
128 
129 /**
130  *
131  */
134  const NekDouble &time)
135 {
136  if (time < m_startTime)
137  {
138  return;
139  }
140 
141  int i;
142  NekDouble timestep = pFields[m_thresholdVar]->GetSession()->GetParameter("TimeStep");
143 
144  for (i = 0; i < pFields[m_thresholdVar]->GetNpoints(); ++i)
145  {
146  if (m_threshold[i] < timestep &&
147  pFields[m_thresholdVar]->GetPhys()[i] > m_thresholdValue)
148  {
149  m_threshold[i] = time;
150  }
151  }
152 }
153 
154 
155 /**
156  *
157  */
160  const NekDouble &time)
161 {
162  std::stringstream vOutputFilename;
163  vOutputFilename << m_outputFile << ".fld";
164 
165  std::vector<LibUtilities::FieldDefinitionsSharedPtr> FieldDef
166  = pFields[0]->GetFieldDefinitions();
167  std::vector<std::vector<NekDouble> > FieldData(FieldDef.size());
168 
169  Array<OneD, NekDouble> vCoeffs(pFields[0]->GetNcoeffs());
170  pFields[0]->FwdTrans_IterPerExp(m_threshold, vCoeffs);
171 
172  // copy Data into FieldData and set variable
173  for(int i = 0; i < FieldDef.size(); ++i)
174  {
175  // Could do a search here to find correct variable
176  FieldDef[i]->m_fields.push_back("m");
177  pFields[0]->AppendFieldData(FieldDef[i], FieldData[i], vCoeffs);
178  }
179 
180  m_fld->Write(vOutputFilename.str(),FieldDef,FieldData);
181 }
182 
183 
184 /**
185  *
186  */
188 {
189  return true;
190 }
191 
192 }
193 }
#define ASSERTL0(condition, msg)
Definition: ErrorUtil.hpp:198
NekDouble m_startTime
Time at which to start recording.
STL namespace.
virtual SOLVER_UTILS_EXPORT void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Initialises the filter.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
virtual SOLVER_UTILS_EXPORT bool v_IsTimeDependent()
Indicate that this filter is time dependent.
NekDouble m_thresholdValue
Value of threshold.
NekDouble Evaluate() const
Definition: Equation.h:102
int m_thresholdVar
Variable on which to detect threshold.
double NekDouble
NekDouble m_initialValue
Initial value of storage.
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
LibUtilities::SessionReaderSharedPtr m_session
Definition: Filter.h:84
std::string m_outputFile
File into which to write output data.
virtual SOLVER_UTILS_EXPORT ~FilterThresholdMin()
static boost::shared_ptr< FieldIO > CreateDefault(const LibUtilities::SessionReaderSharedPtr session)
Returns an object for the default FieldIO method.
Definition: FieldIO.cpp:181
virtual SOLVER_UTILS_EXPORT void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
For each point in domain test if solution is below threshold.
LibUtilities::FieldIOSharedPtr m_fld
FieldIO object for writing data.
virtual SOLVER_UTILS_EXPORT void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Finalise the filter and write out data.
InputIterator find(InputIterator first, InputIterator last, InputIterator startingpoint, const EqualityComparable &value)
Definition: StdRegions.hpp:316
FilterFactory & GetFilterFactory()
Definition: Filter.cpp:42
Array< OneD, NekDouble > m_threshold
Storage for recording when each point in domain drops below threshold.
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215