Chaste
Commit::baa90ac2819b962188b7562f2326be23c47859a7
AbstractTimeAdaptivityController.hpp
1
/*
2
3
Copyright (c) 2005-2024, University of Oxford.
4
All rights reserved.
5
6
University of Oxford means the Chancellor, Masters and Scholars of the
7
University of Oxford, having an administrative office at Wellington
8
Square, Oxford OX1 2JD, UK.
9
10
This file is part of Chaste.
11
12
Redistribution and use in source and binary forms, with or without
13
modification, 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
23
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33
34
*/
35
36
#ifndef ABSTRACTTIMEADAPTIVITYCONTROLLER_HPP_
37
#define ABSTRACTTIMEADAPTIVITYCONTROLLER_HPP_
38
39
#include "PetscVecTools.hpp"
40
45
class
AbstractTimeAdaptivityController
46
{
47
private
:
48
50
double
mMinimumTimeStep
;
51
53
double
mMaximumTimeStep
;
54
63
virtual
double
ComputeTimeStep
(
double
currentTime,
Vec
currentSolution)=0;
64
65
public
:
66
73
AbstractTimeAdaptivityController
(
double
minimumTimeStep,
double
maximumTimeStep)
74
:
mMinimumTimeStep
(minimumTimeStep),
75
mMaximumTimeStep
(maximumTimeStep)
76
{
77
assert(minimumTimeStep>0.0);
78
assert(maximumTimeStep>0.0);
79
assert(minimumTimeStep < maximumTimeStep);
80
}
81
83
virtual
~AbstractTimeAdaptivityController
()
84
{
85
}
86
93
double
GetNextTimeStep
(
double
currentTime,
Vec
currentSolution)
94
{
95
double
dt =
ComputeTimeStep
(currentTime, currentSolution);
96
if
(dt <
mMinimumTimeStep
)
97
{
98
dt =
mMinimumTimeStep
;
99
}
100
if
(dt >
mMaximumTimeStep
)
101
{
102
dt =
mMaximumTimeStep
;
103
}
104
return
dt;
105
}
106
};
107
108
#endif
/*ABSTRACTTIMEADAPTIVITYCONTROLLER_HPP_*/
AbstractTimeAdaptivityController
Definition
AbstractTimeAdaptivityController.hpp:46
AbstractTimeAdaptivityController::ComputeTimeStep
virtual double ComputeTimeStep(double currentTime, Vec currentSolution)=0
AbstractTimeAdaptivityController::GetNextTimeStep
double GetNextTimeStep(double currentTime, Vec currentSolution)
Definition
AbstractTimeAdaptivityController.hpp:93
AbstractTimeAdaptivityController::~AbstractTimeAdaptivityController
virtual ~AbstractTimeAdaptivityController()
Definition
AbstractTimeAdaptivityController.hpp:83
AbstractTimeAdaptivityController::AbstractTimeAdaptivityController
AbstractTimeAdaptivityController(double minimumTimeStep, double maximumTimeStep)
Definition
AbstractTimeAdaptivityController.hpp:73
AbstractTimeAdaptivityController::mMaximumTimeStep
double mMaximumTimeStep
Definition
AbstractTimeAdaptivityController.hpp:53
AbstractTimeAdaptivityController::mMinimumTimeStep
double mMinimumTimeStep
Definition
AbstractTimeAdaptivityController.hpp:50
Vec
pde
src
common
AbstractTimeAdaptivityController.hpp
Generated by
1.9.8