1 | /*
|
---|
2 | * SamplingGridProperties.hpp
|
---|
3 | *
|
---|
4 | * Created on: 25.07.2012
|
---|
5 | * Author: heber
|
---|
6 | */
|
---|
7 |
|
---|
8 | #ifndef SAMPLINGGRIDPROPERTIES_HPP_
|
---|
9 | #define SAMPLINGGRIDPROPERTIES_HPP_
|
---|
10 |
|
---|
11 | // include config.h
|
---|
12 | #ifdef HAVE_CONFIG_H
|
---|
13 | #include <config.h>
|
---|
14 | #endif
|
---|
15 |
|
---|
16 | #include "boost/serialization/export.hpp"
|
---|
17 | #include "boost/serialization/array.hpp"
|
---|
18 |
|
---|
19 | /** This class stores a sample function on a three-dimensional grid.
|
---|
20 | *
|
---|
21 | */
|
---|
22 | class SamplingGridProperties {
|
---|
23 | public:
|
---|
24 | /** Constructor for class SamplingGridProperties.
|
---|
25 | *
|
---|
26 | * \param _begin offset of grid
|
---|
27 | * \param _size edge length of cubic(!) domain
|
---|
28 | * \param _level number of gridpoints as \f$2^{\text{level}}\f$
|
---|
29 | */
|
---|
30 | SamplingGridProperties(
|
---|
31 | const double _begin[3],
|
---|
32 | const double _size,
|
---|
33 | const int _level);
|
---|
34 |
|
---|
35 | /** Copy constructor for class SamplingGridProperties.
|
---|
36 | *
|
---|
37 | * \param _props instance to copy from
|
---|
38 | */
|
---|
39 | SamplingGridProperties(const SamplingGridProperties &_props);
|
---|
40 |
|
---|
41 | /** Default constructor.
|
---|
42 | */
|
---|
43 | SamplingGridProperties();
|
---|
44 |
|
---|
45 | virtual ~SamplingGridProperties();
|
---|
46 |
|
---|
47 | /** Checks whether another instance is compatible with this one.
|
---|
48 | *
|
---|
49 | * \param _props other properties to check against
|
---|
50 | * \return true - are compatible, false - else
|
---|
51 | */
|
---|
52 | bool isCompatible(const SamplingGridProperties &_props) const
|
---|
53 | {
|
---|
54 | return *this == _props;
|
---|
55 | }
|
---|
56 |
|
---|
57 | /** Equality operator for class SamplingGridProperties.
|
---|
58 | *
|
---|
59 | * \param _props other object to compare to
|
---|
60 | */
|
---|
61 | bool operator==(const SamplingGridProperties &_props) const;
|
---|
62 |
|
---|
63 | /** Inequality operator for class SamplingGridProperties.
|
---|
64 | *
|
---|
65 | * \param _props other object to compare to
|
---|
66 | */
|
---|
67 | bool operator!=(const SamplingGridProperties &_props) const
|
---|
68 | {
|
---|
69 | return (!(*this == _props));
|
---|
70 | }
|
---|
71 |
|
---|
72 | public:
|
---|
73 | //!> offset of grid
|
---|
74 | double begin[3];
|
---|
75 | //!> size of grid, i.e. edge length of cubic(!) domain
|
---|
76 | double size;
|
---|
77 | //!> level, i.e. \f$2^{\text{level}}\f$ grid points per axis
|
---|
78 | int level;
|
---|
79 |
|
---|
80 | private:
|
---|
81 |
|
---|
82 | friend class boost::serialization::access;
|
---|
83 | // serialization
|
---|
84 | template <typename Archive>
|
---|
85 | void serialize(Archive& ar, const unsigned int version)
|
---|
86 | {
|
---|
87 | int i;
|
---|
88 | for (i=0; i<3; ++i)
|
---|
89 | ar & begin[i];
|
---|
90 | ar & size;
|
---|
91 | ar & level;
|
---|
92 | }
|
---|
93 |
|
---|
94 | };
|
---|
95 |
|
---|
96 | // we need to give this class a unique key for serialization
|
---|
97 | // its is only serialized through its base class FragmentJob
|
---|
98 | BOOST_CLASS_EXPORT_KEY(SamplingGridProperties)
|
---|
99 |
|
---|
100 | #endif /* SAMPLINGGRIDPROPERTIES_HPP_ */
|
---|