Xyce  6.1
N_ANP_RegisterAnalysis.C
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_ANP_RegisterAnalysis.C,v $
27 // Purpose : This file contains the functions which define the time
28 // domain & integration algorithm classes.
29 // Special Notes :
30 // Creator : Richard Schiek, SNL, Electrical and Microsystem Modeling
31 // Creation Date : 01/24/08
32 //
33 // Revision Information:
34 // ---------------------
35 // Revision Number: $Revision: 1.1 $
36 // Revision Date : $Date: 2015/05/21 16:43:49 $
37 // Current Owner : $Author: dgbaur $
38 //-----------------------------------------------------------------------------
39 
40 #include <Xyce_config.h>
41 
42 #include <N_ANP_RegisterAnalysis.h>
43 
44 #include <N_ANP_AC.h>
45 #include <N_ANP_DCSweep.h>
46 #include <N_ANP_HB.h>
47 #include <N_ANP_MOR.h>
48 #include <N_ANP_MPDE.h>
49 #include <N_ANP_NOISE.h>
50 #include <N_ANP_ROL.h>
51 #include <N_ANP_Step.h>
52 #include <N_ANP_Transient.h>
53 
54 namespace Xyce {
55 namespace Analysis {
56 
57 //-----------------------------------------------------------------------------
58 // Function : registerAnalysisFactory
59 // Purpose :
60 // Special Notes :
61 // Scope : public
62 // Creator : David G. Baur Raytheon Sandia National Laboratories 1355
63 // Creation Date : Mon Mar 16 14:26:41 2015
64 //-----------------------------------------------------------------------------
65 ///
66 /// Registers the analysis factories.
67 ///
68 /// In the future this is intended to become a pluggable factory allowing new analysis type to be added with no invasion
69 /// into the rest of the analysis code. Whether anyone will actually create an analysis outside the system is academic
70 /// and creating this interface will result in defining the roles and interactions between the various analyses.
71 ///
72 /// @invariant
73 ///
74 /// @param netlist_filename
75 /// @param options_manager
76 /// @param analysis_manager
77 /// @param linear_system
78 /// @param nonlinear_manager
79 /// @param device_manager
80 /// @param builder
81 /// @param topology
82 ///
83 ///
85  FactoryBlock & factory_block)
86 {
87  registerDCSweepFactory(factory_block);
88  registerACFactory(factory_block);
89  registerTransientFactory(factory_block);
90  registerHBFactory(factory_block);
91  registerMPDEFactory(factory_block);
92  registerNOISEFactory(factory_block);
93  registerMORFactory(factory_block);
94  registerStepFactory(factory_block);
95  registerROLFactory(factory_block);
96 }
97 
98 } // namespace Analysis
99 } // namespace Xyce
100 
bool registerACFactory(FactoryBlock &factory_block)
Definition: N_ANP_AC.C:1062
Pure virtual class to augment a linear system.
bool registerMORFactory(FactoryBlock &factory_block)
Definition: N_ANP_MOR.C:2292
bool registerTransientFactory(FactoryBlock &factory_block)
bool registerROLFactory(FactoryBlock &factory_block)
Definition: N_ANP_ROL.C:2151
void registerAnalysisFactory(FactoryBlock &factory_block)
Registers the analysis factories.
The FactoryBlock contains parameters needed by the analysis creation functions.
bool registerMPDEFactory(FactoryBlock &factory_block)
Definition: N_ANP_MPDE.C:612
bool registerStepFactory(FactoryBlock &factory_block)
Definition: N_ANP_Step.C:550
bool registerNOISEFactory(FactoryBlock &factory_block)
Definition: N_ANP_NOISE.C:1920
bool registerDCSweepFactory(FactoryBlock &factory_block)
bool registerHBFactory(FactoryBlock &factory_block)
Definition: N_ANP_HB.C:2340