MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TimeSmoothedCG.h
Go to the documentation of this file.
1 //Copyright (c) 2013-2020, The MercuryDPM Developers Team. All rights reserved.
2 //For the list of developers, see <http://www.MercuryDPM.org/Team>.
3 //
4 //Redistribution and use in source and binary forms, with or without
5 //modification, are permitted provided that the following conditions are met:
6 // * Redistributions of source code must retain the above copyright
7 // notice, this list of conditions and the following disclaimer.
8 // * Redistributions in binary form must reproduce the above copyright
9 // notice, this list of conditions and the following disclaimer in the
10 // documentation and/or other materials provided with the distribution.
11 // * Neither the name MercuryDPM nor the
12 // names of its contributors may be used to endorse or promote products
13 // derived from this software without specific prior written permission.
14 //
15 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
16 //ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17 //WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 //DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
19 //DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20 //(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21 //LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22 //ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 //(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 #ifndef TimeSmoothedCG_H
26 #define TimeSmoothedCG_H
27 
28 #include <GeneralDefine.h>
29 #include "CG/CG.h"
30 #include <iostream>
31 #include <vector>
32 #include "TimeSmoothedFields.h"
33 
34 class BaseParticle;
35 
36 class BaseInteraction;
37 
38 class DPMBase;
39 
40 class Function;
41 
58 template<class Coordinates, template<class> class BaseFunction=CGFunctions::Lucy, class Fields=CGFields::StandardFields>
59 class TimeSmoothedCG final : public CG<Coordinates, BaseFunction, Fields>
60 {
61 public:
62  typedef BaseFunction<Coordinates> Function;
63 
69 
74  TimeSmoothedCG(const TimeSmoothedCG& p) = default;
75 
79  virtual ~TimeSmoothedCG() = default;
80 
85 
89  void write(std::ostream& os) const override;
90 
91  void writeAll(std::ostream& os, TimeSmoothedFields<Fields>& average) const;
92 
96  std::string getName() const override;
97 
102  void initialise() override;
103 
108  void evaluate() override;
109 
114  void finish() override;
115 
116  void setWidthTime(Mdouble widthTime);
117 
118  Mdouble getWidthTime() const;
119 
120  void setTimeStep(Mdouble timeStep);
121 
122  Mdouble getTimeStep() const;
123 
124 protected:
125 
132 
139 
147 
154 
159  std::vector<TimeSmoothedFields<Fields> > averages_;
160 };
161 
162 #include "TimeSmoothedCG.hcc"
163 
164 #endif
void initialise() override
Called at the beginning of the DPM simulation to initialise the cg evaluation and to open the statFil...
virtual ~TimeSmoothedCG()=default
Destructor, it simply destructs the TimeSmoothedCGFunction and all the objects it contains...
Template argument; use a member class of CGFunctions to instantiate.
The DPMBase header includes quite a few header files, defining all the handlers, which are essential...
Definition: DPMBase.h:72
double Mdouble
Definition: GeneralDefine.h:34
A specialisation of Polynomials for PolynomialType::Lucy. See Polynomial for details.
Definition: Lucy.h:38
BaseFunction< Coordinates > Function
void finish() override
Called at the end of the DPM simulation to finish the cg evaluation and to close the statFile...
void write(std::ostream &os) const override
Writes class content, except for the points, into an output stream.
Stores information about interactions between two interactable objects; often particles but could be ...
std::string getName() const override
returns the name of the class, which is required by write.
std::vector< TimeSmoothedFields< Fields > > averages_
A helper class for TimeSmoothedCG containing the time-smoothed variables.
Evaluates time-smoothed continuum fields and writes the data into a stat file.
TimeSmoothedCG()
Default constructor; does nothing, i.e. no points are created initially.
void setTimeStep(Mdouble timeStep)
Mdouble getWidthTime() const
void evaluate() override
Called after a given number of time steps (statFile::saveCount_) to evaluate the CG fields...
Evaluates time-resolved continuum fields and writes the data into a stat file.
Definition: CG.h:75
Contains the computed field values, like density, momentum and stress.
TimeSmoothedCG< Coordinates, BaseFunction, Fields > * copy() const override
Copy operator; creates a new'ed CG object.
Mdouble getTimeStep() const
void writeAll(std::ostream &os, TimeSmoothedFields< Fields > &average) const
void setWidthTime(Mdouble widthTime)