Thyra
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
core
src
support
operator_vector
adapter_support
Thyra_apply_op_helper_def.hpp
1
// @HEADER
2
// ***********************************************************************
3
//
4
// Thyra: Interfaces and Support for Abstract Numerical Algorithms
5
// Copyright (2004) Sandia Corporation
6
//
7
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8
// license for use of this work by or on behalf of the U.S. Government.
9
//
10
// Redistribution and use in source and binary forms, with or without
11
// modification, are permitted provided that the following conditions are
12
// met:
13
//
14
// 1. Redistributions of source code must retain the above copyright
15
// notice, this list of conditions and the following disclaimer.
16
//
17
// 2. Redistributions in binary form must reproduce the above copyright
18
// notice, this list of conditions and the following disclaimer in the
19
// documentation and/or other materials provided with the distribution.
20
//
21
// 3. Neither the name of the Corporation nor the names of the
22
// contributors may be used to endorse or promote products derived from
23
// this software without specific prior written permission.
24
//
25
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36
//
37
// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38
//
39
// ***********************************************************************
40
// @HEADER
41
42
#ifndef THYRA_APPLY_OP_HELPER_HPP
43
#define THYRA_APPLY_OP_HELPER_HPP
44
45
#include "Thyra_apply_op_helper_decl.hpp"
46
#include "Thyra_VectorBase.hpp"
47
#include "Thyra_VectorSpaceBase.hpp"
48
#include "Thyra_AssertOp.hpp"
49
#include "Teuchos_Assert.hpp"
50
#include "
Teuchos_as.hpp
"
51
52
53
template
<
class
Scalar>
54
void
Thyra::apply_op_validate_input
(
55
const
std::string &func_name,
56
const
VectorSpaceBase<Scalar>
&space,
57
const
RTOpPack::RTOpT<Scalar>
&
/* op */
,
58
const
ArrayView
<
const
Ptr
<
const
VectorBase<Scalar>
> > &vecs,
59
const
ArrayView
<
const
Ptr
<
VectorBase<Scalar>
> > &targ_vecs,
60
const
Ptr<RTOpPack::ReductTarget>
&
/* reduct_obj */
,
61
const
Ordinal global_offset_in
62
)
63
{
64
const
int
num_vecs = vecs.size();
65
const
int
num_targ_vecs = targ_vecs.size();
66
TEUCHOS_TEST_FOR_EXCEPTION
(
67
global_offset_in < 0, std::logic_error
68
,func_name <<
" : Error! global_offset_in = "
69
<<global_offset_in<<
" is not valid"
);
70
for
(
int
k = 0; k < num_vecs; ++k)
71
THYRA_ASSERT_VEC_SPACES
(func_name,space,*vecs[k]->space());
72
for
(
int
k = 0; k < num_targ_vecs; ++k)
73
THYRA_ASSERT_VEC_SPACES
(func_name,space,*targ_vecs[k]->space());
74
}
75
76
77
template
<
class
Scalar>
78
void
Thyra::apply_op_validate_input
(
79
const
std::string &func_name,
80
const
VectorSpaceBase<Scalar>
&domain,
81
const
VectorSpaceBase<Scalar>
&range,
82
const
RTOpPack::RTOpT<Scalar>
&
/* primary_op */
,
83
const
ArrayView
<
const
Ptr
<
const
MultiVectorBase<Scalar>
> > &multi_vecs,
84
const
ArrayView
<
const
Ptr
<
MultiVectorBase<Scalar>
> > &targ_multi_vecs,
85
const
ArrayView
<
const
Ptr<RTOpPack::ReductTarget>
> &
/* reduct_objs */
,
86
const
Ordinal primary_global_offset_in
87
)
88
{
89
using
Teuchos::as
;
90
// Validate primary range arguments
91
TEUCHOS_TEST_FOR_EXCEPTION
(
92
primary_global_offset_in < 0, std::logic_error
93
,func_name <<
" : Error! primary_global_offset_in = "
94
<<primary_global_offset_in<<
" is not valid"
);
95
// Validate secondary domain arguments
96
// Validate spaces
97
for
(
int
k = 0; k < multi_vecs.size(); ++k) {
98
THYRA_ASSERT_VEC_SPACES
(func_name,domain,*multi_vecs[k]->domain());
99
THYRA_ASSERT_VEC_SPACES
(func_name,range,*multi_vecs[k]->range());
100
}
101
for
(
int
k = 0; k < targ_multi_vecs.size(); ++k) {
102
THYRA_ASSERT_VEC_SPACES
(func_name,domain,*targ_multi_vecs[k]->domain());
103
THYRA_ASSERT_VEC_SPACES
(func_name,range,*targ_multi_vecs[k]->range());
104
}
105
}
106
107
108
//
109
// Explicit instant macro
110
//
111
112
#define THYRA_APPLY_OP_HELPER_INSTANT(SCALAR) \
113
\
114
template void apply_op_validate_input( \
115
const std::string &func_name, \
116
const VectorSpaceBase<SCALAR > &space, \
117
const RTOpPack::RTOpT<SCALAR > &op, \
118
const ArrayView<const Ptr<const VectorBase<SCALAR > > > &vecs, \
119
const ArrayView<const Ptr<VectorBase<SCALAR > > > &targ_vecs, \
120
const Ptr<RTOpPack::ReductTarget> &reduct_obj, \
121
const Ordinal global_offset_in \
122
); \
123
\
124
template void apply_op_validate_input( \
125
const std::string &func_name, \
126
const VectorSpaceBase<SCALAR > &domain, \
127
const VectorSpaceBase<SCALAR > &range, \
128
const RTOpPack::RTOpT<SCALAR > &primary_op, \
129
const ArrayView<const Ptr<const MultiVectorBase<SCALAR > > > &multi_vecs, \
130
const ArrayView<const Ptr<MultiVectorBase<SCALAR > > > &targ_multi_vecs, \
131
const ArrayView<const Ptr<RTOpPack::ReductTarget> > &reduct_objs, \
132
const Ordinal primary_global_offset_in \
133
); \
134
135
136
137
#endif
// THYRA_APPLY_OP_HELPER_HPP
Teuchos_as.hpp
RTOpPack::RTOpT
Teuchos::ArrayView
Teuchos::Ptr
Thyra::MultiVectorBase
Interface for a collection of column vectors called a multi-vector.
Definition
Thyra_MultiVectorBase_decl.hpp:496
Thyra::VectorBase
Abstract interface for finite-dimensional dense vectors.
Definition
Thyra_VectorBase.hpp:147
Thyra::VectorSpaceBase
Abstract interface for objects that represent a space for vectors.
Definition
Thyra_VectorSpaceBase_decl.hpp:299
TEUCHOS_TEST_FOR_EXCEPTION
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
THYRA_ASSERT_VEC_SPACES
#define THYRA_ASSERT_VEC_SPACES(FUNC_NAME, VS1, VS2)
This is a very useful macro that should be used to validate that two vector spaces are compatible.
Definition
Thyra_AssertOp.hpp:188
Thyra::apply_op_validate_input
void apply_op_validate_input(const std::string &func_name, const VectorSpaceBase< Scalar > &space, const RTOpPack::RTOpT< Scalar > &op, const ArrayView< const Ptr< const VectorBase< Scalar > > > &vecs, const ArrayView< const Ptr< VectorBase< Scalar > > > &targ_vecs, const Ptr< RTOpPack::ReductTarget > &reduct_obj, const Ordinal global_offset)
Validate the inputs to VectorBase::applyOp().
Definition
Thyra_apply_op_helper_def.hpp:54
Teuchos::as
TypeTo as(const TypeFrom &t)
Generated by
1.17.0