Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_ParallelData.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stokhos Package
5// Copyright (2009) 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 Eric T. Phipps (etphipp@sandia.gov).
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef STOKHOS_PARALLEL_DATA_HPP
43#define STOKHOS_PARALLEL_DATA_HPP
44
45#include "Teuchos_RCP.hpp"
48#include "EpetraExt_MultiComm.h"
49#include "Teuchos_ParameterList.hpp"
51
52namespace Stokhos {
53
55 public:
56
59 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& basis,
60 const Teuchos::RCP<const Stokhos::Sparse3Tensor<int,double> >& Cijk,
61 const Teuchos::RCP<const Epetra_Comm>& globalComm,
62 Teuchos::ParameterList& params);
63
66 const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& basis,
67 const Teuchos::RCP<const Stokhos::Sparse3Tensor<int,double> >& Cijk,
68 const Teuchos::RCP<const EpetraExt::MultiComm>& globalMultiComm,
69 Teuchos::ParameterList& params);
70
73
75 Teuchos::RCP<const EpetraExt::MultiComm>
76 getMultiComm() const { return globalMultiComm; }
77
79 Teuchos::RCP<const Epetra_Comm>
80 getStochasticComm() const { return stoch_comm; }
81
83 Teuchos::RCP<const Epetra_Comm>
84 getSpatialComm() const { return spatial_comm; }
85
87 Teuchos::RCP<const Stokhos::EpetraSparse3Tensor>
88 getEpetraCijk() const { return epetraCijk; }
89
90 protected:
91
93 Teuchos::RCP<const EpetraExt::MultiComm> globalMultiComm;
94
96 Teuchos::RCP<const Epetra_Comm> stoch_comm;
97
99 Teuchos::RCP<const Epetra_Comm> spatial_comm;
100
102 Teuchos::RCP<Stokhos::EpetraSparse3Tensor> epetraCijk;
103
104 }; // class ParallelData
105
106 Teuchos::RCP<const EpetraExt::MultiComm>
107 buildMultiComm(const Epetra_Comm& globalComm,
108 int num_global_stochastic_blocks,
109 int num_spatial_procs = -1);
110
111 Teuchos::RCP<const Epetra_Comm>
113 const Teuchos::RCP<const EpetraExt::MultiComm>& globalMultiComm);
114
115 Teuchos::RCP<const Epetra_Comm>
117 const Teuchos::RCP<const EpetraExt::MultiComm>& globalMultiComm);
118
119
120} // namespace Stokhos
121
122#endif // STOKHOS_PARALLEL_DATA_HPP
Abstract base class for multivariate orthogonal polynomials.
Teuchos::RCP< const Epetra_Comm > getStochasticComm() const
Get stochastic comm.
Teuchos::RCP< const Stokhos::EpetraSparse3Tensor > getEpetraCijk() const
Get Epetra Cijk.
Teuchos::RCP< Stokhos::EpetraSparse3Tensor > epetraCijk
Epetra Cijk.
Teuchos::RCP< const Epetra_Comm > getSpatialComm() const
Get spatial comm.
Teuchos::RCP< const Epetra_Comm > stoch_comm
Stochastic comm.
Teuchos::RCP< const EpetraExt::MultiComm > globalMultiComm
Multi-comm.
Teuchos::RCP< const EpetraExt::MultiComm > getMultiComm() const
Get global comm.
Teuchos::RCP< const Epetra_Comm > spatial_comm
Spatial comm.
Data structure storing a sparse 3-tensor C(i,j,k) in a a compressed format.
Top-level namespace for Stokhos classes and functions.
Teuchos::RCP< const Epetra_Comm > getStochasticComm(const Teuchos::RCP< const EpetraExt::MultiComm > &globalMultiComm)
Teuchos::RCP< const Epetra_Comm > getSpatialComm(const Teuchos::RCP< const EpetraExt::MultiComm > &globalMultiComm)
Teuchos::RCP< const EpetraExt::MultiComm > buildMultiComm(const Epetra_Comm &globalComm, int num_global_stochastic_blocks, int num_spatial_procs=-1)