Xyce  6.1
N_NLS_NOX_AugmentLinSys_IC.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_IC.h,v $
27 //
28 // Purpose : Concrete class for augmenting the Jacobian for
29 // .IC simulations (initial condition)
30 //
31 // Special Notes :
32 //
33 // Creator : Eric R. Keiter
34 //
35 // Creation Date : 09/15/07
36 //
37 // Revision Information:
38 // ---------------------
39 //
40 // Revision Number: $Revision: 1.15 $
41 //
42 // Revision Date : $Date: 2015/04/08 19:18:29 $
43 //
44 // Current Owner : $Author: tvrusso $
45 //-------------------------------------------------------------------------
46 
47 #ifndef Xyce_N_NLS_NOX_AugmentLinSys_IC_h
48 #define Xyce_N_NLS_NOX_AugmentLinSys_IC_h
49 
50 #include "Teuchos_RCP.hpp"
52 #include "N_PDS_ParMap.h"
53 
54 #include <N_UTL_fwd.h>
55 #include <N_IO_InitialConditions.h>
56 
57 #include <set>
58 
59 class Epetra_MapColoring;
60 
61 //-----------------------------------------------------------------------------
62 // Class : N_NLS::NOX::AugmentLinSysIC
63 // Purpose : Handles matrix augmentation to support .IC statements.
64 // Creator : Eric R. Keiter, SNL, Electrical and Microsystems modeling.
65 // Creation Date : 09/15/2007
66 //-----------------------------------------------------------------------------
67 namespace Xyce {
68 namespace Nonlinear {
69 namespace N_NLS_NOX {
70 
72 
73 public:
74  //! Ctor.
75  AugmentLinSysIC(Xyce::IO::InitialConditionsData::NodeNamePairMap & op_in,
76  const Teuchos::RCP <Epetra_MapColoring>& color_map,
77  Xyce::Linear::Vector* cloneVector);
78 
79  //! Dtor.
81 
82  void setProgressVariable(double dummy) {return;}
83 
84  void augmentResidual(const Xyce::Linear::Vector * solution,
85  Xyce::Linear::Vector * residual_vector);
86 
87  void augmentJacobian(Xyce::Linear::Matrix * jacobian);
88 
89  private:
90 
91  //! map of specified variables
92  Xyce::IO::InitialConditionsData::NodeNamePairMap & op_;
93 
94  //! Color 0 are the voltage unknowns.
95  Teuchos::RCP<Epetra_MapColoring> color_map_;
96 
97  //! Temporary vector used to store diagonal.
98  Xyce::Linear::Vector* tmp_vector_ptr_;
99 
100 };
101 
102 }}}
103 
104 #endif
105 
void augmentResidual(const Xyce::Linear::Vector *solution, Xyce::Linear::Vector *residual_vector)
Augments the Residual.
Xyce::IO::InitialConditionsData::NodeNamePairMap & op_
map of specified variables
Pure virtual class to augment a linear system.
AugmentLinSysIC(Xyce::IO::InitialConditionsData::NodeNamePairMap &op_in, const Teuchos::RCP< Epetra_MapColoring > &color_map, Xyce::Linear::Vector *cloneVector)
Ctor.
Xyce::Linear::Vector * tmp_vector_ptr_
Temporary vector used to store diagonal.
Teuchos::RCP< Epetra_MapColoring > color_map_
Color 0 are the voltage unknowns.
void setProgressVariable(double dummy)
Set the progress variable (time step size for pseudo transient).
void augmentJacobian(Xyce::Linear::Matrix *jacobian)
Augments the Jacobian.