Xyce  6.1
N_NLS_NOX_AugmentLinSys_OPStart.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 // Copyright Notice
3 //
4 // Copyright 2002 Sandia Corporation. Under the terms
5 // of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S.
6 // Government retains certain rights in this software.
7 //
8 // Xyce(TM) Parallel Electrical Simulator
9 // Copyright (C) 2002-2015 Sandia Corporation
10 //
11 // This program is free software: you can redistribute it and/or modify
12 // it under the terms of the GNU General Public License as published by
13 // the Free Software Foundation, either version 3 of the License, or
14 // (at your option) any later version.
15 //
16 // This program is distributed in the hope that it will be useful,
17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 // GNU General Public License for more details.
20 //
21 // You should have received a copy of the GNU General Public License
22 // along with this program. If not, see <http://www.gnu.org/licenses/>.
23 //-----------------------------------------------------------------------------
24 
25 //-------------------------------------------------------------------------
26 // Filename : $RCSfile: N_NLS_NOX_AugmentLinSys_OPStart.h,v $
27 //
28 // Purpose : Concrete class for augmenting the Jacobian for
29 // pseudo-transient solves.
30 //
31 // Special Notes :
32 //
33 // Creator : Dave Shirley, PSSI
34 //
35 // Creation Date : 05/08/06
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.22.2.1 $
41 //
42 // Revision Date : $Date: 2015/04/02 18:20:17 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-------------------------------------------------------------------------
46 
47 
48 #ifndef Xyce_N_NLS_NOX_AugmentLinSys_OPStart_h
49 #define Xyce_N_NLS_NOX_AugmentLinSys_OPStart_h
50 
51 #include <set>
52 
53 #include <N_UTL_fwd.h>
54 
56 #include "N_PDS_ParMap.h"
57 #include "N_PDS_ParComm.h"
58 
59 #include <N_IO_InitialConditions.h>
60 
61 class Epetra_MapColoring;
62 
63 //-----------------------------------------------------------------------------
64 // Class : N_NLS::NOX::AugmentLinSysOPStart
65 // Purpose :
66 // Creator : Roger Pawlowski, SNL, 9233
67 // Creation Date :
68 //-----------------------------------------------------------------------------
69 namespace Xyce {
70 namespace Nonlinear {
71 namespace N_NLS_NOX {
72 
74 
75 public:
76  AugmentLinSysOPStart(Xyce::IO::InitialConditionsData::NodeNamePairMap &, const Xyce::NodeNameMap &, N_PDS_Comm *);
77 
78  //! Dtor.
80 
81  void setProgressVariable(double dummy) {return;}
82 
83  void augmentResidual(const Xyce::Linear::Vector * solution, Xyce::Linear::Vector * residual_vector);
84 
85  void augmentJacobian(Xyce::Linear::Matrix * jacobian);
86 
87  private:
88 
89  //! map of specified variables
90  Xyce::IO::InitialConditionsData::NodeNamePairMap & op_;
91  const Xyce::NodeNameMap & allNodes_;
92 
93  bool skipSet;
94  std::set<int> skipLID;
95  std::set<int> skipGID;
96 
97  Xyce::Linear::Vector* residualPtr_;
98  const Xyce::Linear::Vector* solutionPtr_;
99  int rSize_;
100  N_PDS_ParMap * pmap_;
101  N_PDS_Comm * pdsCommPtr_;
102 };
103 
104 }}}
105 
106 #endif
107 
Pure virtual class to augment a linear system.
void augmentResidual(const Xyce::Linear::Vector *solution, Xyce::Linear::Vector *residual_vector)
Augments the Residual.
void augmentJacobian(Xyce::Linear::Matrix *jacobian)
Augments the Jacobian.
Xyce::IO::InitialConditionsData::NodeNamePairMap & op_
map of specified variables
AugmentLinSysOPStart(Xyce::IO::InitialConditionsData::NodeNamePairMap &, const Xyce::NodeNameMap &, N_PDS_Comm *)
void setProgressVariable(double dummy)
Set the progress variable (time step size for pseudo transient).