LBIBCell
 All Classes Functions Variables Friends Pages
AbstractForceStruct.hpp
1 /* Copyright (c) 2013 David Sichau <mail"at"sichau"dot"eu>
2  * 2013-2015 Simon Tanaka <tanakas"at"gmx"dot"ch>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 #ifndef ABSTRACTFORCESTRUCT_HPP
23 #define ABSTRACTFORCESTRUCT_HPP
24 
25 #include <map>
26 #include <memory>
27 #include <string>
28 #include <vector>
29 
30 namespace LbmLib {
31 namespace nodes {
32 class GeometryNode;
33 }
34 
35 namespace solver {
44  virtual void calculateForce(const std::map<unsigned int,
45  std::shared_ptr<nodes::GeometryNode> >& nodes) = 0;
46 
50  virtual ~AbstractForceStruct() {}
51 
56  virtual void writeForceStruct(std::ofstream* const stream) const = 0;
57 
62  virtual unsigned int getType(void) const = 0;
63 
68  virtual unsigned int getPartnerGeometryNode(void) const = 0;
69 };
70 
71 }
72 }
73 
74 #endif // ABSTRACTFORCESTRUCT_HPP
virtual void calculateForce(const std::map< unsigned int, std::shared_ptr< nodes::GeometryNode > > &nodes)=0
calculates the force on the geometry nodes
virtual unsigned int getType(void) const =0
Returns the force type.
virtual void writeForceStruct(std::ofstream *const stream) const =0
writes the force struct to the ostream
the base class for all forces
virtual unsigned int getPartnerGeometryNode(void) const =0
getPartnerGeometryNode