source: src/Jobs/Grid/SamplingGridProperties.hpp@ c8f12e

Action_Thermostats Add_AtomRandomPerturbation Add_FitFragmentPartialChargesAction Add_RotateAroundBondAction Add_SelectAtomByNameAction Added_ParseSaveFragmentResults AddingActions_SaveParseParticleParameters Adding_Graph_to_ChangeBondActions Adding_MD_integration_tests Adding_ParticleName_to_Atom Adding_StructOpt_integration_tests AtomFragments Automaking_mpqc_open AutomationFragmentation_failures Candidate_v1.5.4 Candidate_v1.6.0 Candidate_v1.6.1 ChangeBugEmailaddress ChangingTestPorts ChemicalSpaceEvaluator CombiningParticlePotentialParsing Combining_Subpackages Debian_Package_split Debian_package_split_molecuildergui_only Disabling_MemDebug Docu_Python_wait EmpiricalPotential_contain_HomologyGraph EmpiricalPotential_contain_HomologyGraph_documentation Enable_parallel_make_install Enhance_userguide Enhanced_StructuralOptimization Enhanced_StructuralOptimization_continued Example_ManyWaysToTranslateAtom Exclude_Hydrogens_annealWithBondGraph FitPartialCharges_GlobalError Fix_BoundInBox_CenterInBox_MoleculeActions Fix_ChargeSampling_PBC Fix_ChronosMutex Fix_FitPartialCharges Fix_FitPotential_needs_atomicnumbers Fix_ForceAnnealing Fix_IndependentFragmentGrids Fix_ParseParticles Fix_ParseParticles_split_forward_backward_Actions Fix_PopActions Fix_QtFragmentList_sorted_selection Fix_Restrictedkeyset_FragmentMolecule Fix_StatusMsg Fix_StepWorldTime_single_argument Fix_Verbose_Codepatterns Fix_fitting_potentials Fixes ForceAnnealing_goodresults ForceAnnealing_oldresults ForceAnnealing_tocheck ForceAnnealing_with_BondGraph ForceAnnealing_with_BondGraph_continued ForceAnnealing_with_BondGraph_continued_betteresults ForceAnnealing_with_BondGraph_contraction-expansion FragmentAction_writes_AtomFragments FragmentMolecule_checks_bonddegrees GeometryObjects Gui_Fixes Gui_displays_atomic_force_velocity ImplicitCharges IndependentFragmentGrids IndependentFragmentGrids_IndividualZeroInstances IndependentFragmentGrids_IntegrationTest IndependentFragmentGrids_Sole_NN_Calculation JobMarket_RobustOnKillsSegFaults JobMarket_StableWorkerPool JobMarket_unresolvable_hostname_fix MoreRobust_FragmentAutomation ODR_violation_mpqc_open PartialCharges_OrthogonalSummation PdbParser_setsAtomName PythonUI_with_named_parameters QtGui_reactivate_TimeChanged_changes Recreated_GuiChecks Rewrite_FitPartialCharges RotateToPrincipalAxisSystem_UndoRedo SaturateAtoms_findBestMatching SaturateAtoms_singleDegree StoppableMakroAction Subpackage_CodePatterns Subpackage_JobMarket Subpackage_LinearAlgebra Subpackage_levmar Subpackage_mpqc_open Subpackage_vmg Switchable_LogView ThirdParty_MPQC_rebuilt_buildsystem TrajectoryDependenant_MaxOrder TremoloParser_IncreasedPrecision TremoloParser_MultipleTimesteps TremoloParser_setsAtomName Ubuntu_1604_changes stable v1.3.7
Last change on this file since c8f12e was c889b7, checked in by Frederik Heber <heber@…>, 12 years ago

Extended SamplingGrid to be usable as SetValue.

  • Property mode set to 100644
File size: 2.3 KB
Line 
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 */
22class SamplingGridProperties {
23public:
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
72public:
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
80private:
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
98BOOST_CLASS_EXPORT_KEY(SamplingGridProperties)
99
100#endif /* SAMPLINGGRIDPROPERTIES_HPP_ */
Note: See TracBrowser for help on using the repository browser.