Chaste Commit::baa90ac2819b962188b7562f2326be23c47859a7
OffLatticeRandomFieldGenerator.hpp
1/*
2
3Copyright (c) 2005-2024, University of Oxford.
4All rights reserved.
5
6University of Oxford means the Chancellor, Masters and Scholars of the
7University of Oxford, having an administrative office at Wellington
8Square, Oxford OX1 2JD, UK.
9
10This file is part of Chaste.
11
12Redistribution and use in source and binary forms, with or without
13modification, are permitted provided that the following conditions are met:
14 * Redistributions of source code must retain the above copyright notice,
15 this list of conditions and the following disclaimer.
16 * Redistributions in binary form must reproduce the above copyright notice,
17 this list of conditions and the following disclaimer in the documentation
18 and/or other materials provided with the distribution.
19 * Neither the name of the University of Oxford nor the names of its
20 contributors may be used to endorse or promote products derived from this
21 software without specific prior written permission.
22
23THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34*/
35
36#ifndef OFF_LATTICE_RANDOM_FIELD_GENERATOR_HPP_
37#define OFF_LATTICE_RANDOM_FIELD_GENERATOR_HPP_
38
39#include <array>
40#include <memory>
41#include <vector>
42
44#include "Node.hpp"
45#include "ObsoleteBoxCollection.hpp"
47
48#include "OpenSimplex2S.hpp"
49
53template<unsigned SPACE_DIM>
55{
56private:
57
58 friend class boost::serialization::access;
59 friend class TestOffLatticeRandomFieldGenerator;
60
62 std::array<double, SPACE_DIM> mLowerCorner;
63
65 std::array<double, SPACE_DIM> mUpperCorner;
66
68 std::array<bool, SPACE_DIM> mPeriodicity;
69
72
77 std::unique_ptr<ObsoleteBoxCollection<SPACE_DIM>> mpBoxCollection;
78
81
88 template<class Archive>
89 void serialize(Archive & archive, const unsigned int version)
90 {
91 archive & mLowerCorner;
92 archive & mUpperCorner;
93 archive & mPeriodicity;
94 archive & mLengthScale;
95 }
96
101
102public:
103
116 OffLatticeRandomFieldGenerator(std::array<double, SPACE_DIM> lowerCorner,
117 std::array<double, SPACE_DIM> upperCorner,
118 std::array<bool, SPACE_DIM> periodicity,
119 double lengthScale,
120 double boxWidth=DOUBLE_UNSET);
121
126
137 std::vector<double> SampleRandomField(const std::vector<Node<SPACE_DIM>*>& rNodes);
138
149 std::vector<double> SampleRandomFieldAtTime(const std::vector<Node<SPACE_DIM>*>& rNodes, double time);
150
156 void SetRandomSeed(const unsigned seed);
157};
158
159#endif /*OFF_LATTICE_RANDOM_FIELD_GENERATOR_HPP_*/
const double DOUBLE_UNSET
Definition Exception.hpp:57
Definition Node.hpp:59
virtual ~OffLatticeRandomFieldGenerator()=default
std::vector< double > SampleRandomField(const std::vector< Node< SPACE_DIM > * > &rNodes)
std::array< double, SPACE_DIM > mUpperCorner
std::unique_ptr< ObsoleteBoxCollection< SPACE_DIM > > mpBoxCollection
std::vector< double > SampleRandomFieldAtTime(const std::vector< Node< SPACE_DIM > * > &rNodes, double time)
std::array< double, SPACE_DIM > mLowerCorner
void serialize(Archive &archive, const unsigned int version)