Tempus
Version of the Day
Time Integration
Main Page
Related Pages
Namespaces
Classes
Files
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
src
Tempus_StepperRKAppActionComposite.hpp
Go to the documentation of this file.
1
//@HEADER
2
// *****************************************************************************
3
// Tempus: Time Integration and Sensitivity Analysis Package
4
//
5
// Copyright 2017 NTESS and the Tempus contributors.
6
// SPDX-License-Identifier: BSD-3-Clause
7
// *****************************************************************************
8
//@HEADER
9
10
#ifndef Tempus_StepperRKAppActionComposite_hpp
11
#define Tempus_StepperRKAppActionComposite_hpp
12
13
#include "Tempus_config.hpp"
14
#include "
Tempus_StepperRKAppAction.hpp
"
15
#include <vector>
16
17
namespace
Tempus {
18
24
template
<
class
Scalar>
25
class
StepperRKAppActionComposite
26
:
virtual
public
Tempus::StepperRKAppAction
<Scalar> {
27
public
:
29
StepperRKAppActionComposite
() {}
30
32
virtual
~StepperRKAppActionComposite
() {}
33
35
virtual
void
execute
(
36
Teuchos::RCP
<
SolutionHistory<Scalar>
> sh,
37
Teuchos::RCP
<
StepperRKBase<Scalar>
> stepper,
38
const
typename
StepperRKAppAction<Scalar>::ACTION_LOCATION
actLoc)
39
{
40
for
(
auto
& a :
appActions_
) a->execute(sh, stepper, actLoc);
41
}
42
43
// Add AppAction to the AppAction vector.
44
void
addRKAppAction
(
Teuchos::RCP
<
StepperRKAppAction<Scalar>
> appAction)
45
{
46
appActions_
.push_back(appAction);
47
}
48
49
// Clear the AppAction vector.
50
void
clearRKAppActions
() {
appActions_
.clear(); }
51
52
// Return the size of the AppAction vector.
53
std::size_t
getSize
()
const
{
return
appActions_
.size(); }
54
55
private
:
56
std::vector<Teuchos::RCP<StepperRKAppAction<Scalar> > >
appActions_
;
57
};
58
59
}
// namespace Tempus
60
#endif // Tempus_StepperRKAppActionComposite_hpp
Tempus::StepperRKAppActionComposite::StepperRKAppActionComposite
StepperRKAppActionComposite()
Default constructor.
Definition:
Tempus_StepperRKAppActionComposite.hpp:29
Tempus_StepperRKAppAction.hpp
Tempus::StepperRKAppActionComposite::getSize
std::size_t getSize() const
Definition:
Tempus_StepperRKAppActionComposite.hpp:53
Tempus::StepperRKAppActionComposite
This composite AppAction loops over added AppActions.
Definition:
Tempus_StepperRKAppActionComposite.hpp:25
Tempus::StepperRKBase
Base class for Runge-Kutta methods, ExplicitRK, DIRK and IMEX.
Definition:
Tempus_StepperRKAppAction.hpp:20
Tempus::StepperRKAppAction
Application Action for StepperRKBase.
Definition:
Tempus_StepperRKAppAction.hpp:35
Tempus::StepperRKAppActionComposite::execute
virtual void execute(Teuchos::RCP< SolutionHistory< Scalar > > sh, Teuchos::RCP< StepperRKBase< Scalar > > stepper, const typename StepperRKAppAction< Scalar >::ACTION_LOCATION actLoc)
Execute application action for RK Stepper.
Definition:
Tempus_StepperRKAppActionComposite.hpp:35
Tempus::SolutionHistory
SolutionHistory is basically a container of SolutionStates. SolutionHistory maintains a collection of...
Definition:
Tempus_Integrator.hpp:28
Tempus::StepperRKAppActionComposite::~StepperRKAppActionComposite
virtual ~StepperRKAppActionComposite()
Destructor.
Definition:
Tempus_StepperRKAppActionComposite.hpp:32
Tempus::StepperRKAppAction::ACTION_LOCATION
ACTION_LOCATION
Indicates the location of application action (see algorithm).
Definition:
Tempus_StepperRKAppAction.hpp:38
Tempus::StepperRKAppActionComposite::clearRKAppActions
void clearRKAppActions()
Definition:
Tempus_StepperRKAppActionComposite.hpp:50
Tempus::StepperRKAppActionComposite::appActions_
std::vector< Teuchos::RCP< StepperRKAppAction< Scalar > > > appActions_
Definition:
Tempus_StepperRKAppActionComposite.hpp:56
Teuchos::RCP
Tempus::StepperRKAppActionComposite::addRKAppAction
void addRKAppAction(Teuchos::RCP< StepperRKAppAction< Scalar > > appAction)
Definition:
Tempus_StepperRKAppActionComposite.hpp:44
Generated on Fri Nov 22 2024 09:23:26 for Tempus by
1.8.5