Nektar++
FilterThresholdMax.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FilterThresholdMax.h
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 exceeds a threshold value.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_FILTERS_FILTERTHRESHOLDMAX_H
37 #define NEKTAR_SOLVERUTILS_FILTERS_FILTERTHRESHOLDMAX_H
38 
40 
41 namespace Nektar
42 {
43 namespace SolverUtils
44 {
45 
46 class FilterThresholdMax : public Filter
47 {
48 public:
50 
51  /// Creates an instance of this class
54  const std::map<std::string, std::string> &pParams) {
56  //p->InitObject();
57  return p;
58  }
59 
60  ///Name of the class
61  static std::string className;
62 
65  const ParamMap &pParams);
67 
68 protected:
69  /// Initialises the filter.
70  virtual void v_Initialise(
72  const NekDouble &time);
73  /// For each point in domain test if solution is above threshold.
74  virtual void v_Update(
76  const NekDouble &time);
77  /// Finalise the filter and write out data.
78  virtual void v_Finalise(
80  const NekDouble &time);
81  /// Indicate that this filter is time dependent.
82  virtual bool v_IsTimeDependent();
83 
84 private:
85  /// Storage for recording when each point in domain rises above threshold.
87  /// Time at which to start recording.
89  /// Value of threshold.
91  /// Variable on which to detect threshold
93  /// Initial value of storage.
95  /// File into which to write output data.
96  std::string m_outputFile;
97  /// FieldIO object for writing data.
99 };
100 }
101 }
102 
103 #endif /* FILTERTHRESHOLDMAX_H_ */
Array< OneD, NekDouble > m_threshold
Storage for recording when each point in domain rises above threshold.
static FilterSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const std::map< std::string, std::string > &pParams)
Creates an instance of this class.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
virtual void v_Initialise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Initialises the filter.
LibUtilities::FieldIOSharedPtr m_fld
FieldIO object for writing data.
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
int m_thresholdVar
Variable on which to detect threshold.
virtual SOLVER_UTILS_EXPORT ~FilterThresholdMax()
NekDouble m_initialValue
Initial value of storage.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
SOLVER_UTILS_EXPORT FilterThresholdMax(const LibUtilities::SessionReaderSharedPtr &pSession, const ParamMap &pParams)
virtual bool v_IsTimeDependent()
Indicate that this filter is time dependent.
NekDouble m_thresholdValue
Value of threshold.
boost::shared_ptr< Filter > FilterSharedPtr
A shared pointer to a Driver object.
Definition: Filter.h:50
static std::string className
Name of the class.
boost::shared_ptr< FieldIO > FieldIOSharedPtr
Definition: FieldIO.h:236
NekDouble m_startTime
Time at which to start recording.
double NekDouble
std::map< std::string, std::string > ParamMap
Definition: Filter.h:67
#define SOLVER_UTILS_EXPORT
std::string m_outputFile
File into which to write output data.
virtual void v_Finalise(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
Finalise the filter and write out data.
virtual void v_Update(const Array< OneD, const MultiRegions::ExpListSharedPtr > &pFields, const NekDouble &time)
For each point in domain test if solution is above threshold.